Amazon IVS Player
    Preparing search index...

    Enumeration PlayerEventType

    An enumeration describing general events sent from the Player.

    To listen to events, use Player.addEventListener.

    Index

    Events

    AD_BREAK_ENDED AD_BREAK_STARTED AD_CREATIVE_ENDED AD_CREATIVE_STARTED AD_TIME_UPDATE AUDIO_BLOCKED BUFFER_UPDATE DURATION_CHANGED ERROR INITIALIZED MUTED_CHANGED NETWORK_UNAVAILABLE PLAYBACK_BLOCKED PLAYBACK_RATE_CHANGED QUALITY_CHANGED REBUFFERING SEEK_COMPLETED SYNC_TIME_UPDATE TEXT_CUE TEXT_METADATA_CUE TEXT_TRACK_CHANGED TEXT_TRACKS_CHANGED TIME_UPDATE VOLUME_CHANGED

    Events

    AD_BREAK_ENDED: "PlayerAdBreakEnded"

    Indicates that an ad break has ended.

    AdBreak

    AD_BREAK_STARTED: "PlayerAdBreakStarted"

    Indicates that an ad break has started.

    AdBreak

    AD_CREATIVE_ENDED: "PlayerAdCreativeEnded"

    Indicates that an ad creative has ended.

    AdCreative

    AD_CREATIVE_STARTED: "PlayerAdCreativeStarted"

    Indicates that an ad creative has started.

    AdCreative

    AD_TIME_UPDATE: "PlayerAdTimeUpdate"

    Provides progress tracking during ad playback.

    AdTimeUpdate

    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.

    void

    BUFFER_UPDATE: "PlayerBufferUpdate"

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

    Player.getPosition Player.getBufferDuration Player.getBuffered

    void

    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.

    Player.getDuration

    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.

    PlayerError

    INITIALIZED: "PlayerInitialized"

    Indicates that the player was created.

    Player.getVersion

    void

    MUTED_CHANGED: "PlayerMutedChanged"

    Indicates that the player was muted or unmuted.

    Player.isMuted

    void

    NETWORK_UNAVAILABLE: "PlayerNetworkUnavailable"

    Indicates that a playback unavailable event occurred.

    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.

    void

    PLAYBACK_RATE_CHANGED: "PlayerPlaybackRateChanged"

    Indicates that the playback rate changed.

    Player.getPlaybackRate

    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.

    Player.getQuality

    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.

    void

    SEEK_COMPLETED: "PlayerSeekCompleted"

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

    Player.getPosition

    number The position where the seek completed, in seconds.

    SYNC_TIME_UPDATE: "PlayerSyncTimeUpdate"

    Indicates that the player syncTime changed.

    Player.getSyncTime

    number The updated syncTime of the player, in milliseconds.

    TEXT_CUE

    TEXT_CUE: "PlayerTextCue"

    Indicates that a text cue was parsed from the stream.

    TextCue

    TEXT_METADATA_CUE

    TEXT_METADATA_CUE: "PlayerTextMetadataCue"

    Indicates that text metadata cues were parsed from the stream.

    TextMetadataCue

    BetaTEXT_TRACK_CHANGED

    TEXT_TRACK_CHANGED: "PlayerTextTrackChanged"

    Note: This API is experimental and may change in a future release.

    Indicates that the selected text track changed, either from a user action or auto-selection based on preferred languages.

    Player.getTextTrack

    IVSTextTrack | null

    BetaTEXT_TRACKS_CHANGED

    TEXT_TRACKS_CHANGED: "PlayerTextTracksChanged"

    Note: This API is experimental and may change in a future release.

    Indicates that the available text tracks have changed. Only fires when the text track list changes during playback. To get the initial text track list, call getTextTracks() on READY.

    Player.getTextTracks

    []

    TIME_UPDATE: "PlayerTimeUpdate"

    Indicates that the player position changed.

    Player.getPosition

    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.

    Player.getVolume

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

    Settings

    Member Visibility

    On This Page

    Events