API Reference

VXDK provides a simple API to interact with the player. You can use the API to control the playback, listen to events, and get the current state of the player.

Methods

Events

The vxdk player emits various events that you can listen to and handle using the on method. To remove a listener, use the off method.

Usage

You can listen to events using the on method and specifying the event name or the enum value.

// Using the enum value
vxdk.on(PLAYBACK_EVENT.PLAYING, () => {
  console.log('Playback has started');
});
 
// Using the event name
vxdk.on('playback.ended', () => {
  console.log('Playback has ended');
});

Playback Events

These events are related to the playback state and progress of the media. The playback events will be prefixed with playback.. You can also use the PLAYBACK_EVENT enum to listen to these events.

Context Events

These events are related to the context state and configuration. The context events will be prefixed with context.. You can also use the CONTEXT_EVENT enum to listen to these events.

State

Vxdk provides an easy API to allow to get the current state of the playback. This is ideal for easy implementation on other front-end frameworks.

Use more specific event changes if you don't need the full state of VXDK.

Usage

You are able to get the current state of the player at any time.

vxdk.getState();

You can also listen for state changes.

vxdk.on(CONTEXT_EVENT.STATE_CHANGED, () => {
  console.log(vxdk.getState());
})
 

State data

The state data will contain the following properties:

../components/table