new MediaPlayerEvents()
Public facing external events to be used when developing a player that implements dash.js.
- Implements
- EventsBase
Members
MANAGED_MEDIA_SOURCE_END_STREAMING :string
The streaming attribute of the Managed Media Source is false
- string
MANAGED_MEDIA_SOURCE_START_STREAMING :string
The streaming attribute of the Managed Media Source is true
- string
Events
ADAPTATION_SET_REMOVED_NO_CAPABILITIES
Event that is dispatched whenever an adaptation set is removed due to all representations not being supported.
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.
BASE_URLS_UPDATED
Triggered when the BaseURLs have been updated.
BUFFER_EMPTY
Triggered when the video element's buffer state changes to stalled.
Check mediaType in payload to determine type (Video, Audio, FragmentedText).
BUFFER_LEVEL_STATE_CHANGED
Triggered when the video element's buffer state changes, either stalled or loaded. Check payload for state.
BUFFER_LEVEL_UPDATED
Triggered when the buffer level of a media type has been updated
BUFFER_LOADED
Triggered when the video element's buffer state changes to loaded.
Check mediaType in payload to determine type (Video, Audio, FragmentedText).
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.
CAN_PLAY_THROUGH
This corresponds to the CAN_PLAY_THROUGH readyState.
CAPTION_CONTAINER_RESIZE
Triggered when the caption container is resized.
CAPTION_RENDERED
Triggered when a caption is rendered.
CONFORMANCE_VIOLATION
Event that is dispatched whenever the player encounters a potential conformance validation that might lead to unexpected/not optimal behavior
CONTENT_STEERING_REQUEST_COMPLETED
Triggered when a content steering request has completed.
CUE_ENTER
Triggered when a text track should be shown
CUE_ENTER
Triggered when a text track should be hidden
DVB_FONT_DOWNLOAD_ADDED
Triggered when a font signalled by a DVB Font Download has been added to the document FontFaceSet interface.
DVB_FONT_DOWNLOAD_COMPLETE
Triggered when a font signalled by a DVB Font Download has successfully downloaded and the FontFace can be used.
DVB_FONT_DOWNLOAD_FAILED
Triggered when a font signalled by a DVB Font Download could not be successfully downloaded, so the FontFace will not be used.
DYNAMIC_TO_STATIC
Triggered when a dynamic stream changed to static (transition phase between Live and On-Demand).
ERROR
Triggered when there is an error from the element or MSE source buffer.
EVENT_MODE_ON_RECEIVE
Dash events are triggered as soon as they were parsed.
EVENT_MODE_ON_START
Dash events are triggered at their respective start points on the timeline.
FRAGMENT_LOADING_ABANDONED
Triggered when a fragment download is abandoned due to detection of slow download base on the ABR abandon rule..
FRAGMENT_LOADING_COMPLETED
Triggered when a fragment download has completed.
FRAGMENT_LOADING_PROGRESS
Triggered when a partial fragment download has completed.
FRAGMENT_LOADING_STARTED
Triggered when a fragment download has started.
INBAND_PRFT
Triggered when an inband prft (ProducerReferenceTime) boxes has been received.
LOG
Triggered when module:Debug
logger methods are called.
MANIFEST_LOADED
Triggered when the manifest load is complete, providing the payload
MANIFEST_LOADING_FINISHED
Triggered when the manifest loading is finished, providing the request object information
MANIFEST_LOADING_STARTED
Triggered when the manifest load is started
MANIFEST_VALIDITY_CHANGED
Manifest validity changed - As a result of an MPD validity expiration event.
METRIC_ADDED
Triggered every time a new metric is added.
METRIC_CHANGED
Triggered when an individual metric is added, updated or cleared.
METRIC_UPDATED
Triggered every time a metric is updated.
METRICS_CHANGED
Triggered anytime there is a change to the overall metrics.
PERIOD_SWITCH_COMPLETED
Triggered at the stream end of a period.
PERIOD_SWITCH_STARTED
Triggered when a new stream (period) starts.
PLAYBACK_ENDED
Sent when playback completes.
PLAYBACK_ERROR
Sent when an error occurs. The element's error
attribute contains more information.
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
PLAYBACK_METADATA_LOADED
The media's metadata has finished loading; all attributes now
contain as much useful information as they're going to.
PLAYBACK_NOT_ALLOWED
Sent when playback is not allowed (for example if user gesture is needed).
PLAYBACK_PAUSED
Sent when playback is paused.
PLAYBACK_PLAYING
Sent when the media begins to play (either for the first time, after having been paused,
or after ending and then restarting).
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.
PLAYBACK_RATE_CHANGED
Sent when the playback speed changes.
PLAYBACK_SEEKED
Sent when a seek operation completes.
PLAYBACK_SEEKING
Sent when a seek operation begins.
PLAYBACK_STALLED
Sent when the video element reports stalled
PLAYBACK_STARTED
Sent when playback of the media starts after having been paused;
that is, when playback is resumed after a prior pause event.
PLAYBACK_TIME_UPDATED
The time indicated by the element's currentTime attribute has changed.
PLAYBACK_VOLUME_CHANGED
Sent when the video element reports that the volume has changed
PLAYBACK_WAITING
Sent when the media playback has stopped because of a temporary lack of data.
QUALITY_CHANGE_RENDERED
Triggered when the new ABR quality is being rendered on-screen.
QUALITY_CHANGE_REQUESTED
Triggered when an ABR up /down switch is initiated; either by user in manual mode or auto mode via ABR rules.
REPRESENTATION_SWITCH
Event that is dispatched whenever the player switches to a different representation
STREAM_ACTIVATED
Triggered when a stream (period) is activated
STREAM_DEACTIVATED
Triggered when a stream (period) is deactivated
STREAM_INITIALIZED
Triggered when a stream (period) is activated
STREAM_INITIALIZING
Triggered when a stream (period) is being loaded
STREAM_TEARDOWN_COMPLETE
Triggered when the player has been reset.
STREAM_UPDATED
Triggered when a stream (period) is loaded
TEXT_TRACK_ADDED
Triggered when a text track is added to the video element's TextTrackList
TEXT_TRACKS_ADDED
Triggered once all text tracks detected in the MPD are added to the video element.
THROUGHPUT_MEASUREMENT_STORED
Triggered when a throughput measurement based on the last segment request has been stored
TRACK_CHANGE_RENDERED
Triggered when the new track is being rendered.
TTML_PARSED
Triggered when a ttml chunk is parsed.
TTML_TO_PARSE
Triggered when a ttml chunk has to be parsed.