Introduction

This article provides a reference to all available JWX JavaScript API calls.

💡

You can use the following resources to help you understand, implement, and explore examples of the JW8 JavaScript API.

For an introduction to JW8's API, read our JavaScript API overview.

For more in-depth instructions on implementation, see read Add a web player to a site.

To see example code for each API call, visit our JWX Demos and search by call.

The events in this reference use the on listener. However, it is also possible to register or remove each event with on, once, or off, or register custom events with trigger.

The following timeline illustrates the core subset of events, in chronological order, that are fired by a player configured to play on-demand videos with captions, audio tracks, casting, and advertising. The event order and the events that fire may differ for players configured differently.

893 — Core subset of events, in a timeline, fired for a player that has been configured to play on-demand videos, with captions, audio tracks, casting, and advertising

Events Index

The following table lists all the available events organized by category.

SETUP
.on('ready')	.on('remove')	.on('setupError')
ALL
.on('all')
ADVERTISING
.on('adBidRequest') .on('adBidResponse') .on('adBlock') .on('adBreakEnd') .on('adBreakIgnored') .on('adBreakStart') .on('adClick') .on('adCompanions') .on('adComplete') .on('adError')	.on('adImpression') .on('adItem') .on('adLoaded') .on('adManager') .on('adMeta') .on('adPause') .on('adPlay') .on('adRequest') .on('adRequestedContentResume') .on('adSchedule')	.on('adLoadedXML') .on('adSkipped') .on('adStarted') .on('adTime') .on('adViewableImpression') .on('adWarning') .on('adsManager') .on('beforeComplete') .on('beforePlay')
AUDIO TRACKS
.on('audioTrackChanged')	.on('audioTracks')
BUFFER
.on('bufferChange')
CAPTIONS
.on('captionsChanged')	.on('captionsList')
CAST
.on('cast')	.on('castIntercepted')
CONTROLS
.on('controls')	.on('displayClick')
FLOATING PLAYER
.on('float')
METADATA
.on('meta')	.on('metadataCueParsed')
PLAYBACK
.on('autostartNotAllowed') .on('buffer') .on('complete') .on('error')	.on('firstFrame') .on('idle') .on('pause') .on('play')	.on('playAttemptFailed') .on('playbackRateChanged') .on('warning')
PLAYLIST
.on('nextClick') .on('playlist')	.on('playlistItem')	.on('playlistComplete')
QUALITY
.on('levels')	.on('levelsChanged')	.on('visualQuality')
RELATED
.on('relatedReady') ("related").on('close')	("related").on('open')	("related").on('play')
RESIZE
.on('fullscreen')	.on('resize')
SEEK
.on('absolutePositionReady') .on('seek')	.on('seeked')	.on('time')
SHARING
("sharing").on('click')	("sharing").on('close')	("sharing").on('open')
VIEWABILITY
.on('containerViewable')	.on('viewable')
VOLUME
.on('mute')	.on('volume')