Skip to main content

Player Events Reference

Playback Events

CAN_PLAY

Payload: lura.events.LuraEvent<void>

The canplay event is fired when the user agent can play the media, but estimates that not enough data has been loaded to play the media up to its end without having to stop for further buffering of content.

CAN_PLAY_THROUGH

Payload: lura.events.LuraEvent<void>

The canplaythrough event is fired when the user agent can play the media, and estimates that enough data has been loaded to play the media up to its end without having to stop for further buffering of content.

DURATION_CHANGE

Payload: lura.events.LuraEvent<{duration: number}>

The durationchange event is fired when the duration attribute has been updated.

EMPTIED

Payload: lura.events.LuraEvent<void>

The emptied event is fired when the media has become empty; for example, this event is sent if the media has already been loaded (or partially loaded), and the load() method is called to reload it.

ENDED

Payload: lura.events.LuraEvent<void>

The ended event is fired when playback or streaming has stopped because the end of the media was reached or because no further data is available.

LOADED_DATA

Payload: lura.events.LuraEvent<void>

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

LOADED_METADATA

Payload: lura.events.LuraEvent<void>

The loadedmetadata event is fired when the metadata has been loaded.

PAUSE

Payload: lura.events.LuraEvent<void>

The pause event is fired when the paused property is changed from false to true

PLAY

Payload: lura.events.LuraEvent<void>

The play event is fired when the paused property is changed from true to false, as a result of the play method, or the autoplay attribute.

PLAYING

Payload: lura.events.LuraEvent<void>

The playing event is fired after playback is first started, and whenever it is restarted. For example it is fired when playback resumes after having been paused or delayed due to lack of data.

PROGRESS

Payload: lura.events.LuraEvent<void>

The progress event is fired periodically as the browser loads a resource.

RATE_CHANGE

Payload: lura.events.LuraEvent<{playbackSpeed: number}>

The ratechange event is fired when the playback rate has changed.

SEEKING

Payload: lura.events.LuraEvent<void>

The seeking event is fired when a seek operation starts, meaning the Boolean seeking attribute has changed to true and the media is seeking a new position.

STALLED

Payload: lura.events.LuraEvent<void>

The stalled event is fired when the user agent is trying to fetch media data, but data is unexpectedly not forthcoming.

SUSPEND

Payload: lura.events.LuraEvent<void>

The suspend event is fired when media data loading has been suspended.

TIME_UPDATE

Payload: lura.events.LuraEvent<{time: number}>

The timeupdate event is fired when the time indicated by the currentTime attribute has been updated.

VOLUME_CHANGE

Payload: lura.events.LuraEvent<{volume: number, muted: boolean}>

The volumechange event is fired when the volume has changed.

WAITING

Payload: lura.events.LuraEvent<void>

The waiting event is fired when playback has stopped because of a temporary lack of data.

Lura Status Indicator Events

MANIFEST_LOADED

Payload: lura.events.LuraEvent<void>

Event fired when the video manifest has been loaded

MUTED_AUTOPLAY_FORCED

Payload: lura.events.LuraEvent<void>

Event fired when the device forced lura player to autoplay muted

NATIVE_TIME_UPDATE

Payload: lura.events.LuraEvent<{nativeTime: number}>

Event fired when the current playback position changed including serverside ads

PREVIEW_MATRIX_LOADED

Payload: lura.events.LuraEvent<{lura.base.PreviewMatrix}>

Event fired when the preview images of the video is loaded

PAUSE_REQUESTED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when the lura player requests the third party plugin to pause.

PLAY_REQUESTED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when the lura player requests the third party plugin to pause.

VARIANT_CHANGED

Payload: lura.events.LuraEvent<void>

Event fired when the variants are changed

VARIANTS_LOADED

Payload: lura.events.LuraEvent<void>

Event fired when the variants are loaded

VIDEO_METADATA_UPDATED

Payload: lura.events.LuraEvent<lura.metadata.VideoMetadata>

Event fired when the video metadata is updated

REPLAY

Payload: lura.events.LuraEvent<void>

Event fired when the video replays

Cue Manager Events

CUE_ADDED

Payload: lura.events.LuraEvent<lura.interstitials.Cue>

Event fired when a new cue is added to the lura player

CUE_ENTER

Payload: lura.events.LuraEvent<lura.interstitials.Cue>

Event fired when the player entered a cue.

CUE_UPDATED

Payload: lura.events.LuraEvent<lura.interstitials.Cue>

Event fired when a cue data is updated

CUE_EXIT

Payload: lura.events.LuraEvent<lura.interstitials.Cue>

Event fired when the player exits the cue

Caption Manager Events

CAPTION_SELECTED

Payload: lura.events.LuraEvent<lura.tracks.Caption>

Event fired when a caption is selected in the lura player

CAPTION_ATTACHED

Payload: lura.events.LuraEvent<lura.tracks.Caption>

Event fired when a new caption is attached to the lura player

CAPTION_CUE_CHANGED

Payload: lura.events.LuraEvent<lura.tracks.Caption>

Event fired when a caption cue is changed in the lura player

CAPTION_LOAD_FAILED

Payload: lura.events.LuraEvent<lura.tracks.Caption>

Event fired when a caption load fails in the lura player

Audio Track Events

AUDIO_TRACKS_UPDATED

Payload: lura.events.LuraEvent<lura.tracks.Audio[]>

Event fired when the list of audio tracks have been updated

AUDIO_TRACK_LOADED

Payload: lura.events.LuraEvent<lura.tracks.Audio>

Event fired when an audio track has been loaded

AUDIO_TRACK_SWITCHED

Payload: lura.events.LuraEvent<lura.tracks.Audio>

Event fired when an audio track is switched

AUDIO_TRACK_SWITCHING

Payload: lura.events.LuraEvent<lura.tracks.Audio>

Event fired when an audio track is switching

AUDIO_TRACK_SELECTED

Payload: lura.events.LuraEvent<lura.tracks.Audio>

Event fired when an audio track is selected

Casting Events

CASTING_REQUESTED

Payload: lura.events.LuraEvent<lura.casting.Cast>

Event fired when casting is requested in the video player

CASTING_STARTED

Payload: lura.events.LuraEvent<lura.casting.Cast>

Event fired when casting is started in the video player

CASTING_ENDED

Payload: lura.events.LuraEvent<lura.casting.Cast>

Event fired when casting is ended in the video player

Ad Events

AD_IMPRESSION

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad is displayed in the video player

AD_BREAK_STARTED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad break begins to play in the video player

AD_STARTED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an individual ad begins to play in the video player

AD_FIRST_QUARTILE

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad has reached the first quarter of its duration

AD_MIDPOINT

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad has reached its midpoint

AD_THIRD_QUARTILE

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad has reached the third quarter of its duration

AD_COMPLETED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an individual ad has completed playing in the video player

AD_BREAK_COMPLETED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad break is completed

AD_PAUSED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad is paused by the user or programmatically

AD_RESUMED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad is resumed by the user or programmatically

AD_CLICKED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when the user clicks on an ad in the video player

AD_SKIPPED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when an ad is skipped by the user

AD_VOLUME_CHANGED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when the volume of the player is changed during an ad

AD_STOPPED

Payload: lura.events.LuraEvent<lura.interstitials.AdCue>

Event fired when the ad is discarded.

Timed Metadata Events

TIMED_METADATA

Payload: lura.events.LuraEvent<{[key: string]: string}>

Triggers after metadata associated with the stream is found

DASH_TIMED_METADATA

Payload: lura.events.LuraEvent<{event: string, detail: {schemeIdUri: string, eventElement: Element, startTime: number}}>

Fired when a media timeline region is added