Enumeration PlayerEventType

An enumeration describing general events sent from the Player.

To listen to events, use Player.addEventListener.

Events

AUDIO_BLOCKED: "PlayerAudioBlocked"

Indicates that the browser blocked unmuted playback. This behavior is based on the user's policy and can occur if the play request was made without a user gesture. To start playback, mute and play or wait for a user gesture.

Param: payload

void

BUFFER_UPDATE: "PlayerBufferUpdate"

Indicates that the buffer size changed. This can be caused by an addition to or removal from the buffer.

DURATION_CHANGED: "PlayerDurationChanged"

Indicates that source duration changed (or is available for the first time). This can occur after the PlayerState.READY state, to indicate a change in the duration of the media. This value can be set to Infinity or a large integer (1 << 30) for streams of unknown or indefinite length.

Updated

Player.getDuration

Param: payload

number The updated duration, in seconds.

ERROR: "PlayerError"

Indicates that an error occurred. Errors are fatal and stop playback of the stream. The player moves into PlayerState.IDLE on fatal errors.

Param: payload

PlayerError

INITIALIZED: "PlayerInitialized"

Indicates that the player was created.

Updated

Player.getVersion

Param: payload

void

MUTED_CHANGED: "PlayerMutedChanged"

Indicates that the player was muted or unmuted.

Updated

Player.isMuted

Param: payload

void

NETWORK_UNAVAILABLE: "PlayerNetworkUnavailable"

Indicates that a playback unavailable event occurred.

Param: payload

void

PLAYBACK_BLOCKED: "PlayerPlaybackBlocked"

Indicates that playback is blocked from autoplaying; that is, without a user gesture. This event can fire when autoplay with sound is blocked or all autoplay is blocked. To start playback, mute and play, or wait for a user gesture.

Param: payload

void

PLAYBACK_RATE_CHANGED: "PlayerPlaybackRateChanged"

Indicates that the playback rate changed.

Updated

Player.getPlaybackRate

Param: payload

number The updated playback rate.

QUALITY_CHANGED: "PlayerQualityChanged"

Indicates that the playing quality changed from either a user action or an internal adaptive-quality switch.

Updated

Player.getQuality

Param: payload

Quality

REBUFFERING: "PlayerRebuffering"

Indicates that the player is buffering from a previous PlayerState.PLAYING state. Excludes user actions such as seeking, starting, or resuming the stream.

Param: payload

void

SEEK_COMPLETED: "PlayerSeekCompleted"

Indicates that the player seeked to a given position (as requested by Player.seekTo).

Updated

Player.getPosition

Param: payload

number The position where the seek completed, in seconds.

SYNC_TIME_UPDATE: "PlayerSyncTimeUpdate"

Indicates that the player syncTime changed.

Updated

Player.getSyncTime

Param: payload

number The updated syncTime of the player, in milliseconds.

TEXT_CUE: "PlayerTextCue"

Indicates that a text cue was parsed from the stream.

Param: payload

TextCue

TEXT_METADATA_CUE: "PlayerTextMetadataCue"

Indicates that text metadata cues were parsed from the stream.

Param: payload

TextMetadataCue

TIME_UPDATE: "PlayerTimeUpdate"

Indicates that the player position changed.

Updated

Player.getPosition

Param: payload

number The updated position of the player, in seconds.

VOLUME_CHANGED: "PlayerVolumeChanged"

Indicates that the player volume changed. Volume value can be between 0 and 1, inclusive.

Updated

Player.getVolume

Param: payload

number The updated volume, between 0.0f and 1.0f.