Brightcove Player v5.22.2

Class: ChaptersTrackMenuItem

ChaptersTrackMenuItem

The chapter track menu item

new ChaptersTrackMenuItem(player [, options])

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.
Source:
control-bar/text-track-controls/chapters-track-menu-item.js

Extends

Methods

createEl( [type] [, props] [, attrs])

Create the `MenuItem's DOM element

Parameters:
Name Type Argument Default Description
type string <optional>
 li

Element's node type, not actually used, always set to li.
props Object <optional>
 {}

An object of properties that should be set on the element
attrs Object <optional>
 {}

An object of attributes that should be set on the element
Inherited From:
Source:
menu/menu-item.js
Returns:

The element that gets created.

Type
Element

handleClick( [event])

This gets called when an ChaptersTrackMenuItem is "clicked". See ClickableComponent for more detailed information on what a click can be.

Parameters:
Name Type Argument Description
event EventTarget~Event <optional>

The keydown, tap, or click event that caused this function to be called.
Overrides:
Source:
control-bar/text-track-controls/chapters-track-menu-item.js
Listens to Events:
  • event:tap
  • event:click

selected(selected)

Set the state for this menu item as selected or not.

Parameters:
Name Type Description
selected boolean

if the menu item is selected or not
Inherited From:
Source:
menu/menu-item.js

update( [event])

Update chapter menu item

Parameters:
Name Type Argument Description
event EventTarget~Event <optional>

The cuechange event that caused this function to run.
Source:
control-bar/text-track-controls/chapters-track-menu-item.js
Listens to Events:
  • TextTrack#event:cuechange