Dash JS

Modules

Classes

BaseMatcher
BufferLevel
BufferState
CommonProperty
DroppedFrames
DVRInfo
HTTPRequest
HTTPRequestTrace
LiveEdgeFinder
ManifestUpdate
ManifestUpdateStreamInfo
ManifestUpdateTrackInfo
MediaPlayerEvents
PlayList
PlayListTrace
ProtectionEvents
RepresentationSwitch
RequestsQueue
SchedulingInfo
TCPConnection

Events

BUFFER_EMPTY

Triggered when the video element's buffer state changes to stalled. Check mediaType in payload to determine type (Video, Audio, FragmentedText).

Source:

BUFFER_LEVEL_STATE_CHANGED

Triggered when the video element's buffer state changes, either stalled or loaded. Check payload for state.

Source:

BUFFER_LOADED

Triggered when the video element's buffer state changes to loaded. Check mediaType in payload to determine type (Video, Audio, FragmentedText).

Source:

CAN_PLAY

Sent when enough data is available that the media can be played, at least for a couple of frames. This corresponds to the HAVE_ENOUGH_DATA readyState.

Source:

ERROR

Triggered when there is an error from the element or MSE source buffer.

Source:

FRAGMENT_LOADING_ABANDONED

Triggered when a fragment download is abandoned due to detection of slow download base on the ABR abandon rule..

Source:

FRAGMENT_LOADING_COMPLETED

Triggered when a fragment download has completed.

Source:

FRAGMENT_LOADING_STARTED

Triggered when a fragment download has started.

Source:

LOG

Triggered when module:Debug log method is called.

Source:

MANIFEST_LOADED

Triggered when the manifest load is complete

Source:

METRIC_ADDED

Triggered every time a new metric is added.

Source:

METRIC_CHANGED

Triggered when an individual metric is added, updated or cleared.

Source:

METRIC_UPDATED

Triggered every time a metric is updated.

Source:

METRICS_CHANGED

Triggered anytime there is a change to the overall metrics.

Source:

PERIOD_SWITCH_COMPLETED

Triggered at the stream end of a period.

Source:

PERIOD_SWITCH_STARTED

Triggered when a new period starts.

Source:

PLAYBACK_ENDED

Sent when playback completes.

Source:

PLAYBACK_ERROR

Sent when an error occurs. The element's error attribute contains more information.

Source:

PLAYBACK_METADATA_LOADED

The media's metadata has finished loading; all attributes now contain as much useful information as they're going to.

Source:

PLAYBACK_NOT_ALLOWED

Sent when playback is not allowed (for example if user gesture is needed).

Source:

PLAYBACK_PAUSED

Sent when playback is paused.

Source:

PLAYBACK_PLAYING

Sent when the media begins to play (either for the first time, after having been paused, or after ending and then restarting).

Source:

PLAYBACK_PROGRESS

Sent periodically to inform interested parties of progress downloading the media. Information about the current amount of the media that has been downloaded is available in the media element's buffered attribute.

Source:

PLAYBACK_RATE_CHANGED

Sent when the playback speed changes.

Source:

PLAYBACK_SEEKED

Sent when a seek operation completes.

Source:

PLAYBACK_SEEKING

Sent when a seek operation begins.

Source:

PLAYBACK_STARTED

Sent when playback of the media starts after having been paused; that is, when playback is resumed after a prior pause event.

Source:

PLAYBACK_TIME_UPDATED

The time indicated by the element's currentTime attribute has changed.

Source:

QUALITY_CHANGE_RENDERED

Triggered when the new ABR quality is being rendered on-screen.

Source:

QUALITY_CHANGE_REQUESTED

Triggered when an ABR up /down switch is initialed; either by user in manual mode or auto mode via ABR rules.

Source:

STREAM_INITIALIZED

Triggered when the stream is setup and ready.

Source:

TEXT_TRACK_ADDED

Triggered when a text track is added to the video element's TextTrackList

Source:

TEXT_TRACKS_ADDED

Triggered once all text tracks detected in the MPD are added to the video element.

Source:

KEY_ADDED

Event ID for events delivered when a new key has been added

Deprecated:
  • The latest versions of the EME specification no longer use this event. {@MediaPlayer.models.protectionModel.eventList.KEY_STATUSES_CHANGED} is preferred.
Source:

KEY_ERROR

Event ID for events delivered when an error is encountered by the CDM while processing a license server response message

Source:

KEY_MESSAGE

Event ID for events delivered when the protection set receives a key message from the CDM

Source:

KEY_SESSION_CLOSED

Event ID for events delivered when a key session close process has completed

Source:

KEY_SESSION_CREATED

Event ID for events delivered when a new key sessions creation process has completed

Source:

KEY_SESSION_REMOVED

Event ID for events delivered when a key session removal process has completed

Source:

KEY_STATUSES_CHANGED

Event ID for events delivered when the status of one or more decryption keys has changed

Source:

KEY_SYSTEM_SELECTED

Event ID for events delivered when a key system selection procedure completes

Source:

LICENSE_REQUEST_COMPLETE

Event ID for events delivered when a license request procedure has completed

Source:

PROTECTION_CREATED

Event ID for events delivered when the Protection system is detected and created.

Source:

PROTECTION_DESTROYED

Event ID for events delivered when the Protection system is destroyed.

Source: