RDK Documentation (Open Sourced RDK Components)
AdResolvedEvent Class Reference

Class for ad fulfill status event. More...

#include <AampEvent.h>

Inheritance diagram for AdResolvedEvent:
Inheritance graph
Collaboration diagram for AdResolvedEvent:
Collaboration graph

Public Member Functions

 AdResolvedEvent ()=delete
 
 AdResolvedEvent (const AdResolvedEvent &)=delete
 
AdResolvedEventoperator= (const AdResolvedEvent &)=delete
 
 AdResolvedEvent (bool resolveStatus, const std::string &adId, uint64_t startMS, uint64_t durationMs)
 AdResolvedEvent Constructor.
 
virtual ~AdResolvedEvent ()
 AdResolvedEvent Destructor.
 
bool getResolveStatus () const
 Get Resolve Status. More...
 
const std::string & getAdId () const
 Get Ad Identifier. More...
 
uint64_t getStart () const
 Get Start Positon. More...
 
uint64_t getDuration () const
 Get Duration. 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

bool mResolveStatus
 
std::string mAdId
 
uint64_t mStartMS
 
uint64_t mDurationMs
 

yes

Class for ad fulfill status event.

Definition at line 1616 of file AampEvent.h.

Constructor & Destructor Documentation

◆ AdResolvedEvent()

AdResolvedEvent::AdResolvedEvent ( )
delete
Parameters
[in]resolveStatus- Ad resolve status
[in]adId- Identifier of the Ad
[in]startMS- Start position of Ad (relative to reservation start)
[in]durationMs- Duration of the Ad in MS

Member Function Documentation

◆ getResolveStatus()

AdResolvedEvent::getResolveStatus ( ) const

Get Resolve Status.

Returns
Ad resolve status

Definition at line 1093 of file AampEvent.cpp.

◆ getAdId()

AdResolvedEvent::getAdId ( ) const

Get Ad Identifier.

Returns
Ad's identifier

Definition at line 1103 of file AampEvent.cpp.

◆ getStart()

AdResolvedEvent::getStart ( ) const

Get Start Positon.

Returns
Start position (in MS), relative to Adbreak

Definition at line 1113 of file AampEvent.cpp.

◆ getDuration()

AdResolvedEvent::getDuration ( ) const

Get Duration.

Returns
Ad's duration in MS

Definition at line 1123 of file AampEvent.cpp.

Field Documentation

◆ mResolveStatus

bool AdResolvedEvent::mResolveStatus
private

Ad resolve status

Definition at line 1618 of file AampEvent.h.

◆ mAdId

std::string AdResolvedEvent::mAdId
private

Ad identifier

Definition at line 1619 of file AampEvent.h.

◆ mStartMS

uint64_t AdResolvedEvent::mStartMS
private

Ad's start position in MS

Definition at line 1620 of file AampEvent.h.

◆ mDurationMs

uint64_t AdResolvedEvent::mDurationMs
private

Ad's duration in MS

Definition at line 1621 of file AampEvent.h.


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