DescriptionsButton(player, optionsopt, readyopt)

The button component for toggling and selecting descriptions

new DescriptionsButton(player, optionsopt, readyopt)

Creates an instance of this class.

Parameters:
Name Type Attributes 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.

Extends

Methods

buildCSSClass() → {string}

Builds the default DOM className.

Returns:
string -

The DOM className for this object.

createItems(itemsopt) → {Array.<TextTrackMenuItem>}

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

Inherited From:

handleTracksChange(event)

Handle text track change

Parameters:
Name Type Description
event EventTarget~Event

The event that caused this function to run

Listens to Events: