Brightcove Player v5.22.2

Class: CaptionsButton

CaptionsButton

The button component for toggling and selecting captions

new CaptionsButton(player [, options] [, ready])

Creates an instance of this class.

Parameters:
Name Type Argument Description
player Player

The Player that this class should be attached to.
options Object <optional>

The key/value store of player options.
ready Component~ReadyCallback <optional>

The function to call when this component is ready.
Source:
control-bar/text-track-controls/captions-button.js

Extends

Methods

buildCSSClass()

Builds the default DOM className.

Source:
control-bar/text-track-controls/captions-button.js
Returns:

The DOM className for this object.

Type
string

createItems()

Create caption menu items

Overrides:
Source:
control-bar/text-track-controls/captions-button.js
Returns:

The array of current menu items.

Type
Array.<CaptionSettingsMenuItem>