PlayerVersion

Version of the player available as a string

MediaType

Type of media  enum { LIVE =1, VOD=2, cDVR=3 }

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.

PlayerState

Player State Enum.

   IDLE, // initial state of player

   INITIALIZING, // drm individualization, etc.

   INITIALIZED, // TBR?

   PREPARING, // manifest request in progress - TBR?

   PREPARED, // have knowledge about stream contents, language availability, etc.

   BUFFERING, // collecting a/v fragments - not currently presenting; could happen if run dry during playback

   PAUSED, // player-initiated pause

   SEEKING, // seek-in-progress - variant of buffering

   PLAYING, // a/v actively streaming/presenting

   STOPPING, // reflects async state - needed?

   STOPPED, // playback stopped at end of asset

   COMPLETE, // ?

   ERROR, // fatal video engine state

   RELEASED

CurrentPosition

Current media play position (milliseconds or seconds?)

MediaInfo

Information about the Media being played by the Player

totalDuration – Total duration of the Media

startPostion – Media Start Position

endPosition – Media End Position

currentPlaybackSpeed

Current speed (play rate); 0 if paused, negative if rewinding

getSupportedSpeed

Array of supported speeds;

[-64, -32, -16, -4, -1, 0, 1, 4, 16, 32, 64];

Needed? An ip video player can present iframe track at arbitrary speeds

This set changes during trick mode restrictions; subset may be used during ad.

timeline

Timeline for tracking dynamic ad insertion (DAI)

Volume

Current volume (only mute/unmute is actually used)

adBreaks

Array of Ad breaks

adOpportunities

Array of Ad opportunities

addEventListener

errorcode

eventType – String
listener – Function

Method to add an event listener corresponding to an event type.

removeEventListener

errorcode

eventType – String
listener – Function

Method to remove an event listener corresponding to an event type.

Places the specified AdBreak at the specified position in the timeline.
Return true if successful.

Sets array of HLS tags to monitor while parsing the manifest.
Fire "timedMetadata" event when timedMetadata[] is updated.;

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)

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.

adBreak - AdBreak - the adBreak being started
speed - Number - current playback rate
seenCount - Number - number of times Ad break was played (in full).

adBreak - AdBreak - the adBreak being finished
progress - Number - percentage of Ads played
ads - Ad[] - array of Ad including played progress of each Ad.

adBreak - AdBreak - the adBreak being skipped or exited
progress - Number - percentage of Ads played

ad - Ad - the Ad being started
speed - Number - current playback rate
seenCount - Number - number of times Ad was played (in full).

ad - Ad - the Ad being played
progress - Number - percentage of Ad played

ad - Ad - the Ad that finished begin played
progress - Number - percentage of Ad played

METADATA_TYPE_TAG

0

static const

Indicates metadata is from the manifest.

METADATA_TYPE_ID3

1

static const

Indicates metadata was embedded in the content.

METADATA_TYPE_DASH

2

static const

Indicates metadata was generated from DASH MPD.

type

Number

r

Specified the metadata type: manifest vs. embedded.

time

Number

r

Time (in milliseconds) of the metadata.

name

String

r

Name of the metadata. E.g., #EXT-X-CUE, #EXT-X-SCTE35.

content

String

r

Value of the metadata.

id

String

r

Unique identifier associated with the metadata.

metadata

Object

r

Additional name / value pairs obtained from the metadata content string.

Indicates adBreak was inserted.

Indicates adBreak was replaced.

type

id

String

r

Unique identifier associated with the ad break.

start

Number

r

Starting position (milliseconds) of the ad break in the timeline.

duration

Number

r

Duration (milliseconds) of the ad break.

ads

Ad[]

r

Array of Ad objects (sorted by time).
Contains the ads that will be played during the ad break.

placeAds

ads - Object[]

Return true if successful.

id

String

r

Unique identifier associated with the Ad.

url

String

r

URL specifying the location of the ad's manifest..

duration

Number

r

Duration (milliseconds) of the ad.

seenCount

metadata

Object

r

Additional metadata associated with the ad.

Indicates restriciton applies always.

Indicates restriciton does not apply.

pause

Number

r

Specifies if pause is restricted during Ad playback.
Values greater than 0 apply while less than seenCount.

rewind

Number

r

Specifies if rewind is restricted during Ad playback.

fastForward

Number

r

Specified if fastForward / seek is restricted during Ad playback.

Indicates opportunity places ad before the main content.

Indicates opportunity places ad in the main content.

Indicates restriciton applies always.

Indicates restriciton does not apply.

id

String

r

Unique identifier associated with the ad opportunity.

placement

Number

r

Indicates placement type: preroll vs. midroll vs. postroll.

mode

Number

r

Indicates placement mode: insertion vs. replacement.

start

Number

r

Starting position (milliseconds) of the ad opportunity.

duration

Number

r

Duration (milliseconds) of the ad.

metadata

Object

r

Additional metadata associated with the ad opportunity.

supportedKeySystems

setPreferredKeySystem

drmReady

drmError

code - Number

description - String