Methods

The Blue Billywig Player API exposes a wide range of methods. The list below covers all methods that can be called on the player API object.

1.0 | Transport

1.1 | on(eventType, handler)

Attach an event handler for events fired by the player, in the same way as jQuery’s .on() does.

1.2 | off(eventType)

Detach an event handler from events fired by the player. Please refer to the jQuery documentation for more information.

1.3 | load(params)

Load a clip.

1.4 | play(userAction)

Play the loaded video.

1.5 | pause()

Pause the video.

1.6 | seek(positionInSeconds)

Seek the video to a specific position.

2.0 | Setters

2.1 | setVolume(volume)

Set the master volume, including any Picture-in-Picture widgets on the timeline.

2.2 | setMuted(muted, reserved, userAction)

Set the master mute state, including any Picture-in-Picture widgets on the timeline.

2.3 | setProgramVolume(volume)

Set the volume for the main video only.

2.4 | setAsset(assetId)

Switch the asset for the current video.

2.5 | setFitMode(fitMode)

Fit mode settings determine how video content fits within the player when the aspect ratios differ. Read more about Fit mode settings.

2.6 | setLocalStorageItem(key, value)

Write an entry to LocalStorage, if permitted by the current cookie settings.

2.7 | setSubtitle(subtitleId)

Set the active subtitle track.

2.8 | setInView(inView)

Override the player’s in-view state.

2.9 | setRelatedItems(items)

Override the related items shown in the player.

playerAPI.setRelatedItems([
    { id: "1234567" },
    { id: "9876543" },
    { id: "3456789" }
]);

3.0 | Getters A – C

3.1 | getAssets()

Returns an array of asset objects available for the current clip on the current device.

3.2 | getBuffered()

Returns the buffered ranges of the main clip. Multiple ranges can be buffered as a result of seeking.

var buffered = playerAPI.getBuffered();

for (var i = 0; i < buffered.length; i++) {
    var start = buffered.start[i];
    var end = buffered.end[i];
}

3.3 | getCastSource()

Returns the source URL for casting.

3.4 | getChapterList()

Returns an array of chapter objects set for the current clip in the Timeline editor.

3.5 | getClipData()

Returns all data for the current clip. Use the browser console to inspect the returned object:

console.log(playerAPI.getClipData());

if (typeof clipData.title !== 'undefined') {
    setTitle(clipData.title);
}

3.6 | getContentLayer()

Returns the content layer DOM element. Useful when resizing the content area (video, timeline, and subtitles) to show a description panel or related clips.

3.7 | getCurrentAsset()

Returns an object describing the currently active asset.

3.8 | getCurrentSubtitle()

Returns an object describing the currently active subtitle track.

3.9 | getCurrentSubtitleLine()

Returns the currently displayed subtitle line.

3.10 | getCurrentTime()

Returns the current playback position of the main clip.

4.0 | Getters D – L

4.1 | getDeeplink()

Returns the deep link of the current clip as configured in the VMS.

4.2 | getDetections()

Returns the detections object. Refer to the detections documentation for available properties and methods.

4.3 | getDuration()

Returns the duration of the main clip.

4.4 | getEmbedcode([width], [height])

Returns the embed code for the current clip, with an optional width and height override.

4.5 | isFullscreen()

Returns whether the player is currently in fullscreen mode.

4.6 | getLocalStorageItem(key)

Returns the value of a LocalStorage entry.

4.7 | getLogo()

Returns the logo configuration for the active playout.

5.0 | Getters M – R

5.1 | getMode()

Returns the current mode of the player.

5.2 | getMuted()

Returns the current master mute state.

5.3 | getPhase()

Returns the current phase of the player.

5.4 | isPlaying()

Returns whether the player is currently playing.

5.5 | getPlayoutData()

Returns all playout settings from the VMS. Similar to getClipData(), but returns playout-level data.

5.6 | getProjectData()

Returns all project metadata. Similar to getClipData(), but returns project-level data.

5.7 | getRelatedClips()

Returns an array of clip objects related to the active clip.

6.0 | Getters S – Z

6.1 | getSharing()

Returns an array of social sharing objects for the current clip.

6.2 | getSkinLayer()

Returns the skin container DOM element. Useful for finding HTML elements within the player skin.

6.3 | getSubtitleLayer()

Returns the subtitle layer DOM element. Useful when implementing custom subtitle rendering in the skin.

6.4 | getSubtitlesList()

Returns an array of subtitle track objects for the current clip.

6.5 | getThumbnail(clipId, [width], [height])

Returns a URL to the thumbnail for a specified clip, optionally at a given size.

6.6 | getVolume()

Returns the current master volume. Use this after a volumechange event to read the updated value.

playerAPI.on('volumechange', function(){
    var volume = playerAPI.getVolume();
});

playerAPI.setVolume(0.5);

6.7 | getWrapper()

Returns the player wrapper DOM element.

7.0 | Interface

7.1 | showInterfaceElement(elementName)

Shows the specified interface element. Available elements:

• controlBar
• playPauseButton
• progressBar
• timeDisplay
• muteButton
• volumeSlider
• languageButton
• hdButton
• fullscreenButton
• shareButton

7.2 | hideInterfaceElement(elementName)

Hides the specified interface element.

7.3 | enableInterfaceElement(elementName)

Enables the specified interface element.

7.4 | disableInterfaceElement(elementName)

Disables the specified interface element.

7.5 | showCastTargetPicker(type)

Shows the cast target picker, if available.

8.0 | Miscellaneous

8.1 | fullscreen()

Enter fullscreen mode.

8.2 | retractFullscreen()

Exit fullscreen mode.

8.3 | toggleFullscreen()

Enters fullscreen mode when the player is not fullscreen, and exits fullscreen when it is.

8.4 | playAdTag(params)

Instructs the player to request and play an ad tag. When params.phase is set to "PRE" or "POST", the player requests the tag the next time it enters that phase. If multiple playAdTag calls are made for the same phase, the player works through each tag in order until one fills, then clears all tags for that phase.

When params.phase is "MAIN", the player will either:

• Request the tag immediately and interrupt the content if it is currently in the MAIN phase and no time parameter was provided.
• Schedule the request at the specified time offset and interrupt content when that offset is reached.
• Schedule the request and interrupt content the moment the player starts playing, if it is not yet in the MAIN phase.

Returns true if the request was successfully scheduled, false otherwise.

8.5 | destruct()

Destructs the player, freeing up memory and removing its elements from the DOM.