RDK Documentation (Open Sourced RDK Components)
AdReservationEvent Class Reference

Class for ad reservation events. More...

#include <AampEvent.h>

Inheritance diagram for AdReservationEvent:
Inheritance graph
Collaboration diagram for AdReservationEvent:
Collaboration graph

Public Member Functions

 AdReservationEvent ()=delete
 
 AdReservationEvent (const AdReservationEvent &)=delete
 
AdReservationEventoperator= (const AdReservationEvent &)=delete
 
 AdReservationEvent (AAMPEventType evtType, const std::string &breakId, uint64_t position)
 AdReservationEvent Constructor.
 
virtual ~AdReservationEvent ()
 AdReservationEvent Destructor.
 
const std::string & getAdBreakId () const
 Get Adbreak Identifier. More...
 
uint64_t getPosition () const
 Get Ad's Position. More...
 
- Public Member Functions inherited from AAMPEventObject
 AAMPEventObject (const AAMPEventObject &)=delete
 Copy constructor disabled. More...
 
AAMPEventObjectoperator= (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 mAdBreakId
 
uint64_t mPosition
 

yes

Class for ad reservation events.

Definition at line 1669 of file AampEvent.h.

Constructor & Destructor Documentation

◆ AdReservationEvent()

AdReservationEvent::AdReservationEvent ( )
delete
Parameters
[in]evtType- Event Type
[in]breakId- Unique identifier of Ad reservation.
[in]position- Postion of reservation in content's PTS

Member Function Documentation

◆ getAdBreakId()

AdReservationEvent::getAdBreakId ( ) const

Get Adbreak Identifier.

Returns
Adbreak's id

Definition at line 1142 of file AampEvent.cpp.

◆ getPosition()

AdReservationEvent::getPosition ( ) const

Get Ad's Position.

Returns
Ad's position (in channel's PTS)

Definition at line 1152 of file AampEvent.cpp.

Field Documentation

◆ mAdBreakId

std::string AdReservationEvent::mAdBreakId
private

Adbreak's id

Definition at line 1671 of file AampEvent.h.

◆ mPosition

uint64_t AdReservationEvent::mPosition
private

Adbreak's start position

Definition at line 1672 of file AampEvent.h.


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