AdPlacementEvent Class Reference

Class for ad placement events. More...

#include <AampEvent.h>

Inheritance diagram for AdPlacementEvent:

Collaboration diagram for AdPlacementEvent:

Public Member Functions
	AdPlacementEvent ()=delete
	AdPlacementEvent (const AdPlacementEvent &)=delete
AdPlacementEvent &	operator= (const AdPlacementEvent &)=delete
	AdPlacementEvent (AAMPEventType evtType, const std::string &adId, uint32_t position, uint32_t offset=0, uint32_t duration=0, int errorCode=0)
	AdPlacementEvent Constructor.
virtual	~AdPlacementEvent ()
	AdPlacementEvent Destructor.
const std::string &	getAdId () const
	Get Ad's Identifier. More...
uint32_t	getPosition () const
	Get Ad's Position. More...
uint32_t	getOffset () const
	Get Ad's Offset. More...
uint32_t	getDuration () const
	Get Ad's Duration. More...
int	getErrorCode () const
	Get Error Code. More...
Public Member Functions inherited from AAMPEventObject
	AAMPEventObject (const AAMPEventObject &)=delete
	Copy constructor disabled. More...
AAMPEventObject &	operator= (const AAMPEventObject &)=delete
	assignment operator disabled More...
	AAMPEventObject (AAMPEventType type)
	AAMPEventObject Constructor.
virtual	~AAMPEventObject ()
	AAMPEvent Destructor.
AAMPEventType	getType () const
	Get Event Type. More...

Private Attributes
std::string	mAdId
uint32_t	mPosition
uint32_t	mOffset
uint32_t	mDuration
int	mErrorCode

yes

Class for ad placement events.

Definition at line 1708 of file AampEvent.h.

Constructor & Destructor Documentation

AdPlacementEvent()

AdPlacementEvent::AdPlacementEvent ( )

delete

Parameters

[in]	evtType	- Event type
[in]	adId	- Ad Id
[in]	position	- Ad's position (in channel's PTS)
[in]	offset	- Ad's start offset
[in]	duration	- Ad's duration in MS
[in]	errorCode	- Error code, in case of placement error

Member Function Documentation

getAdId()

const std::string & AdPlacementEvent::getAdId

(

)

const

Get Ad's Identifier.

Returns

Ad's id

Definition at line 1172 of file AampEvent.cpp.

getPosition()

uint32_t AdPlacementEvent::getPosition

(

)

const

Get Ad's Position.

Returns

Ad's position (in channel's PTS)

Definition at line 1182 of file AampEvent.cpp.

getOffset()

uint32_t AdPlacementEvent::getOffset

(

)

const

Get Ad's Offset.

Returns

Ad's start offset

Definition at line 1192 of file AampEvent.cpp.

getDuration()

uint32_t AdPlacementEvent::getDuration

(

)

const

Get Ad's Duration.

Returns

Ad's duration in MS

Definition at line 1202 of file AampEvent.cpp.

getErrorCode()

AdPlacementEvent::getErrorCode

(

)

const

Get Error Code.

Returns

Error code

Definition at line 1212 of file AampEvent.cpp.

Field Documentation

mAdId

std::string AdPlacementEvent::mAdId

private

Ad Id

Definition at line 1710 of file AampEvent.h.

mPosition

uint32_t AdPlacementEvent::mPosition

private

Ad Position relative to Reservation Start

Definition at line 1711 of file AampEvent.h.

mOffset

uint32_t AdPlacementEvent::mOffset

private

Ad start offset

Definition at line 1712 of file AampEvent.h.

mDuration

uint32_t AdPlacementEvent::mDuration

private

Ad's duration

Definition at line 1713 of file AampEvent.h.

mErrorCode

int AdPlacementEvent::mErrorCode

private

Error code, if any

Definition at line 1714 of file AampEvent.h.

---

The documentation for this class was generated from the following files:

• components/generic/aamp/AampEvent.h
• components/generic/aamp/AampEvent.cpp
• components/generic/aamp/test/utests/fakes/FakeAampEvent.cpp