Methods

The Blue Billywig Player API has many functionalities. The list below shows all the methods that can be called on by the player API object.

1.0 | Transport

1.1 | on(eventType, handler)

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

1.2 | off(eventType)

Detach an event handler method from events thrown 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.

2.0 | Setters

2.1 | setVolume(volume)

Set the master volume (including timeline Picture in picture widgets).

2.2 | setMuted(muted, reserved, userAction)

Set the master mute state (including timeline Picture in picture widgets).

2.3 | setProgramVolume(volume)

Set the volume for the main video.

2.4 | setAsset(assetId)

Switch the asset for the current video.

2.5 | setFitMode(fitMode)

Change the way video is fitted inside the player.

2.6 | setLocalStorageItem(key, value)

Change an entry in LocalStorage, if permitted by cookie settings

2.7 | setSubtitle(subtitleId)

Sets the subtitle.

2.8 | setInView(inView)

Sets in-view state.

2.9 | setRelatedItems(items)

Sets related items.

3.0 | Getters A – C

3.1 | getAssets()

Returns an array containing (multiple) asset objects which can be used on the current device.

3.2 | getBuffered()

Returns the buffered parts of the main clip. Different parts of the video can be buffered as a result of seeking.

var buffered = playerAPI.getBuffered();
// Loop through all the buffered parts
for (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.

3.5 | getClipData()

Returns all the data for the current clip. Please refer to the actual Player API to view the returned contents, this can be done with the following lines of Javascript and the Firefox / Chrome Developer Console:

console.log(playerAPI.getClipData());

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

3.6 | getContentLayer()

Returns the content layer. This can be useful when you want to resize the content (video + timeline + subtitles) inside the player to show a description or related clips.

3.7 | getCurrentAsset()

Returns an object containing information about the currently used asset.

3.8 | getCurrentSubtitle()

Returns an object containing information about the currently used subtitle.

3.9 | getCurrentSubtitleLine()

Returns the active subtitle line.

3.10 | getCurrentTime()

Returns the current time of the main clip.

4.0 | Getters D – L

4.1 | getDeeplink()

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

4.2 | getDetections()

Please refer to the detections documentation for available commands and variables.

4.3 | getDuration()

Returns the duration of the main clip.

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

Returns the embedcode with an optionally specified width and height to override the playout width and height.

4.5 | isFullscreen()

Returns the fullscreen state of the player.

4.6 | getLocalStorageItem(key)

Returns the value of LocalStorage entry key.

4.7 | getLogo()

Returns the logo of the active playout.

5.0 | Getters M – R

5.1 | getMode()

Returns the current mode of the player. The following modes are possible:

5.2 | getMuted()

Returns the current master muted state.

5.3 | getPhase()

Returns the current phase of the player.

5.4 | isPlaying()

Returns the playing state of the player.

5.5 | getPlayoutData()

Returns all the playout settings from the VMS. The operation of this method is similar to the getClipData() method, but returns a different set of data.

5.6 | getProjectData()

Returns all the project meta data. The operation of this method is similar to the getClipData() method, but returns a different set of 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 with objects containing social sharing details.

6.2 | getSkinLayer()

Get the skin layer. This can be useful to find HTML DOM elements.

6.3 | getSubtitleLayer()

Returns the subtitle layer. This can be useful when custom subtitles are implemented in the skin.

6.4 | getSubtitlesList()

Returns an array containing (multiple) subtitle objects related to the current clip.

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

Returns a URL to the thumbnail for the specified clip with specified dimensions.

6.6 | getVolume()

Returns the current master volume. This method can be used when the volumechange event is fired to get the current player volume.

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

6.7 | getWrapper()

Pause the video

7.0 | Interface

7.1 | showInterfaceElement(elementName)

Shows the specified element. Available elements are:

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

7.2 | hideInterfaceElement(elementName)

Hides the specified element.

7.3 | enableInterfaceElement(elementName)

Enables the specified element.

7.4 | disableInterfaceElement(elementName)

Disables the specified 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 mode when the player is fullscreen.

8.4 | increaseSizerRate()

A 100% width and height player automaticly resizes to the parent element, but needs to manually poll the size of the parent element. To achieve a smoother animation when resizing the parent element, this method can be called before the animation.

8.5 | decreaseSizerRate()

Decrease the rate of the sizer described above. Decreasing the rate improves the overall performance of Javascript on the page.

8.6 | destruct()

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