![]() |
RDK Documentation (Open Sourced RDK Components)
|
Events supported by the AAMP player. More...


Go to the source code of this file.
Data Structures | |
| struct | AAMPEvent |
| 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... | |
| class | AAMPEventObject |
| Base class of all AAMP events. New AAMP event object for ease of use While defining new event objects inherit from this base class. More... | |
| class | MediaErrorEvent |
| Class for the Media Error event. More... | |
| class | SpeedChangedEvent |
| Class for the Speed changed event. More... | |
| class | ProgressEvent |
| Class for the Progress event. More... | |
| class | CCHandleEvent |
| Class for the Closed Caption Handle event. More... | |
| class | MediaMetadataEvent |
| Class for the Media Metadata event. More... | |
| class | BitrateChangeEvent |
| Class for the Bitrate change event. More... | |
| class | TimedMetadataEvent |
| Class for the Timed Metadata event. More... | |
| class | BulkTimedMetadataEvent |
| Class for the Bulk TimedMetadata Event. More... | |
| class | StateChangedEvent |
| Class for the Player State Changed event. More... | |
| class | SupportedSpeedsChangedEvent |
| Class for the supported speeds changed event. More... | |
| class | SeekedEvent |
| Class for the Seeked Event. More... | |
| class | TuneProfilingEvent |
| Class for the Tune Profilng Event. More... | |
| class | BufferingChangedEvent |
| Class for the Buffering Changed event. More... | |
| class | DrmMetaDataEvent |
| Class for the Drm Metadata event. More... | |
| class | AnomalyReportEvent |
| Class for the Anomaly Report Event. More... | |
| class | WebVttCueEvent |
| Class for the Web VTT Cue Event. More... | |
| class | AdResolvedEvent |
| Class for ad fulfill status event. More... | |
| class | AdReservationEvent |
| Class for ad reservation events. More... | |
| class | AdPlacementEvent |
| Class for ad placement events. More... | |
| class | MetricsDataEvent |
| Class for the Metrics Data event. More... | |
| class | ID3MetadataEvent |
| Class for the ID3 Metadata Event. More... | |
| class | DrmMessageEvent |
| Class for the DRM Message Event. More... | |
| class | BlockedEvent |
| Class for the BlockedEvent event. More... | |
| class | ContentGapEvent |
| Class for the Content gap event. More... | |
| class | HTTPResponseHeaderEvent |
| Class for the HTTP Response Header event. More... | |
| class | WatermarkSessionUpdateEvent |
| Class for the watermarkSession event. More... | |
| class | ContentProtectionDataEvent |
| Class for the Content Protection Data Update Event on Dynamic Key Rotation. More... | |
| union | AAMPEvent.data |
| struct | AAMPEvent.data.anomalyReport |
| struct | AAMPEvent.data.tuneProfile |
| struct | AAMPEvent.data.metricsData |
| struct | AAMPEvent.data.progress |
| Structure of the progress event data. More... | |
| struct | AAMPEvent.data.seeked |
| Structure of the seeked event data. More... | |
| struct | AAMPEvent.data.speedChanged |
| Structure of the speed change event. More... | |
| struct | AAMPEvent.data.bitrateChanged |
| Structure of the bitrate change event. More... | |
| struct | AAMPEvent.data.metadata |
| Structure of the metadata event. More... | |
| struct | AAMPEvent.data.ccHandle |
| Structure of the closed caption handle event. More... | |
| struct | AAMPEvent.data.timedMetadata |
| Structure of the timed metadata event. More... | |
| struct | AAMPEvent.data.bulktimedMetadata |
| Structure of the bulk timed metadata event. More... | |
| struct | AAMPEvent.data.jsEvent |
| Structure of the Java Script event. More... | |
| struct | AAMPEvent.data.mediaError |
| Structure of the media error event. More... | |
| struct | AAMPEvent.data.dash_drmmetadata |
| struct | AAMPEvent.data.stateChanged |
| Structure of the player state changed event. More... | |
| struct | AAMPEvent.data.bufferingChanged |
| Structure of the buffering changed event. More... | |
| struct | AAMPEvent.data.speedsChanged |
| Structure of the supported speeds changed event. More... | |
| struct | AAMPEvent.data.cue |
| Structure of the WebVTT cue data. More... | |
| struct | AAMPEvent.data.adResolved |
| Structure for ad fulfill status event. More... | |
| struct | AAMPEvent.data.adReservation |
| Structure for ad reservation events. More... | |
| struct | AAMPEvent.data.adPlacement |
| Structure for ad placement events. More... | |
| struct | AAMPEvent.data.id3Metadata |
| Structure of the id3 metadata event. More... | |
| struct | AAMPEvent.data.contentGap |
| struct | AAMPEvent.data.httpResponseHeader |
| Structure of the http response header event. More... | |
| struct | AAMPEvent.data.contentProtectionData |
| Structure of the content protection data update event. More... | |
Macros | |
| #define | MAX_LANGUAGE_COUNT 16 |
| #define | MAX_LANGUAGE_TAG_LENGTH 42 |
| #define | MAX_BITRATE_COUNT 10 |
| #define | MAX_SUPPORTED_SPEED_COUNT 12 /* [-64, -32, -16, -4, -1, 0, 0.5, 1, 4, 16, 32, 64] */ |
Typedefs | |
| typedef enum E_MetricsDataType | MetricsDataType |
| using | AAMPEventPtr = std::shared_ptr< AAMPEventObject > |
| using | MediaErrorEventPtr = std::shared_ptr< MediaErrorEvent > |
| using | SpeedChangedEventPtr = std::shared_ptr< SpeedChangedEvent > |
| using | ProgressEventPtr = std::shared_ptr< ProgressEvent > |
| using | CCHandleEventPtr = std::shared_ptr< CCHandleEvent > |
| using | MediaMetadataEventPtr = std::shared_ptr< MediaMetadataEvent > |
| using | BitrateChangeEventPtr = std::shared_ptr< BitrateChangeEvent > |
| using | TimedMetadataEventPtr = std::shared_ptr< TimedMetadataEvent > |
| using | BulkTimedMetadataEventPtr = std::shared_ptr< BulkTimedMetadataEvent > |
| using | StateChangedEventPtr = std::shared_ptr< StateChangedEvent > |
| using | SupportedSpeedsChangedEventPtr = std::shared_ptr< SupportedSpeedsChangedEvent > |
| using | SeekedEventPtr = std::shared_ptr< SeekedEvent > |
| using | TuneProfilingEventPtr = std::shared_ptr< TuneProfilingEvent > |
| using | BufferingChangedEventPtr = std::shared_ptr< BufferingChangedEvent > |
| using | DrmMetaDataEventPtr = std::shared_ptr< DrmMetaDataEvent > |
| using | AnomalyReportEventPtr = std::shared_ptr< AnomalyReportEvent > |
| using | WebVttCueEventPtr = std::shared_ptr< WebVttCueEvent > |
| using | AdResolvedEventPtr = std::shared_ptr< AdResolvedEvent > |
| using | AdReservationEventPtr = std::shared_ptr< AdReservationEvent > |
| using | AdPlacementEventPtr = std::shared_ptr< AdPlacementEvent > |
| using | MetricsDataEventPtr = std::shared_ptr< MetricsDataEvent > |
| using | ID3MetadataEventPtr = std::shared_ptr< ID3MetadataEvent > |
| using | DrmMessageEventPtr = std::shared_ptr< DrmMessageEvent > |
| using | BlockedEventPtr = std::shared_ptr< BlockedEvent > |
| using | ContentGapEventPtr = std::shared_ptr< ContentGapEvent > |
| using | HTTPResponseHeaderEventPtr = std::shared_ptr< HTTPResponseHeaderEvent > |
| using | WatermarkSessionUpdateEventPtr = std::shared_ptr< WatermarkSessionUpdateEvent > |
| using | ContentProtectionDataEventPtr = std::shared_ptr< ContentProtectionDataEvent > |
Enumerations | |
| enum | AAMPEventType |
| Type of the events sending to the JSPP player. More... | |
| enum | AAMPEventMode |
| AAMP event modes. More... | |
| enum | AAMPTuneFailure |
| AAMP playback error codes. More... | |
| enum | PrivAAMPState |
| Mapping all required status codes based on JS player requirement. These requirements may be forced by psdk player.AAMP may not use all the statuses mentioned below: Mainly required states - idle, initializing, initialized, preparing, prepared, playing, paused, seek, complete and error. More... | |
| enum | E_MetricsDataType |
| enum | VideoScanType |
| VideoScanType - Progressive/Interlaced. More... | |
Events supported by the AAMP player.
Definition in file AampEvent.h.
| union AAMPEvent.data |
Definition at line 208 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| data | anomalyReport | |
| data | tuneProfile | |
| data | metricsData | |
| data | progress | Structure of the progress event data. |
| data | seeked | Structure of the seeked event data. |
| data | speedChanged | Structure of the speed change event. |
| data | bitrateChanged | Structure of the bitrate change event. |
| data | metadata | Structure of the metadata event. |
| data | ccHandle | Structure of the closed caption handle event. |
| data | timedMetadata | Structure of the timed metadata event. |
| data | bulktimedMetadata | Structure of the bulk timed metadata event. |
| data | jsEvent | Structure of the Java Script event. |
| data | mediaError | Structure of the media error event. |
| data | dash_drmmetadata | |
| data | stateChanged | Structure of the player state changed event. |
| data | bufferingChanged | Structure of the buffering changed event. |
| data | speedsChanged | Structure of the supported speeds changed event. |
| data | cue | Structure of the WebVTT cue data. |
| data | adResolved | Structure for ad fulfill status event. |
| data | adReservation | Structure for ad reservation events. |
| data | adPlacement | Structure for ad placement events. |
| data | id3Metadata | Structure of the id3 metadata event. |
| data | drmMessage | |
| data | contentGap | |
| data | httpResponseHeader | Structure of the http response header event. |
| data | contentProtectionData | Structure of the content protection data update event. |
| struct AAMPEvent.data.anomalyReport |
Definition at line 210 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| int | severity |
informative number indicates severity of msg, e.g Warning, Error, Trace etc |
| const char * | msg | |
| struct AAMPEvent.data.tuneProfile |
Definition at line 216 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | microData |
micro event data for profiling |
| struct AAMPEvent.data.metricsData |
Definition at line 221 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| MetricsDataType | type |
type of data , e.g AAMP_DATA_VIDEO_END for VideoEndEvent data |
| const char * | metricUUID |
unique session id passed during tune |
| const char * | data |
data for event |
| struct AAMPEvent.data.progress |
Structure of the progress event data.
Definition at line 231 of file AampEvent.h.

| struct AAMPEvent.data.seeked |
Structure of the seeked event data.
Definition at line 246 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| double | positionMiliseconds |
new seeked position in milliseconds |
| struct AAMPEvent.data.speedChanged |
Structure of the speed change event.
Definition at line 254 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| float | rate |
Playback rate |
| struct AAMPEvent.data.bitrateChanged |
Structure of the bitrate change event.
Definition at line 262 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| int | time |
Playback time |
| long | bitrate |
Playback bitrate |
| const char * | description |
Description |
| int | width |
Video width |
| int | height |
Video height |
| double | framerate |
FrameRate |
| double | position |
bitrate changed position |
| bool | cappedProfile |
profile capped status |
| int | displayWidth |
output display width |
| int | displayHeight |
output display height |
| VideoScanType | videoScanType |
video scan type |
| int | aspectRatioWidth |
aspect ratio width |
| int | aspectRatioHeight |
aspect ratio height |
| struct AAMPEvent.data.metadata |
Structure of the metadata event.
Definition at line 282 of file AampEvent.h.

| struct AAMPEvent.data.ccHandle |
Structure of the closed caption handle event.
Definition at line 300 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| unsigned long | handle |
Closed caption handle |
| struct AAMPEvent.data.timedMetadata |
Structure of the timed metadata event.
Definition at line 308 of file AampEvent.h.

| struct AAMPEvent.data.bulktimedMetadata |
Structure of the bulk timed metadata event.
Definition at line 320 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | szMetaContent |
Metadata content |
| struct AAMPEvent.data.jsEvent |
Structure of the Java Script event.
Definition at line 328 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | szEventType |
Event Type |
| void * | jsObject |
Pointer to the Java Scipt Object |
| struct AAMPEvent.data.mediaError |
Structure of the media error event.
Definition at line 337 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| AAMPTuneFailure | failure |
Error Type |
| int | code |
Error code |
| const char * | description |
Error description |
| bool | shouldRetry |
If recovery on retry is possible |
| int32_t | classCode |
class Code |
| int32_t | reasonCode |
reason Code |
| int32_t | businessStatus |
business Status |
| struct AAMPEvent.data.dash_drmmetadata |
Definition at line 349 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| AAMPTuneFailure | failure |
Error Type |
| const char * | accessStatus | |
| int | accessStatus_value | |
| long | responseCode | |
| bool | isSecClientError | |
| struct AAMPEvent.data.stateChanged |
Structure of the player state changed event.
Definition at line 361 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| PrivAAMPState | state |
Player state |
| struct AAMPEvent.data.bufferingChanged |
Structure of the buffering changed event.
Definition at line 369 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| bool | buffering |
true if buffering started, false otherwise |
| struct AAMPEvent.data.speedsChanged |
Structure of the supported speeds changed event.
Definition at line 377 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| int | supportedSpeedCount |
Supported playback speed count |
| float | supportedSpeeds[12] |
Supported playback speeds |
| struct AAMPEvent.data.cue |
Structure of the WebVTT cue data.
Definition at line 386 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| VTTCue * | cueData | |
| struct AAMPEvent.data.adResolved |
Structure for ad fulfill status event.
Definition at line 394 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| bool | resolveStatus | |
| const char * | adId | |
| uint64_t | startMS | |
| uint64_t | durationMs | |
| struct AAMPEvent.data.adReservation |
Structure for ad reservation events.
Definition at line 405 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | adBreakId |
Reservation Id |
| uint64_t | position | |
| struct AAMPEvent.data.adPlacement |
Structure for ad placement events.
Definition at line 414 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | adId |
Placement Id |
| uint32_t | position |
Ad Position relative to Reservation Start |
| uint32_t | offset |
Ad start offset |
| uint32_t | duration | |
| int | errorCode | |
| struct AAMPEvent.data.id3Metadata |
Structure of the id3 metadata event.
Definition at line 425 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| uint8_t * | data |
Data pointer to ID3 metadata blob |
| int32_t | length |
Length of the ID3 metadata blob |
| struct AAMPEvent.data.drmMessage |
Definition at line 431 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | data | |
| struct AAMPEvent.data.contentGap |
Definition at line 436 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| long long | timeMilliseconds |
Playback position - relative to tune time - starts at zero |
| double | durationMilliSeconds |
Duration of the gap |
| struct AAMPEvent.data.httpResponseHeader |
Structure of the http response header event.
Definition at line 445 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| const char * | header |
HTTP header name |
| const char * | response |
HTTP response value |
| struct AAMPEvent.data.contentProtectionData |
Structure of the content protection data update event.
Definition at line 454 of file AampEvent.h.

| Data Fields | ||
|---|---|---|
| uint8_t * | keyID |
Session KeyID |
| const char * | streamType |
Session StreamType |
| enum AAMPEventType |
Type of the events sending to the JSPP player.
| Enumerator | |
|---|---|
| AAMP_EVENT_ALL_EVENTS | 0, All Events |
| AAMP_EVENT_TUNED | 1, Tune success |
| AAMP_EVENT_TUNE_FAILED | 2, Tune failure |
| AAMP_EVENT_SPEED_CHANGED | 3, Speed changed internally |
| AAMP_EVENT_EOS | 4, End of stream |
| AAMP_EVENT_PLAYLIST_INDEXED | 5, Playlist downloaded and indexed |
| AAMP_EVENT_PROGRESS | 6, Progress event with playback stats. Report interval configurable |
| AAMP_EVENT_CC_HANDLE_RECEIVED | 7, Sent when video decoder handle retrieved |
| AAMP_EVENT_JS_EVENT | 8, Generic event generated by JavaScript binding |
| AAMP_EVENT_MEDIA_METADATA | 9, Meta-data of asset currently playing |
| AAMP_EVENT_ENTERING_LIVE | 10, Event when live point reached |
| AAMP_EVENT_BITRATE_CHANGED | 11, Event when bitrate changes |
| AAMP_EVENT_TIMED_METADATA | 12, Meta-data of a subscribed tag parsed from manifest |
| AAMP_EVENT_BULK_TIMED_METADATA | 13, Bulk Meta-data of a subscribed tag parsed from manifest |
| AAMP_EVENT_STATE_CHANGED | 14, Event when player state changes |
| AAMP_EVENT_SPEEDS_CHANGED | 15, Event when supported playback speeds changes |
| AAMP_EVENT_SEEKED | 16, Event when seek completes, including new position |
| AAMP_EVENT_TUNE_PROFILING | 17, Event when micro event data sends |
| AAMP_EVENT_BUFFERING_CHANGED | 18, Event when buffering starts/ends btw a playback |
| AAMP_EVENT_DURATION_CHANGED | 19, Event when duration changed |
| AAMP_EVENT_AUDIO_TRACKS_CHANGED | 20, Event when available audio tracks changes |
| AAMP_EVENT_TEXT_TRACKS_CHANGED | 21, Event when available test tracks changes |
| AAMP_EVENT_AD_BREAKS_CHANGED | 22, Event when content/ad breaks changes |
| AAMP_EVENT_AD_STARTED | 23, Ad playback started |
| AAMP_EVENT_AD_COMPLETED | 24, Ad playback completed |
| AAMP_EVENT_DRM_METADATA | 25, Event with DRM metadata info |
| AAMP_EVENT_REPORT_ANOMALY | 26, Playback Anomaly reporting |
| AAMP_EVENT_WEBVTT_CUE_DATA | 27, WebVTT Cue data |
| AAMP_EVENT_AD_RESOLVED | 28, Ad fulfill status |
| AAMP_EVENT_AD_RESERVATION_START | 29, Adbreak playback starts |
| AAMP_EVENT_AD_RESERVATION_END | 30, Adbreak playback ends |
| AAMP_EVENT_AD_PLACEMENT_START | 31, Ad playback starts |
| AAMP_EVENT_AD_PLACEMENT_END | 32, Ad playback ends |
| AAMP_EVENT_AD_PLACEMENT_ERROR | 33, Ad playback error |
| AAMP_EVENT_AD_PLACEMENT_PROGRESS | 34, Ad playback progress |
| AAMP_EVENT_REPORT_METRICS_DATA | 35, AAMP VideoEnd info reporting |
| AAMP_EVENT_ID3_METADATA | 36, ID3 metadata from audio stream |
| AAMP_EVENT_DRM_MESSAGE | 37, Message from the DRM system |
| AAMP_EVENT_BLOCKED | 38, ATSC AV BLOCKED Event |
| AAMP_EVENT_CONTENT_GAP | 39, Content gap event for progress gap reporting |
| AAMP_EVENT_HTTP_RESPONSE_HEADER | 40, Http response header data |
| AAMP_EVENT_WATERMARK_SESSION_UPDATE | 41, Update on Watermark Session |
| AAMP_EVENT_CONTENT_PROTECTION_DATA_UPDATE | 42, Update on Content Protection Data on Dynamic Key Rotation |
Definition at line 44 of file AampEvent.h.
| enum AAMPEventMode |
AAMP event modes.
| Enumerator | |
|---|---|
| AAMP_EVENT_DEFAULT_MODE | Aamp Default event mode |
| AAMP_EVENT_SYNC_MODE | Events handled in sync mode |
| AAMP_EVENT_ASYNC_MODE | Events handled in Async mode |
Definition at line 97 of file AampEvent.h.
| enum AAMPTuneFailure |
AAMP playback error codes.
Definition at line 108 of file AampEvent.h.
| enum PrivAAMPState |
Mapping all required status codes based on JS player requirement. These requirements may be forced by psdk player.AAMP may not use all the statuses mentioned below: Mainly required states - idle, initializing, initialized, preparing, prepared, playing, paused, seek, complete and error.
Definition at line 156 of file AampEvent.h.
| enum VideoScanType |
VideoScanType - Progressive/Interlaced.
Video Scan Type
| Enumerator | |
|---|---|
| eVIDEOSCAN_PROGRESSIVE | Progressive Video |
| eVIDEOSCAN_INTERLACED | Interlaced Video |
| eVIDEOSCAN_UNKNOWN | Unknown Video |
Definition at line 190 of file AampEvent.h.