dash.js

Modules

Classes

Errors
MediaPlayerEvents
MediaPlayerModel
MetricsReportingEvents
MssErrors
OfflineErrors
OfflineEvents
ProtectionErrors
ProtectionEvents

Events

ADAPTATION_SET_REMOVED_NO_CAPABILITIES

Event that is dispatched whenever an adaptation set is removed due to all representations not being supported.

Source:

AST_IN_FUTURE

Triggered when playback will not start yet
as the MPD's availabilityStartTime is in the future.
Check delay property in payload to determine time before playback will start.

Source:

BASE_URLS_UPDATED

Triggered when the BaseURLs have been updated.

Source:

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_LEVEL_UPDATED

Triggered when the buffer level of a media type has been updated

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:

CAN_PLAY_THROUGH

This corresponds to the CAN_PLAY_THROUGH readyState.

Source:

CAPTION_CONTAINER_RESIZE

Triggered when the caption container is resized.

Source:

CAPTION_RENDERED

Triggered when a caption is rendered.

Source:

CONFORMANCE_VIOLATION

Event that is dispatched whenever the player encounters a potential conformance validation that might lead to unexpected/not optimal behavior

Source:

CONTENT_STEERING_REQUEST_COMPLETED

Triggered when a content steering request has completed.

Source:

DYNAMIC_TO_STATIC

Triggered when a dynamic stream changed to static (transition phase between Live and On-Demand).

Source:

ERROR

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

Source:

EVENT_MODE_ON_RECEIVE

Dash events are triggered as soon as they were parsed.

Source:

EVENT_MODE_ON_START

Dash events are triggered at their respective start points on the timeline.

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_PROGRESS

Triggered when a partial fragment download has completed.

Source:

FRAGMENT_LOADING_STARTED

Triggered when a fragment download has started.

Source:

INBAND_PRFT

Triggered when an inband prft (ProducerReferenceTime) boxes has been received.

Source:

LOG

Triggered when module:Debug logger methods are called.

Source:

MANIFEST_LOADED

Triggered when the manifest load is complete, providing the payload

Source:

MANIFEST_LOADING_FINISHED

Triggered when the manifest loading is finished, providing the request object information

Source:

MANIFEST_LOADING_STARTED

Triggered when the manifest load is started

Source:

MANIFEST_VALIDITY_CHANGED

Manifest validity changed - As a result of an MPD validity expiration event.

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 stream (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_LOADED_DATA

The event is fired when the frame at the current playback position of the media has finished loading;
often the first frame

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_STALLED

Sent when the video element reports stalled

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:

PLAYBACK_VOLUME_CHANGED

Sent when the video element reports that the volume has changed

Source:

PLAYBACK_WAITING

Sent when the media playback has stopped because of a temporary lack of data.

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 initiated; either by user in manual mode or auto mode via ABR rules.

Source:

REPRESENTATION_SWITCH

Event that is dispatched whenever the player switches to a different representation

Source:

STREAM_ACTIVATED

Triggered when a stream (period) is activated

Source:

STREAM_DEACTIVATED

Triggered when a stream (period) is deactivated

Source:

STREAM_INITIALIZED

Triggered when a stream (period) is activated

Source:

STREAM_INITIALIZING

Triggered when a stream (period) is being loaded

Source:

STREAM_TEARDOWN_COMPLETE

Triggered when the player has been reset.

Source:

STREAM_UPDATED

Triggered when a stream (period) is loaded

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:

THROUGHPUT_MEASUREMENT_STORED

Triggered when a throughput measurement based on the last segment request has been stored

Source:

TRACK_CHANGE_RENDERED

Triggered when the new track is being rendered.

Source:

TTML_PARSED

Triggered when a ttml chunk is parsed.

Source:

TTML_TO_PARSE

Triggered when a ttml chunk has to be parsed.

Source:

CMCD_DATA_GENERATED

Triggered when CMCD data was generated for a HTTP request

Source:

OFFLINE_RECORD_FINISHED

Triggered when all record has been downloaded

Source:

OFFLINE_RECORD_LOADEDMETADATA

Triggered when all mediaInfo has been loaded

Source:

OFFLINE_RECORD_STARTED

Triggered when a record is initialized and download is started

Source:

OFFLINE_RECORD_STOPPED

Triggered when the user stop downloading a record

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_ACCESS_COMPLETE

Event ID for events delivered when a key system access procedure
has completed

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:

LICENSE_REQUEST_SENDING

Sending a license rquest

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: