Playback Events

These API calls are used to retrieve and change the current playback state of the player.

.on('autostartNotAllowed')

{
    "code": 303220,
    "error": "The play method is not allowed by the user agent or the platform in the current context, possibly because the user denied permission.",
    "reason": "autoplayDisabled",
    "type": "autostartNotAllowed"
}

Fired when the player is configured to autostart but the browser's settings are preventing it.

Returns an object with the following:

.on('play')

Fired when the player enters the playing state


The play event fires when non-advertising media within the player begins playback. To listen for an ad break play event, use .on('adPlay').

Returns an object with the following:

.on('pause')

Fired when the player enters the paused state


The pause event fires when non-advertising media within the player is paused. To listen for an ad break pause event, use .on('adPause').

Returns an object with the following:

.on('playAttemptFailed')

Fired when playback is aborted or blocked. A failed play attempt does not result in a play. Pausing the video or changing the media results in play attempts being aborted. In mobile browsers play attempts are blocked when not started by a user gesture.

Returns an object with the following:

.on('buffer')

Fired when the player starts playback and when the player enters a buffering state.

Returns an object with the following:

.on('idle')

Fired when the player enters the idle state.

Returns an object with the following:

.on('complete')

Fires each time the end of a video is reached.

This does not fire if the viewer advances playlist items prior to the end of a video, or if next() is called.

.on('firstFrame')

Use this to determine the period of time between a user pressing play and the same user viewing their content. Triggered by a video's first frame event (or the instant an audio file begins playback). This event pinpoints when content playback begins.

Returns an object with the following:

.on('error')

Signals a critical error in the playback process.

Returns an object with the following:

.on('warning')

Signals a failure that is not critical to the setup or playback process.

Returns an object with the following:

.on('playbackRateChanged')

Fired when the playback rate has been changed.

Returns an object with the following: