RDK Documentation (Open Sourced RDK Components)
AAMPEvent Struct Reference

Structure of the AAMP events. Recommend new AAMP integration layers to use AAMPEventObject based listener For new event definition, should use AAMPEventObject class TODO: Deperecate in future, kept for backward compatibility only. More...

#include <AampEvent.h>

Collaboration diagram for AAMPEvent:
Collaboration graph

Public Member Functions

 AAMPEvent ()
 AAMPEvent Constructor.
 
 AAMPEvent (AAMPEventType t)
 AAMPEvent Constructor. More...
 
 AAMPEvent (const AAMPEvent &)=delete
 Copy constructor disabled. More...
 
AAMPEventoperator= (const AAMPEvent &)=delete
 assignment operator disabled More...
 

Data Fields

AAMPEventType type
 
union {
   struct {
int severity
 
const char * msg
 
   } anomalyReport
 
   struct {
const char * microData
 
   } tuneProfile
 
   struct {
MetricsDataType type
 
const char * metricUUID
 
const char * data
 
   } metricsData
 
   struct {
double durationMiliseconds
 
double positionMiliseconds
 
float playbackSpeed
 
double startMiliseconds
 
double endMiliseconds
 
long long videoPTS
 
double videoBufferedMiliseconds
 
const char * timecode
 
   } progress
 Structure of the progress event data.
 
   struct {
double positionMiliseconds
 
   } seeked
 Structure of the seeked event data.
 
   struct {
float rate
 
   } speedChanged
 Structure of the speed change event.
 
   struct {
int time
 
long bitrate
 
const char * description
 
int width
 
int height
 
double framerate
 
double position
 
bool cappedProfile
 
int displayWidth
 
int displayHeight
 
VideoScanType videoScanType
 
int aspectRatioWidth
 
int aspectRatioHeight
 
   } bitrateChanged
 Structure of the bitrate change event.
 
   struct {
long durationMiliseconds
 
int languageCount
 
char languages [16][42]
 
int bitrateCount
 
long bitrates [10]
 
int width
 
int height
 
bool hasDrm
 
int supportedSpeedCount
 
float supportedSpeeds [12]
 
double programStartTime
 
   } metadata
 Structure of the metadata event.
 
   struct {
unsigned long handle
 
   } ccHandle
 Structure of the closed caption handle event.
 
   struct {
const char * szName
 
const char * id
 
long long timeMilliseconds
 
double durationMilliSeconds
 
const char * szContent
 
   } timedMetadata
 Structure of the timed metadata event.
 
   struct {
const char * szMetaContent
 
   } bulktimedMetadata
 Structure of the bulk timed metadata event.
 
   struct {
const char * szEventType
 
void * jsObject
 
   } jsEvent
 Structure of the Java Script event.
 
   struct {
AAMPTuneFailure failure
 
int code
 
const char * description
 
bool shouldRetry
 
int32_t classCode
 
int32_t reasonCode
 
int32_t businessStatus
 
   } mediaError
 Structure of the media error event.
 
   struct {
AAMPTuneFailure failure
 
const char * accessStatus
 
int accessStatus_value
 
long responseCode
 
bool isSecClientError
 
   } dash_drmmetadata
 
   struct {
PrivAAMPState state
 
   } stateChanged
 Structure of the player state changed event.
 
   struct {
bool buffering
 
   } bufferingChanged
 Structure of the buffering changed event.
 
   struct {
int supportedSpeedCount
 
float supportedSpeeds [12]
 
   } speedsChanged
 Structure of the supported speeds changed event.
 
   struct {
VTTCuecueData
 
   } cue
 Structure of the WebVTT cue data.
 
   struct {
bool resolveStatus
 
const char * adId
 
uint64_t startMS
 
uint64_t durationMs
 
   } adResolved
 Structure for ad fulfill status event.
 
   struct {
const char * adBreakId
 
uint64_t position
 
   } adReservation
 Structure for ad reservation events.
 
   struct {
const char * adId
 
uint32_t position
 
uint32_t offset
 
uint32_t duration
 
int errorCode
 
   } adPlacement
 Structure for ad placement events.
 
   struct {
uint8_t * data
 
int32_t length
 
   } id3Metadata
 Structure of the id3 metadata event.
 
   struct {
const char * data
 
   } drmMessage
 
   struct {
long long timeMilliseconds
 
double durationMilliSeconds
 
   } contentGap
 
   struct {
const char * header
 
const char * response
 
   } httpResponseHeader
 Structure of the http response header event.
 
   struct {
uint8_t * keyID
 
const char * streamType
 
   } contentProtectionData
 Structure of the content protection data update event.
 
data
 

yes

Structure of the AAMP events. Recommend new AAMP integration layers to use AAMPEventObject based listener For new event definition, should use AAMPEventObject class TODO: Deperecate in future, kept for backward compatibility only.

Definition at line 204 of file AampEvent.h.

Constructor & Destructor Documentation

◆ AAMPEvent() [1/2]

AAMPEvent::AAMPEvent ( AAMPEventType  t)
inline

AAMPEvent Constructor.

Parameters
[in]tEvent type

Definition at line 475 of file AampEvent.h.

◆ AAMPEvent() [2/2]

AAMPEvent::AAMPEvent ( const AAMPEvent )
delete

Copy constructor disabled.

Member Function Documentation

◆ operator=()

AAMPEvent& AAMPEvent::operator= ( const AAMPEvent )
delete

assignment operator disabled

Field Documentation

◆ type

AAMPEventType AAMPEvent::type

Event type

Definition at line 206 of file AampEvent.h.


The documentation for this struct was generated from the following file: