Interface PlayerEvents

Defines the events that the player can emit, and their event data.

interface PlayerEvents {
    durationchange: { duration: number };
    ended: void;
    error: ErrorEventData;
    loadedmetadata: void;
    pause: void;
    play: void;
    ready: { channelId: undefined | string; playerId: string; videoId: string };
    timeupdate: { time: number };
}

Properties

durationchange ended error loadedmetadata pause play ready timeupdate

Properties

durationchange

durationchange: { duration: number }

Fired when the duration of the video has changed.

ended

ended: void

Fired when the media has ended.

error

error: ErrorEventData

Fired when an error occurs.

loadedmetadata

loadedmetadata: void

Triggered when the video metadata has been loaded.

pause

pause: void

Fired when the media has been paused.

play

play: void

Indicates that playback has started or resumed.

ready

ready: { channelId: undefined | string; playerId: string; videoId: string }

Fired when the player iframe is ready to receive commands. Usually this event doesn't need to be handled, since all player methods wait for the player to be ready before executing.

timeupdate

timeupdate: { time: number }

Fired when the current playback position has changed.

Settings

Member Visibility

On This Page

Properties