Extends

• MenuButton

Methods

buildCSSClass() → {string}

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 61

Builds the default DOM className.

Returns:

string -

The DOM className for this object.

Overrides:

• MenuButton#buildCSSClass

createEl() → {Element}

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 42

Create the Component's DOM element

Returns:

Element -

The element that was created.

Overrides:

• MenuButton#createEl

abstract createItems()

menu/menu-button.js, line 106

Create the list of menu items. Specific to each subclass.

Inherited From:

• MenuButton#createItems

createMenu() → {Menu}

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 71

Create the playback rate menu

Returns:

Menu -

Menu object populated with PlaybackRateMenuItems

Overrides:

• MenuButton#createMenu

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:

• MenuButton#disable

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:

• MenuButton#enable

handleClick(eventopt)

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 105

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

Parameters:

Name	Type	Attributes	Description
event	EventTarget~Event	<optional>	The keydown, tap, or click event that caused this function to be called.

Listens to Events:

• event:tap
• event:click

Overrides:

• MenuButton#handleClick

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:

• MenuButton#handleKeyPress

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:

• MenuButton#handleSubmenuKeyPress

playbackRates() → {Array}

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 128

Get possible playback rates

Returns:

Array -

All possible playback rates

playbackRateSupported() → {boolean}

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 139

Get whether playback rates is supported by the tech and an array of playback rates exists

Returns:

boolean -

Whether changing playback rate is supported

pressButton()

menu/menu-button.js, line 223

Put the current MenuButton into a pressed state.

Inherited From:

• MenuButton#pressButton

unpressButton()

menu/menu-button.js, line 236

Take the current MenuButton out of a pressed state.

Inherited From:

• MenuButton#unpressButton

update()

menu/menu-button.js, line 42

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

Inherited From:

• MenuButton#update

updateARIAAttributes()

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 89

Updates ARIA accessibility attributes

updateLabel(eventopt)

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 171

Update button label when rate changed

Parameters:

Name	Type	Attributes	Description
event	EventTarget~Event	<optional>	The event that caused this function to run.

Listens to Events:

• Player#event:ratechange

updateVisibility(eventopt)

control-bar/playback-rate-menu/playback-rate-menu-button.js, line 155

Hide playback rate controls when they're no playback rate options to select

Parameters:

Name	Type	Attributes	Description
event	EventTarget~Event	<optional>	The event that caused this function to run.

Listens to Events:

• Player#event:loadstart