TextTrackButton

The base class for buttons that toggle specific text track types (e.g. subtitles)

Constructor

new TextTrackButton(player, optionsopt)
control-bar/text-track-controls/text-track-button.js, line 14

Creates an instance of this class.

Parameters:
Name Type Attributes Default Description
player Player

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

The key/value store of player options.

Extends

Methods

buildCSSClass() → {string}
menu/menu-button.js, line 126

Builds the default DOM className.

Returns:
string -

The DOM className for this object.

Inherited From:

createEl() → {Element}
menu/menu-button.js, line 114

Create the MenuButtonss DOM element.

Returns:
Element -

The element that gets created.

Inherited From:

createItems(itemsopt) → {Array.<TextTrackMenuItem>}
control-bar/text-track-controls/text-track-button.js, line 40

Create a menu item for each text track

Parameters:
Name Type Attributes Default Description
items Array.<TextTrackMenuItem> <optional>
 []

Existing array of items to use during creation
Returns:
Array.<TextTrackMenuItem> -

Array of menu items that were created

Overrides:

createMenu() → {Menu}
menu/menu-button.js, line 74

Create the menu and add all items to it.

Returns:
Menu -

The constructed menu

Inherited From:

disable() → {MenuButton}
menu/menu-button.js, line 252

Disable the MenuButton. Don't allow it to be clicked.

Returns:
MenuButton -

Returns itself; method can be chained.

Inherited From:

enable() → {MenuButton}
menu/menu-button.js, line 269

Enable the MenuButton. Allow it to be clicked.

Returns:
MenuButton -

Returns itself; method can be chained.

Inherited From:

handleClick(event)
menu/menu-button.js, line 150

Handle a click on a MenuButton. See ClickableComponent#handleClick for instances where this is called.

Parameters:
Name Type Description
event EventTarget~Event

The keydown, tap, or click event that caused this function to be called.
Listens to Events:
  • event:tap
  • event:click
Inherited From:

handleKeyPress(event)
menu/menu-button.js, line 175

Handle tab, escape, down arrow, and up arrow keys for MenuButton. See ClickableComponent#handleKeyPress for instances where this is called.

Parameters:
Name Type Description
event EventTarget~Event

The keydown event that caused this function to be called.
Listens to Events:
  • event:keydown
Inherited From:

handleSubmenuKeyPress(event)
menu/menu-button.js, line 206

Handle a keydown event on a sub-menu. The listener for this is added in the constructor.

Parameters:
Name Type Description
event EventTarget~Event

Key press event
Listens to Events:
  • event:keydown
Inherited From:

pressButton()
menu/menu-button.js, line 223

Put the current MenuButton into a pressed state.

Inherited From:

unpressButton()
menu/menu-button.js, line 236

Take the current MenuButton out of a pressed state.

Inherited From:

update()
menu/menu-button.js, line 42

Update the menu based on the current state of its items.

Inherited From: