SubtitlesButton(player, optionsopt, readyopt)

The button component for toggling and selecting subtitles

new SubtitlesButton(player, optionsopt, readyopt)

Creates an instance of this class.

Parameters:
Name Type Attributes Description
player default

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

ready function <optional>

The function to call when this component is ready.

Extends

Members

protected controlText_ :string

The text that should display over the SubtitlesButtons controls. Added for localization.

protected hideThreshold_ :Number

Hide the menu if the number of items is less than or equal to this threshold. This defaults to 0 and whenever we add items which can be hidden to the menu we'll increment it. We list it here because every time we run createMenu we need to reset the value.

Overrides:

Methods

$(selector, contextopt) → {Element|null}

Find a single DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:
Name Type Attributes Default Description
selector string

A valid CSS selector, which will be passed to querySelector.

context Element | string <optional>
this.contentEl()

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:
Element | null -

the dom element that was found, or null

Overrides:
See:

$$(selector, contextopt) → {NodeList}

Finds all DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:
Name Type Attributes Default Description
selector string

A valid CSS selector, which will be passed to querySelectorAll.

context Element | string <optional>
this.contentEl()

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:
NodeList -

a list of dom elements that were found

Overrides:
See:

addChild(child, optionsopt, indexopt) → {Component}

Add a child Component inside the current Component.

Parameters:
Name Type Attributes Default Description
child string | Component

The name or instance of a child to add.

options Object <optional>
{}

The key/value store of options that will get passed to children of the child.

index number <optional>
this.children_.length

The index to attempt to add a child into.

Returns:
Component -

The Component that gets added as a child. When using a string the Component will get created by this process.

Overrides:

addClass(…classesToAdd)

Add a CSS class name to the Components element.

Parameters:
Name Type Attributes Description
classesToAdd string <repeatable>

One or more CSS class name to add.

Overrides:

any(type, fn)

This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.

Parameters:
Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to be called once for each event name.

Overrides:

blur()

Remove the focus from the actual button, not this element

Overrides:

buildCSSClass() → {string}

Builds the default DOM className.

Returns:
string -

The DOM className for this object.

Overrides:

buildWrapperCSSClass() → {string}

Allow sub components to stack CSS class names for the wrapper element

Returns:
string -

The constructed wrapper DOM className

Overrides:

cancelAnimationFrame(id) → {number}

Cancels a queued callback passed to Component#requestAnimationFrame (rAF).

If you queue an rAF callback via Component#requestAnimationFrame, use this function instead of window.cancelAnimationFrame. If you don't, your dispose listener will not get cleaned up until Component#dispose!

Parameters:
Name Type Description
id number

The rAF ID to clear. The return value of Component#requestAnimationFrame.

Returns:
number -

Returns the rAF ID that was cleared.

Overrides:
See:

cancelNamedAnimationFrame(name)

Cancels a current named animation frame if it exists.

Parameters:
Name Type Description
name string

The name of the requestAnimationFrame to cancel.

Overrides:

children() → {Array}

Get an array of all child components

Returns:
Array -

The children

Overrides:

clearInterval(intervalId) → {number}

Clears an interval that gets created via window.setInterval or Component#setInterval. If you set an interval via Component#setInterval use this function instead of window.clearInterval. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:
Name Type Description
intervalId number

The id of the interval to clear. The return value of Component#setInterval or window.setInterval.

Returns:
number -

Returns the interval id that was cleared.

Overrides:
See:

clearTimeout(timeoutId) → {number}

Clears a timeout that gets created via window.setTimeout or Component#setTimeout. If you set a timeout via Component#setTimeout use this function instead of window.clearTimout. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:
Name Type Description
timeoutId number

The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.

Returns:
number -

Returns the timeout id that was cleared.

Overrides:
See:

contentEl() → {Element}

Return the Components DOM element. This is where children get inserted. This will usually be the the same as the element returned in Component#el.

Returns:
Element -

The content element for this Component.

Overrides:

controlText(textopt, elopt) → {string}

Get or set the localized control text that will be used for accessibility.

NOTE: This will come from the internal menuButton_ element.

Parameters:
Name Type Attributes Default Description
text string <optional>

Control text for element.

el Element <optional>
this.menuButton_.el()

Element to set the title on.

Returns:
string -
  • The control text when getting
Overrides:

createEl() → {Element}

Create the MenuButtonss DOM element.

Returns:
Element -

The element that gets created.

Overrides:

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

Overrides:

createMenu() → {Menu}

Create the menu and add all items to it.

Returns:
Menu -

The constructed menu

Overrides:

currentDimension(widthOrHeight) → {number}

Get the computed width or the height of the component's element.

Uses window.getComputedStyle.

Parameters:
Name Type Description
widthOrHeight string

A string containing 'width' or 'height'. Whichever one you want to get.

Returns:
number -

The dimension that gets asked for or 0 if nothing was set for that dimension.

Overrides:

currentDimensions() → {Component~DimensionObject}

Get an object that contains computed width and height values of the component's element.

Uses window.getComputedStyle.

Returns:
Component~DimensionObject -

The computed dimensions of the component's element.

Overrides:

currentHeight() → {number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed height of the component's element.

Overrides:

currentWidth() → {number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed width of the component's element.

Overrides:

dimension(widthOrHeight, numopt, skipListenersopt) → {number}

Get or set width or height of the Component element. This is the shared code for the Component#width and Component#height.

Things to know:

  • If the width or height in an number this will return the number postfixed with 'px'.
  • If the width/height is a percent this will return the percent postfixed with '%'
  • Hidden elements have a width of 0 with window.getComputedStyle. This function defaults to the Components style.width and falls back to window.getComputedStyle. See this for more information
  • If you want the computed style of the component, use Component#currentWidth and {Component#currentHeight
Parameters:
Name Type Attributes Description
widthOrHeight string

8 'width' or 'height'

num number | string <optional>

8 New dimension

skipListeners boolean <optional>

Skip componentresize event trigger

Fires:
Returns:
number -

The dimension when getting or 0 if unset

Overrides:

dimensions(width, height)

Set both the width and height of the Component element at the same time.

Parameters:
Name Type Description
width number | string

Width to set the Components element to.

height number | string

Height to set the Components element to.

Overrides:

disable()

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

Overrides:

dispose()

Dispose of the menu-button and all child components.

Overrides:

el() → {Element}

Get the Components DOM element

Returns:
Element -

The DOM element for this Component.

Overrides:

enable()

Enable the MenuButton. Allow it to be clicked.

Overrides:

enableTouchActivity()

This function reports user activity whenever touch events happen. This can get turned off by any sub-components that wants touch events to act another way.

Report user touch activity when touch events occur. User activity gets used to determine when controls should show/hide. It is simple when it comes to mouse events, because any mouse event should show the controls. So we capture mouse events that bubble up to the player and report activity when that happens. With touch events it isn't as easy as touchstart and touchend toggle player controls. So touch events can't help us at the player level either.

User activity gets checked asynchronously. So what could happen is a tap event on the video turns the controls off. Then the touchend event bubbles up to the player. Which, if it reported user activity, would turn the controls right back on. We also don't want to completely block touch events from bubbling up. Furthermore a touchmove event and anything other than a tap, should not turn controls back on.

Listens to Events:
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchend
  • Component#event:touchcancel
Overrides:

focus()

Set the focus to the actual button, not to this element

Overrides:

getAttribute(attribute) → {string|null}

Get the value of an attribute on the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to get the value from.

Returns:
string | null -
  • The value of the attribute that was asked for. - Can be an empty string on some browsers if the attribute does not exist or has no value - Most browsers will return null if the attribute does not exist or has no value.
Overrides:
See:

getChild(name) → {Component|undefined}

Returns the child Component with the given name.

Parameters:
Name Type Description
name string

The name of the child Component to get.

Returns:
Component | undefined -

The child Component with the given name or undefined.

Overrides:

getChildById(id) → {Component|undefined}

Returns the child Component with the given id.

Parameters:
Name Type Description
id string

The id of the child Component to get.

Returns:
Component | undefined -

The child Component with the given id or undefined.

Overrides:

getDescendant(…names) → {Component|undefined}

Returns the descendant Component following the givent descendant names. For instance ['foo', 'bar', 'baz'] would try to get 'foo' on the current component, 'bar' on the 'foo' component and 'baz' on the 'bar' component and return undefined if any of those don't exist.

Parameters:
Name Type Attributes Description
names ...Array.<string> | string <repeatable>

The name of the child Component to get.

Returns:
Component | undefined -

The descendant Component following the given descendant names or undefined.

Overrides:

handleClick(event)

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

Parameters:
Name Type Description
event Event

The keydown, tap, or click event that caused this function to be called.

Listens to Events:
  • event:tap
  • event:click
Overrides:

handleKeyDown(event)

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

Parameters:
Name Type Description
event Event

The keydown event that caused this function to be called.

Listens to Events:
  • event:keydown
Overrides:

handleKeyPress(event)

Many components used to have a handleKeyPress method, which was poorly named because it listened to a keydown event. This method name now delegates to handleKeyDown. This means anyone calling handleKeyPress will not see their method calls stop working.

Parameters:
Name Type Description
event Event

The event that caused this function to be called.

Overrides:

abstract handleLanguagechange()

Handles language change for the player in components. Should be overridden by sub-components.

Overrides:

handleMenuKeyUp(event)

Handle a keyup event on a MenuButton. The listener for this is added in the constructor.

Parameters:
Name Type Description
event Event

Key press event

Listens to Events:
  • event:keyup
Overrides:

handleMouseLeave(event)

Handle mouseleave for MenuButton.

Parameters:
Name Type Description
event Event

The mouseleave event that caused this function to be called.

Listens to Events:
  • event:mouseleave
Overrides:

handleSubmenuKeyDown(event)

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

Parameters:
Name Type Description
event Event

Key press event

Listens to Events:
  • event:keydown
Overrides:

handleSubmenuKeyPress(event)

This method name now delegates to handleSubmenuKeyDown. This means anyone calling handleSubmenuKeyPress will not see their method calls stop working.

Parameters:
Name Type Description
event Event

The event that caused this function to be called.

Overrides:

hasClass(classToCheck) → {boolean}

Check if a component's element has a CSS class name.

Parameters:
Name Type Description
classToCheck string

CSS class name to check.

Returns:
boolean -
  • True if the Component has the class. - False if the Component does not have the class`
Overrides:

height(numopt, skipListenersopt) → {number|string}

Get or set the height of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:
Name Type Attributes Description
num number | string <optional>

The height that you want to set postfixed with '%', 'px' or nothing.

skipListeners boolean <optional>

Skip the componentresize event trigger

Returns:
number | string -

The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

Overrides:

hide()

Hide the Components element if it is currently showing by adding the 'vjs-hidden` class name to it.

Overrides:

id() → {string}

Get this Components ID

Returns:
string -

The id of this Component

Overrides:

initChildren()

Add and initialize default child Components based upon options.

Overrides:

isDisposed() → {boolean}

Determine whether or not this component has been disposed.

Returns:
boolean -

If the component has been disposed, will be true. Otherwise, false.

Overrides:

localize(string, tokensopt, defaultValueopt) → {string}

Localize a string given the string in english.

If tokens are provided, it'll try and run a simple token replacement on the provided string. The tokens it looks for look like {1} with the index being 1-indexed into the tokens array.

If a defaultValue is provided, it'll use that over string, if a value isn't found in provided language files. This is useful if you want to have a descriptive key for token replacement but have a succinct localized string and not require en.json to be included.

Currently, it is used for the progress bar timing.

{
  "progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}

It is then used like so:

this.localize('progress bar timing: currentTime={1} duration{2}',
              [this.player_.currentTime(), this.player_.duration()],
              '{1} of {2}');

Which outputs something like: 01:23 of 24:56.

Parameters:
Name Type Attributes Description
string string

The string to localize and the key to lookup in the language files.

tokens Array.<string> <optional>

If the current item has token replacements, provide the tokens here.

defaultValue string <optional>

Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.

Returns:
string -

The localized string or if no localization exists the english string.

Overrides:

name() → {string}

Get the Components name. The name gets used to reference the Component and is set during registration.

Returns:
string -

The name of this Component.

Overrides:

off(type, fn)

Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.

Parameters:
Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to remove.

Overrides:

on(type, fn)

Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.

Parameters:
Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to call with EventTargets

Overrides:

one(type, fn)

This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.

Parameters:
Name Type Description
type string | Array.<string>

An event name or an array of event names.

fn function

The function to be called once for each event name.

Overrides:

options(obj) → {Object}

Deep merge of options objects with new options.

Note: When both obj and options contain properties whose values are objects. The two properties get merged using module:obj.merge

Parameters:
Name Type Description
obj Object

The object that contains new options.

Returns:
Object -

A new object of this.options_ and obj merged together.

Overrides:

player() → {default}

Return the Player that the Component has attached to.

Returns:
default -

The player that this Component has attached to.

Overrides:

pressButton()

Put the current MenuButton into a pressed state.

Overrides:

ready(fn) → {Component}

Bind a listener to the component's ready state. Different from event listeners in that if the ready event has already happened it will trigger the function immediately.

Parameters:
Name Type Description
fn ReadyCallback

Function that gets called when the Component is ready.

Returns:
Component -

Returns itself; method can be chained.

Overrides:

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to remove.

Overrides:
See:

removeChild(component)

Remove a child Component from this Components list of children. Also removes the child Components element from this Components element.

Parameters:
Name Type Description
component Component

The child Component to remove.

Overrides:

removeClass(…classesToRemove)

Remove a CSS class name from the Components element.

Parameters:
Name Type Attributes Description
classesToRemove string <repeatable>

One or more CSS class name to remove.

Overrides:

requestAnimationFrame(fn) → {number}

Queues up a callback to be passed to requestAnimationFrame (rAF), but with a few extra bonuses:

  • Supports browsers that do not support rAF by falling back to Component#setTimeout.

  • The callback is turned into a Component~GenericCallback (i.e. bound to the component).

  • Automatic cancellation of the rAF callback is handled if the component is disposed before it is called.

Parameters:
Name Type Description
fn Component~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.

Listens to Events:
Returns:
number -

Returns an rAF ID that gets used to identify the timeout. It can also be used in Component#cancelAnimationFrame to cancel the animation frame callback.

Overrides:
See:

requestNamedAnimationFrame(name, fn)

Request an animation frame, but only one named animation frame will be queued. Another will never be added until the previous one finishes.

Parameters:
Name Type Description
name string

The name to give this requestAnimationFrame

fn Component~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.

Overrides:

setAttribute(attribute, value)

Set the value of an attribute on the Component's element

Parameters:
Name Type Description
attribute string

Name of the attribute to set.

value string

Value to set the attribute to.

Overrides:
See:

setInterval(fn, interval) → {number}

Creates a function that gets run every x milliseconds. This function is a wrapper around window.setInterval. There are a few reasons to use this one instead though.

  1. It gets cleared via Component#clearInterval when Component#dispose gets called.
  2. The function callback will be a Component~GenericCallback
Parameters:
Name Type Description
fn Component~GenericCallback

The function to run every x seconds.

interval number

Execute the specified function every x milliseconds.

Listens to Events:
Returns:
number -

Returns an id that can be used to identify the interval. It can also be be used in Component#clearInterval to clear the interval.

Overrides:
See:

setTimeout(fn, timeout) → {number}

Creates a function that runs after an x millisecond timeout. This function is a wrapper around window.setTimeout. There are a few reasons to use this one instead though:

  1. It gets cleared via Component#clearTimeout when Component#dispose gets called.
  2. The function callback will gets turned into a Component~GenericCallback

Note: You can't use window.clearTimeout on the id returned by this function. This will cause its dispose listener not to get cleaned up! Please use Component#clearTimeout or Component#dispose instead.

Parameters:
Name Type Description
fn Component~GenericCallback

The function that will be run after timeout.

timeout number

Timeout in milliseconds to delay before executing the specified function.

Listens to Events:
Returns:
number -

Returns a timeout ID that gets used to identify the timeout. It can also get used in Component#clearTimeout to clear the timeout that was set.

Overrides:
See:

show()

Show the Components element if it is hidden by removing the 'vjs-hidden' class name from it.

Overrides:

toggleClass(classToToggle, predicateopt)

Add or remove a CSS class name from the component's element.

Parameters:
Name Type Attributes Description
classToToggle string

The class to add or remove based on (@link Component#hasClass}

predicate boolean | Dom~predicate <optional>

An Dom~predicate function or a boolean

Overrides:

trigger(event)

This function causes an event to happen. This will then cause any event listeners that are waiting for that event, to get called. If there are no event listeners for an event then nothing will happen.

If the name of the Event that is being triggered is in EventTarget.allowedEvents_. Trigger will also call the on + uppercaseEventName function.

Example: 'click' is in EventTarget.allowedEvents_, so, trigger will attempt to call onClick if it exists.

Parameters:
Name Type Description
event string | Event | Object

The name of the event, an Event, or an object with a key of type set to an event name.

Overrides:

triggerReady()

Trigger all the ready listeners for this Component.

Fires:
Overrides:

unpressButton()

Take the current MenuButton out of a pressed state.

Overrides:

update()

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

Overrides:

width(numopt, skipListenersopt) → {number|string}

Get or set the width of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:
Name Type Attributes Description
num number | string <optional>

The width that you want to set postfixed with '%', 'px' or nothing.

skipListeners boolean <optional>

Skip the componentresize event trigger

Returns:
number | string -

The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

Overrides:

Events

componentresize

Triggered when a component is resized.

Type:
Overrides:

dispose

Triggered when a Component is disposed.

Type:
Properties:
Name Type Attributes Default Description
bubbles boolean <optional>
false

set to false so that the dispose event does not bubble up

Overrides:

ready

Triggered when a Component is ready.

Type:
Overrides:

tap

Triggered when a Component is tapped.

Type:
  • MouseEvent
Overrides: