{"id":10075,"date":"2022-06-21T09:10:46","date_gmt":"2022-06-21T09:10:46","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/components\/open-sourced_components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/"},"modified":"2025-03-25T05:18:34","modified_gmt":"2025-03-25T05:18:34","slug":"aamp_-_native_video_engine_player_api","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/","title":{"rendered":"AAMP – Native Video Engine Player API"},"content":{"rendered":"


\n <\/p>\n\n\n

Overview<\/h2>\n\n\n

This document defines the Native Video engine (AAMP) APIs for embedded devices.  <\/p>\n<\/p>\n

Table of key web links<\/p>\n

\n\n\n<\/colgroup>
Web Resource<\/th>Owner<\/th>Descrption<\/th><\/tr>
W3C MSE Specifications<\/td>W3C<\/td>HTML5 specs for Media Source Extenstions<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

 <\/p>\n\n\n

Architecture<\/h2>\n\n\n

This section provides a high level architecture <\/p>\n<\/p>\n\n\n

AAMP Video Engine APIs <\/h2>\n\n\n

This section defines the properties, methods and events for the AAMP Video Engine<\/p>\n<\/p>\n

<\/p>\n

Core Video Engine Functionality<\/h3>\n

Class<\/h3>\n

                       AAMPVideoEngine<\/strong><\/p>\n

Properties<\/h3>\n
\n\n\n<\/colgroup>
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>

PlayerVersion<\/p><\/td>

String<\/td>r<\/td>

Version of the player available as a string<\/p><\/td><\/tr>

MediaType<\/p><\/td>

Number<\/td>r<\/td>

Type of media  enum { LIVE =1, VOD=2, cDVR=3 }<\/p>

Note: may be implied by manifest contents (open\/live vs. closed), but in some cases media type (EAS, CDVR) may be knowable only by Player.<\/p><\/td><\/tr>

PlayerState<\/p><\/td>

Number<\/td>r<\/td>

Player State Enum.<\/p>

   IDLE, \/\/ initial state of player<\/p>

   INITIALIZING, \/\/ drm individualization, etc.<\/p>

   INITIALIZED, \/\/ TBR?<\/p>

   PREPARING, \/\/ manifest request in progress – TBR?<\/p>

   PREPARED, \/\/ have knowledge about stream contents, language availability, etc.<\/p>

   BUFFERING, \/\/ collecting a\/v fragments – not currently presenting; could happen if run dry during playback<\/p>

   PAUSED, \/\/ player-initiated pause<\/p>

   SEEKING, \/\/ seek-in-progress – variant of buffering<\/p>

   PLAYING, \/\/ a\/v actively streaming\/presenting<\/p>

   STOPPING, \/\/ reflects async state – needed?<\/p>

   STOPPED, \/\/ playback stopped at end of asset<\/p>

   COMPLETE, \/\/ ?<\/p>

   ERROR, \/\/ fatal video engine state<\/p>

   RELEASED<\/p><\/td><\/tr>

CurrentPosition<\/p><\/td>

Number<\/td>r<\/td>

Current media play position (milliseconds or seconds?)<\/p><\/td><\/tr>

MediaInfo<\/p><\/td>

Object<\/td>r<\/td>

Information about the Media being played by the Player<\/p>

totalDuration \u2013 Total duration of the Media<\/p>

startPostion \u2013 Media Start Position<\/p>

endPosition \u2013 Media End Position<\/p><\/td><\/tr>

currentPlaybackSpeed<\/p><\/td>

Number<\/td>r<\/td>

Current speed (play rate); 0 if paused, negative if rewinding<\/p><\/td><\/tr>

getSupportedSpeed<\/p><\/td>

Number[ ]<\/td>r<\/td>

Array of supported speeds;<\/p>

[-64, -32, -16, -4, -1, 0, 1, 4, 16, 32, 64];<\/p>

Needed? An ip video player can present iframe track at arbitrary speeds<\/p>

This set changes during trick mode restrictions; subset may be used during ad.<\/p><\/td><\/tr>

timeline<\/p><\/td>

Timeline<\/td>r<\/td>

Timeline for tracking dynamic ad insertion (DAI)<\/p><\/td><\/tr>

Volume<\/p><\/td>

Number<\/td>r<\/td>

Current volume (only mute\/unmute is actually used)<\/p><\/td><\/tr>

drm<\/td>Drm<\/td>r<\/td>interface to Drm specific properties and methods<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

Methods<\/h3>\n
\n\n\n<\/colgroup>
Name<\/th>Return Value<\/th>Arguments<\/th>Description<\/th><\/tr>

setURI<\/p><\/td>

errorcode<\/p><\/td>

String<\/p><\/td>

URI of the content<\/p><\/td><\/tr>

initParam<\/p><\/td>

errorcode<\/p><\/td>

String<\/p><\/td>

JSON string of key value pair of all the properties to be set.<\/p><\/td><\/tr>

play<\/p><\/td>

errorcode<\/p><\/td>

none<\/p><\/td>

starts video playback<\/p><\/td><\/tr>

pause<\/p><\/td>

errorcode<\/p><\/td>

none<\/p><\/td>

pauses video playback. Equivalent to speed = 1<\/p><\/td><\/tr>

stop<\/p><\/td>

void<\/p><\/td>

none<\/p><\/td>

stops video playback. Video is not expected to resume.<\/p><\/td><\/tr>

seek<\/p><\/td>

errorcode<\/p><\/td>

Msec \u2013 Number<\/p><\/td>

Desired Playback position in milliseconds<\/p><\/td><\/tr>

seekToLive<\/p><\/td>

errorcode<\/p><\/td>

Void<\/p><\/td>

Seek to live stream<\/p><\/td><\/tr>

setSpeed<\/p><\/td>

errorcode<\/span><\/p><\/td>

speed – Number<\/p>

overshootCorrection – Number (milliseconds)<\/p><\/td>

sets the speed and adjusts the position of the video by the number of milliseconds specified by overshootCorrection<\/p><\/td><\/tr>

setRect<\/p><\/td>

errorcode<\/span><\/p><\/td>

OffsetX \u2013 number<\/p>

OffsetY \u2013 number<\/p>

Width \u2013 number<\/p>

Height – number<\/p><\/td>

Method to set the rectangular coordinates for video display<\/p><\/td><\/tr>

setAutoPlay<\/p><\/td>

errorcode<\/span><\/p><\/td>

autoPlay – Boolean<\/p><\/td>

when true, video starts playing immediately; when false, playback must be manually started.<\/p><\/td><\/tr>

setZoom<\/p><\/td>

errorcode<\/span><\/p><\/td>

Setting \u2013 number<\/p><\/td>

Desired zoom setting enum \u2013 { FULL = 0; NONE-1 }<\/p><\/td><\/tr>

addEventListener<\/p><\/td>

errorcode<\/span><\/p><\/td>

eventName \u2013 String<\/p>

listener – Function<\/p><\/td>

Method to add an event listener corresponding to an event<\/p>

TODO: list of event names and semantics<\/p><\/td><\/tr>

removeEventListener<\/p><\/td>

errorcode<\/span><\/p><\/td>

eventName \u2013 String<\/p><\/td>

Method to remove an event listener corresponding to an event<\/p><\/td><\/tr>

getAvailableLanguages<\/p><\/td>

Object<\/p><\/td>

None<\/p><\/td>

Returns a collection of available of audio languages as enums<\/p>

currently polled – why?<\/p><\/td><\/tr>

setLanguage<\/p><\/td>

errorcode<\/span><\/p><\/td>

Language \u2013 Number<\/p><\/td>

Desired audio language. Default is Eng.<\/p>

{ENG=0; SPANISH = 1; FRENCH=2; ITALIAN=3; \u2026.. }<\/p>

enum or iso language code?<\/p><\/td><\/tr>

setVideoMute<\/p><\/td>

errorcode<\/span><\/p><\/td>

Mute \u2013 Boolean<\/p><\/td>

True if mute or false otherwise.<\/p><\/td><\/tr>

setAudioVolume<\/p><\/td>

errorcode<\/span><\/p><\/td>

Volume – Number<\/p><\/td>

Preferred audio volume to set.<\/p><\/td><\/tr>

enableTSB<\/p><\/td>

errorcode<\/span><\/p><\/td>

enableTSB \u2013 Boolean<\/p><\/td>

Enable TSB if True else false<\/p><\/div><\/td><\/tr>

getProperty<\/p><\/td>

Object<\/p><\/td>

Property \u2013 String<\/p><\/td>

Returns the property value or a null object if error – TBR?<\/p><\/td><\/tr>

setProperty<\/p><\/td>

errorcode<\/p><\/td>

Property \u2013 String<\/p>

Value \u2013 object<\/p><\/td>

Sets the value for the specified property – TBR?<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

DAI  APIs<\/h3>\n

Classes<\/span><\/h3>\n

AAMPVideoEngine.TimedMetadata
AAMPVideoEngine.Timeline
AAMPVideoEngine.AdBreak
AAMPVideoEngine.Ad
AAMPVideoEngine.TrickModeRestrictions
AAMPVideoEngine.AdOpportunity
<\/strong><\/p>\n<\/p>\n

Timeline Properties<\/h3>\n<\/p>\n
\n\n\n
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>

adBreaks<\/p><\/td>

AdBreak[ ]<\/td>r<\/td>

Array of Ad breaks<\/p><\/td><\/tr>

adOpportunities<\/p><\/td>

AdOpportunity[]<\/td>r<\/td>

Array of Ad opportunities<\/p><\/td><\/tr>

start<\/td>Number<\/td>r<\/td>Time (ms) of earliest content<\/td><\/tr>
duration<\/td>Number<\/td>r<\/td>Time (ms) of content + placed ads<\/td><\/tr>
position<\/td>Number<\/td>r<\/td>Time (ms) of current playback postion<\/td><\/tr>
restrictions<\/td>TrickModeRestrictions<\/td>r<\/td>Trickmode restrictions on the entire timeline.<\/td><\/tr>
timedMetadata<\/td>TimedMetadata[]<\/td>r<\/td>Array of TimedMetadata<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

Timeline Methods<\/h3>\n
\n\n\n
Name<\/th>Return Value<\/th>Arguments<\/th>Description<\/th><\/tr>

addEventListener<\/p><\/td>

errorcode<\/p><\/td>

eventType \u2013 String
listener \u2013 Function<\/p><\/td>

Method to add an event listener corresponding to an event type.<\/p><\/td><\/tr>

removeEventListener<\/p><\/td>

errorcode<\/p><\/td>

eventType \u2013 String
listener \u2013 Function<\/p><\/td>

Method to remove an event listener corresponding to an event type.<\/p><\/td><\/tr>

placeAdBreak<\/td>bool<\/td>position \u2013 Number
adBreak – Object<\/td>

Places the specified AdBreak at the specified position in the timeline.
Return true if successful.<\/p><\/td><\/tr>

subscribeTimedMetadata<\/td>errorcode<\/td>tags – String []<\/td>

Sets array of HLS tags to monitor while parsing the manifest.
Fire “timedMetadata” event when timedMetadata[] is updated.;<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

Timeline Events<\/h3>\n
\n\n\n<\/colgroup>
Name<\/th>Payload<\/th>Description<\/th><\/tr>
timedMetadata<\/td>timedMetadata – TimedMetadata<\/td>Fired when new TimedMetadata has been parsed, or modified.<\/td><\/tr>
timelineUpdated<\/td>

seekableRangeChanged – bool
adBreaks – AdBreak[] – array of modified AdBreaks
adOpportunities – AdOpportunity[] – array of inserted AdOpportunities
duration – Number – duration of entire timeline (milliseconds)
start – Number – earliest seekable position in the timeline (milliseconds)<\/p><\/td>

Fired when the timeline is updated.
An update occurs when the timeline start\/duration changes, or new AdOpportunity has been inserted, or an AdBreak \/ Ad has been placed.<\/p><\/td><\/tr>

adBreakStart<\/td>

adBreak – AdBreak – the adBreak being started
speed – Number – current playback rate
seenCount – Number – number of times Ad break was played (in full).<\/p><\/td>

Fired when player starts playing an AdBreak.<\/td><\/tr>
adBreakComplete<\/td>

adBreak – AdBreak – the adBreak being finished
progress – Number – percentage of Ads played
ads – Ad[] – array of Ad including played progress of each Ad.<\/p><\/td>

Fired when player finishes playing an AdBreak.<\/td><\/tr>
adBreakSkipped<\/td>

adBreak – AdBreak – the adBreak being skipped or exited
progress – Number – percentage of Ads played<\/p><\/td>

Fired when player skips over an AdBreak.<\/td><\/tr>
adStart<\/td>

ad – Ad – the Ad being started
speed – Number – current playback rate
seenCount – Number – number of times Ad was played (in full).<\/p><\/td>

Fired when player start playing an Ad.<\/td><\/tr>
adProgress<\/td>

ad – Ad – the Ad being played
progress – Number – percentage of Ad played<\/p><\/td>

Reports the player’s progress as it plays an Ad.<\/td><\/tr>
adComplete<\/td>

ad – Ad – the Ad that finished begin played
progress – Number – percentage of Ad played<\/p><\/td>

Fired when player finishes playing an Ad.<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

TimedMetadata Properties<\/h3>\n
\n\n\n<\/colgroup>

Name<\/strong><\/p><\/td>

Data Type<\/strong><\/p><\/td>

Read or Write<\/strong><\/p><\/td>

Description<\/strong><\/p><\/td><\/tr><\/thead>

METADATA_TYPE_TAG<\/p><\/td>

0<\/p><\/td>

static const<\/p><\/td>

Indicates metadata is from the manifest.<\/p><\/td><\/tr>

METADATA_TYPE_ID3<\/p><\/td>

1<\/p><\/td>

static const<\/p><\/td>

Indicates metadata was embedded in the content.<\/p><\/td><\/tr>

METADATA_TYPE_DASH<\/p><\/td>

2<\/p><\/td>

static const<\/p><\/td>

Indicates metadata was generated from DASH MPD.<\/p><\/td><\/tr>

type<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Specified the metadata type: manifest vs. embedded.<\/p><\/td><\/tr>

time<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Time (in milliseconds) of the metadata.<\/p><\/td><\/tr>

name<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Name of the metadata. E.g., #EXT-X-CUE, #EXT-X-SCTE35.<\/p><\/td><\/tr>

content<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Value of the metadata.<\/p><\/td><\/tr>

id<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Unique identifier associated with the metadata.<\/p><\/td><\/tr>

metadata<\/p><\/td>

Object<\/p><\/td>

r<\/p><\/td>

Additional name \/ value pairs obtained from the metadata content string.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

AdBreak Properties<\/h3>\n
\n\n\n
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>
ADBREAK_TYPE_INSERT<\/td>0<\/td>static const<\/td>

Indicates adBreak was inserted.<\/p><\/td><\/tr>

ADBREAK_TYPE_REPLACED<\/td>1<\/td>static const<\/td>

Indicates adBreak was replaced.<\/p><\/td><\/tr>

type<\/p><\/td>

Number<\/td>r<\/td>Type of adBreak (inserted or replaced).<\/td><\/tr>

id<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Unique identifier associated with the ad break.<\/p><\/td><\/tr>

start<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Starting position (milliseconds) of the ad break in the timeline.<\/p><\/td><\/tr>

duration<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Duration (milliseconds) of the ad break.<\/p><\/td><\/tr>

ads<\/p><\/td>

Ad[]<\/p><\/td>

r<\/p><\/td>

Array of Ad objects (sorted by time).
Contains the ads that will be played during the ad break.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

 <\/span><\/p>\n

AdBreak Methods<\/h3>\n
\n\n\n
Name<\/th>Return Value<\/th>Arguments<\/th>Description<\/th><\/tr>

placeAds<\/p><\/td>

 bool<\/td>position – Number,

ads – Object[]<\/p><\/td>

Place the specified Ad objects in the AdBreak.

Return true if successful.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

Ad Properties<\/h3>\n
\n\n\n
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>

id<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Unique identifier associated with the Ad.<\/p><\/td><\/tr>

url<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

URL specifying the location of the ad’s manifest..<\/p><\/td><\/tr>

duration<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Duration (milliseconds) of the ad.<\/p><\/td><\/tr>

restrictions<\/td>TrickModeRestrictions<\/td>r<\/td>Trickmode restrictions applying to the Ad.<\/td><\/tr>

seenCount<\/p><\/td>

Number<\/td>r<\/td>Number of time AdBreak was played (in full).<\/td><\/tr>

metadata<\/p><\/td>

Object<\/p><\/td>

r<\/p><\/td>

Additional metadata associated with the ad.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

TrickModeRestrictions Properties<\/h3>\n
\n\n\n
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>
TRICKMODE_RESTRICTED_ALWAYS<\/td>-1<\/td>static const<\/td>

Indicates restriciton applies always.<\/p><\/td><\/tr>

TRICKMODE_RESTRICTED_NEVER<\/td>0<\/td>static const<\/td>

Indicates restriciton does not apply.<\/p><\/td><\/tr>

pause<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Specifies if pause is restricted during Ad playback.
Values greater than 0 apply while less than seenCount.<\/span><\/p><\/td><\/tr>

rewind<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Specifies if rewind is restricted during Ad playback.<\/p><\/td><\/tr>

fastForward<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Specified if fastForward \/ seek is restricted during Ad playback.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

AdOpportunity Properties<\/h3>\n
\n\n\n<\/colgroup>
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>
AD_PLACEMENT_TYPE_PREROLL<\/td>0<\/td>static const<\/td>

Indicates opportunity places ad before the main content.<\/span><\/p><\/td><\/tr>

AD_PLACEMENT_TYPE_MIDROLL<\/td>1<\/td>static const<\/td>

Indicates opportunity places ad in the main content.<\/span><\/p><\/td><\/tr>

AD_PLACEMENT_TYPE_POSTROLL<\/td>2<\/td>static const<\/td>Indicates opportunity places ad after the main content.<\/span>


<\/p><\/td><\/tr>

AD_PLACEMENT_MODE_INSERT<\/td>0<\/td>static const<\/td>

Indicates restriciton applies always.<\/p><\/td><\/tr>

AD_PLACEMENT_MODE_REPLACE<\/td>1<\/td>static const<\/td>

Indicates restriciton does not apply.<\/p><\/td><\/tr>

id<\/p><\/td>

String<\/p><\/td>

r<\/p><\/td>

Unique identifier associated with the ad opportunity.<\/p><\/td><\/tr>

placement<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Indicates placement type: preroll vs. midroll vs. postroll.<\/p><\/td><\/tr>

mode<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Indicates placement mode: insertion vs. replacement.<\/p><\/td><\/tr>

start<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Starting position (milliseconds) of the ad opportunity.<\/p><\/td><\/tr>

duration<\/p><\/td>

Number<\/p><\/td>

r<\/p><\/td>

Duration (milliseconds) of the ad.<\/p><\/td><\/tr>

metadata<\/p><\/td>

Object<\/p><\/td>

r<\/p><\/td>

Additional metadata associated with the ad opportunity.<\/p><\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

 <\/span>DRM  APIs<\/h3>\n

These apis are modeled using the open CDMI framework<\/p>\n

Classes<\/span><\/h3>\n

AAMPVideoEngine.Drm<\/strong><\/p>\n<\/p>\n

DRM Properties<\/strong><\/p>\n

\n\n\n<\/colgroup>
Name<\/th>Data Type<\/th>

Read or Write<\/p><\/th>

Description<\/th><\/tr>

supportedKeySystems<\/p><\/td>

string[]<\/td>r<\/td>array of supported DRM keysystems<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

DRM Methods<\/strong><\/p>\n

\n\n\n
Name<\/th>Return Value<\/th>

Arguments<\/p><\/th>

Description<\/th><\/tr>

setPreferredKeySystem<\/span><\/p><\/td>

errorcode<\/span><\/td>string<\/td>sets the preferred DRM Key system AAMP player will use. Ex: “com.microsoft.playready”<\/td><\/tr>
setLicenseServerURL<\/td>errorcode<\/td>string<\/td>sets the URL used for license acquisition<\/td><\/tr>
setAnonymousRequest<\/td>errorcode<\/td>bool<\/td>if true, don’t use session token in MDS license request (anonymous mode)
if false, use session token in MDS license request<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

DRM Events<\/strong><\/p>\n

\n\n\n<\/colgroup>
Name<\/th>Payload<\/th>Description<\/th><\/tr>

drmReady<\/span><\/p><\/td>

none<\/td>fired when license is acquired and content is ready to play<\/td><\/tr>

drmError<\/p>


<\/p><\/td>

code – Number<\/p>

description – String<\/p><\/td>

fired when license acquisition fails<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

Appendix: JavaScript Player Generated Events<\/h3>\n
\n\n\n<\/colgroup>
Name<\/th>Payload<\/th>Description<\/th><\/tr>
onMediaOpened<\/td>

mediaType – String – has one of the following values: live, liveTSB, recorded<\/p>

width – Number<\/p>

height – Number<\/p>

availableSpeeds – Number<\/p>

availableAudioLanguages – String [ ]<\/p>

availableClosedCaptionsLanguages – String [ ]<\/p>

customProperties – Object<\/p>

mediaSegments – Object<\/p><\/div><\/td>

Gathered in JS from VE<\/p>

Fired when video content has been opened (in “PREPARED” state)<\/p><\/td><\/tr>

onClosed<\/td>none<\/td>fired when the video stream is closed<\/td><\/tr>
onPlayerInitialized<\/td>none<\/td>fired when the video player is initialized<\/td><\/tr>
onBuffering<\/td>none<\/td>fired when video starts buffering. playback is not possible at this time.<\/td><\/tr>
onPlaying<\/td>none<\/td>fired when video starts playing for the first time.<\/td><\/tr>
onPaused<\/td>none<\/td>fired when video is paused (or speed is set to 0)<\/td><\/tr>
onComplete<\/td>none<\/td>fired when video is reaches its end, VOD or cDVR for example.<\/td><\/tr>
onIndividualizing<\/td>none<\/td>fired when player is individualizing. Playback is not possible. Not all instances will fire this event.<\/td><\/tr>
onAcquiringLicense<\/td>none<\/td>

fired when player is acquiring a license. Playback is not yet possible. Not all instances will fire this event.<\/p>

Technically not needed, but potentially useful for troubleshooting\/profiling<\/p><\/td><\/tr>

onProgress<\/td>

position – Number – current position in milliseconds<\/p>

duration – Number – length of content in milliseconds (recorded video only)<\/p>

speed – Number – current playback speed<\/p>

start – Number – start position of the TSB buffer, -1 when no buffer available<\/p>

end – Number – end position of the TSB buffer, -1 when no buffer available<\/p><\/td>

fired periodically when player progresses<\/p>

When TSB starts, start=end=0<\/p>

As TSB advances, end increases<\/p>

When TSB begins culling, start>0<\/p><\/td><\/tr>

onWarning<\/td>

code – Number<\/p>

description – String<\/p><\/td>

fired when a warning occurs. video playback will likely continue.<\/td><\/tr>
onError<\/td>

code – Number<\/p>

description – String<\/p><\/td>

fired when an error occurs. video playback will terminate.<\/td><\/tr>
onSpeedChange<\/td>speed – Number<\/td>fired when playback speed changes<\/td><\/tr>
onDRMMetadata<\/td>props – Object<\/td>fired when DRM metadata is acquired. Contains DRM related properties.<\/td><\/tr>
onSegmentStarted<\/td>

segmentType – String<\/p>

duration – Number<\/p>

segmentId – String<\/p>

segment – Object<\/p><\/td>

fired when a new segment is started.<\/td><\/tr>
onSegmentCompleted<\/td>

segmentType – String<\/p>

duration – Number<\/p>

segmentId – String<\/p>

segment – Object<\/p><\/td>

fired when a segment is has completed<\/td><\/tr>
onSegmentWatched<\/td>

segmentType – String<\/p>

duration – Number<\/p>

segmentId – String<\/p>

segment – Object<\/p><\/td>

fired when a segment has been started and completed.<\/td><\/tr>
onBufferWarning<\/td>

warningType – String – one of BUFFER_UNDERFLOW or BUFFER_OVERFLOW<\/p>

bufferSize – Number – total size of buffer<\/p>

bufferFillSize – Number – current filled size of buffer<\/p><\/td>


<\/td><\/tr>
onPlaybackSpeedsChanged<\/td>availableSpeeds – String [ ]<\/td>fired when playback speeds have changed. This may happen when the video switches from one segment to the next.<\/td><\/tr>
onAdditionalAuthRequired<\/td>

locator – String<\/p>

eventId – String<\/p><\/td>

fired when video needs additional auth to continue playback<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n

<\/body><\/html><\/p>","protected":false},"excerpt":{"rendered":"

Overview This document defines the Native Video engine (AAMP) APIs for embedded devices.   Table […]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10015,"menu_order":16,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10075","page","type-page","status-publish","hentry"],"yoast_head":"\nAAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"AAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Overview This document defines the Native Video engine (AAMP) APIs for embedded devices.   Table […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:34+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"9 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/\",\"name\":\"AAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:10:46+00:00\",\"dateModified\":\"2025-03-25T05:18:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Video\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Advanced Adaptive Media Player (AAMP)\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"AAMP – Native Video Engine Player API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"AAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/","og_locale":"en_US","og_type":"article","og_title":"AAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation","og_description":"Overview This document defines the Native Video engine (AAMP) APIs for embedded devices.   Table […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:34+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"9 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/","name":"AAMP - Native Video Engine Player API - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:10:46+00:00","dateModified":"2025-03-25T05:18:34+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_-_native_video_engine_player_api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Video","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"Advanced Adaptive Media Player (AAMP)","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/"},{"@type":"ListItem","position":6,"name":"AAMP – Native Video Engine Player API"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10075","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=10075"}],"version-history":[{"count":4,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10075\/revisions"}],"predecessor-version":[{"id":11125,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10075\/revisions\/11125"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10015"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=10075"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}