Event API

You can use events documented here to listen for state changes to Fluid Player once it has been initialized.

You can bind to events as shown in the example below.

var player = fluidPlayer('video-id');

player.on('play', function() {
  //... Your code here
});

player.on('pause', function() {
  //... Your code here
});

Additional Information

For every event fired by Fluid Player, an additional argument is added as the last argument of the callback function. This argument contains information about the player's state at the moment the event occurred.

Example with all possible values:

player.on('play', function(additionalInfo) {
  const {
    mediaSourceType,  // Possible values: 'source' for your main video source, and 'preRoll', 'midRoll', 'postRoll' for Linear ad playback.
  } = additionalInfo;
});

By listening to mediaSourceType, you can bind specific behavior to events on the main video or linear ads, such as pre-rolls, mid-rolls, or post-rolls. Each event will also return all information from the JavaScript event in the additional info.

Events

play

The on('play', function(additionalInfo){}) can be used to handle the play event for the Fluid Player.

player.on('play', function(additionalInfo){ console.log('Video is playing'); });

playing

The on('playing', function(event, additionalInfo){}) can be used to handle the playing event for the Fluid Player.

player.on('playing', function(event, additionalInfo){ console.log('Video is now playing'); });

pause

The on('pause', function(additionalInfo){}) can be used to handle the pause event for the Fluid Player.

player.on('pause', function(additionalInfo){ console.log('Video is now paused'); });

ended

The on('ended', function(additionalInfo){}) can be used to handle the ended for the Fluid Player.

player.on('ended', function(additionalInfo){ console.log('Video is now ended'); });

seeked

The on('seeked', function(additionalInfo){}) can be used to handle the seeked for the Fluid Player.

player.on('seeked', function(additionalInfo){ console.log('Video is now seeked'); });

theatreModeOn

The on('theatreModeOn', function(event, additionalInfo){}) can be used to execute specific functionality when theatre mode is enabled.

player.on('theatreModeOn', function(event, additionalInfo){ console.log('Theatre mode is enabled'); });

theatreModeOff

The on('theatreModeOff', function(event, additionalInfo){}) can be used to execute specific functionality when theatre mode is disabled.

player.on('theatreModeOff', function(event, additionalInfo){ console.log('Theatre mode is disabled'); });

timeupdate

Fluid Player emits timeupdate event when the time indicated by the currentTime attribute of the HTML5 player has been updated.

The event frequency is dependent on the system load, but will be thrown between about 4Hz and 66Hz (assuming the event handlers don't take longer than 250ms to run).

This event receives 1 argument - current time position of the main video content.

player.on('timeupdate', function(time, additionalInfo){ console.log(time); });

miniPlayerToggle

Triggers a CustomEvent when the Mini Player is toggled on or off. The isToggledOn property holds the new state of the Mini Player.

player.on('miniPlayerToggle', function (event, additionalInfo) { console.log(event.detail.isToggledOn) });