AudioTrackMenuItem

Constructor

new AudioTrackMenuItem(player, optionsopt)

Creates an instance of this class.

Parameters:
NameTypeAttributesDescription
playerdefault

The Player that this class should be attached to.

optionsObject<optional>

The key/value store of player options.

Extends

Members

(protected) controlText_

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:
NameTypeAttributesDefaultDescription
selectorstring

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

contextElement | 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.

Overrides
Returns:

the dom element that was found, or null

Type: 
Element | null

$$(selector, contextopt) → {NodeList}

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

Parameters:
NameTypeAttributesDefaultDescription
selectorstring

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

contextElement | 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.

Overrides
Returns:

a list of dom elements that were found

Type: 
NodeList

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

Add a child Component inside the current Component.

Parameters:
NameTypeAttributesDefaultDescription
childstring | Component

The name or instance of a child to add.

optionsObject<optional>
{}

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

indexnumber<optional>
this.children_.length

The index to attempt to add a child into.

Returns:

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

Type: 
Component

addClass(…classesToAdd)

Add a CSS class name to the Components element.

Parameters:
NameTypeAttributesDescription
classesToAddstring<repeatable>

One or more CSS class name to add.

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to be called once for each event name.

Overrides

blur()

Remove the focus from this component

Overrides

buildCSSClass() → {string}

Builds the default DOM className.

Returns:

The DOM className for this object.

Type: 
string

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:
NameTypeDescription
idnumber

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

Returns:

Returns the rAF ID that was cleared.

Type: 
number

cancelNamedAnimationFrame(name)

Cancels a current named animation frame if it exists.

Parameters:
NameTypeDescription
namestring

The name of the requestAnimationFrame to cancel.

children() → {Array}

Get an array of all child components

Returns:

The children

Type: 
Array

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:
NameTypeDescription
intervalIdnumber

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

Returns:

Returns the interval id that was cleared.

Type: 
number

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:
NameTypeDescription
timeoutIdnumber

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

Returns:

Returns the timeout id that was cleared.

Type: 
number

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:

The content element for this Component.

Type: 
Element

controlText(textopt, elopt) → {string}

Get or set the localize text to use for the controls on the ClickableComponent.

Parameters:
NameTypeAttributesDefaultDescription
textstring<optional>

Control text for element.

elElement<optional>
this.el()

Element to set the title on.

Returns:
  • The control text when getting
Type: 
string

createControlTextEl(elopt) → {Element}

Create a control text element on this ClickableComponent

Parameters:
NameTypeAttributesDescription
elElement<optional>

Parent element for the control text.

Returns:

The control text element that gets created.

Type: 
Element

createEl(typeopt, propsopt, attrsopt) → {Element}

Create the `MenuItem's DOM element

Parameters:
NameTypeAttributesDefaultDescription
typestring<optional>
li

Element's node type, not actually used, always set to li.

propsObject<optional>
{}

An object of properties that should be set on the element

attrsObject<optional>
{}

An object of attributes that should be set on the element

Returns:

The element that gets created.

Type: 
Element

currentDimension(widthOrHeight) → {number}

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

Uses window.getComputedStyle.

Parameters:
NameTypeDescription
widthOrHeightstring

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

Returns:

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

Type: 
number

currentDimensions() → {Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:

The computed dimensions of the component's element.

Type: 
Component~DimensionObject

currentHeight() → {number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:

The computed height of the component's element.

Type: 
number

currentWidth() → {number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:

The computed width of the component's element.

Type: 
number

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

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:
NameTypeAttributesDescription
widthOrHeightstring

8 'width' or 'height'

numnumber | string<optional>

8 New dimension

skipListenersboolean<optional>

Skip componentresize event trigger

Returns:

The dimension when getting or 0 if unset

Type: 
number | undefined

dimensions(width, height)

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

Parameters:
NameTypeDescription
widthnumber | string

Width to set the Components element to.

heightnumber | string

Height to set the Components element to.

disable()

Disable this ClickableComponent

dispose(options)

Dispose of the Component and all child components.

Parameters:
NameTypeDescription
optionsObject
Properties
NameTypeDescription
originalElElement

element with which to replace player element

el() → {Element}

Get the Components DOM element

Overrides
Returns:

The DOM element for this Component.

Type: 
Element

(protected) emitTapEvents()

Emit a 'tap' events when touch event support gets detected. This gets used to support toggling the controls through a tap on the video. They get enabled because every sub-component would have extra overhead otherwise.

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

enable()

Enable this ClickableComponent

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

focus()

Set the focus to this component

getAttribute(attribute) → {string|null}

Get the value of an attribute on the Components element.

Parameters:
NameTypeDescription
attributestring

Name of the attribute to get the value from.

Returns:
  • 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.
Type: 
string | null

getChild(name) → {Component|undefined}

Returns the child Component with the given name.

Parameters:
NameTypeDescription
namestring

The name of the child Component to get.

Returns:

The child Component with the given name or undefined.

Type: 
Component | undefined

getChildById(id) → {Component|undefined}

Returns the child Component with the given id.

Parameters:
NameTypeDescription
idstring

The id of the child Component to get.

Returns:

The child Component with the given id or undefined.

Type: 
Component | undefined

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:
NameTypeAttributesDescription
names...Array.<string> | string<repeatable>

The name of the child Component to get.

Returns:

The descendant Component following the given descendant names or undefined.

Type: 
Component | undefined

getIsAvailableToBeFocused(el) → {boolean}

Determine whether or not this component is currently visible/enabled/etc...

Parameters:
NameTypeDescription
elHTMLElement

The HTML element representing the component.

Returns:

If the component can is currently visible & enabled, will be true. Otherwise, false.

Type: 
boolean

getIsFocusable(el) → {boolean}

Determine whether or not this component can be considered as focusable component.

Parameters:
NameTypeDescription
elHTMLElement

The HTML element representing the component.

Returns:

If the component can be focused, will be true. Otherwise, false.

Type: 
boolean

getPositions() → {Object}

Retrieves the position and size information of the component's element.

Returns:

An object with boundingClientRect and center properties. - boundingClientRect: An object with properties x, y, width, height, top, right, bottom, and left, representing the bounding rectangle of the element. - center: An object with properties x and y, representing the center point of the element. width and height are set to 0.

Type: 
Object

handleClick(eventopt)

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

Parameters:
NameTypeAttributesDescription
eventEvent<optional>

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

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

handleKeyDown(event)

Ignore keys which are used by the menu, but pass any other ones up. See ClickableComponent#handleKeyDown for instances where this is called.

Parameters:
NameTypeDescription
eventKeyboardEvent

The keydown event that caused this function to be called.

Listens to Events:
  • event:keydown

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:
NameTypeDescription
eventKeyboardEvent

The event that caused this function to be called.

handleLanguagechange()

Handles language change in ClickableComponent for the player in components

handleTracksChange(eventopt)

Handle any AudioTrack change.

Parameters:
NameTypeAttributesDescription
eventEvent<optional>

The AudioTrackList#change event that caused this to run.

Listens to Events:

hasClass(classToCheck) → {boolean}

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

Parameters:
NameTypeDescription
classToCheckstring

CSS class name to check.

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

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

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

Parameters:
NameTypeAttributesDescription
numnumber | string<optional>

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

skipListenersboolean<optional>

Skip the componentresize event trigger

Returns:

The height when getting, zero if there is no height

Type: 
number | undefined

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

Overrides
Returns:

The id of this Component

Type: 
string

initChildren()

Add and initialize default child Components based upon options.

isDisposed() → {boolean}

Determine whether or not this component has been disposed.

Returns:

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

Type: 
boolean

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:
NameTypeAttributesDescription
stringstring

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

tokensArray.<string><optional>

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

defaultValuestring<optional>

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

Returns:

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

Type: 
string

name() → {string}

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

Overrides
Returns:

The name of this Component.

Type: 
string

off(type, fnopt)

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:
NameTypeAttributesDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction<optional>

The function to remove. If not specified, all listeners managed by Video.js will be removed.

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

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:
NameTypeDescription
objObject

The object that contains new options.

Returns:

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

Type: 
Object

player() → {default}

Return the Player that the Component has attached to.

Returns:

The player that this Component has attached to.

Type: 
default

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:
NameTypeDescription
fnReadyCallback

Function that gets called when the Component is ready.

Returns:

Returns itself; method can be chained.

Type: 
Component

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
NameTypeDescription
attributestring

Name of the attribute to remove.

removeChild(component)

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

Parameters:
NameTypeDescription
componentComponent

The child Component to remove.

removeClass(…classesToRemove)

Remove a CSS class name from the Components element.

Parameters:
NameTypeAttributesDescription
classesToRemovestring<repeatable>

One or more CSS class name to remove.

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:
NameTypeDescription
fnComponent~GenericCallback

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

Listens to Events:
Returns:

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.

Type: 
number

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:
NameTypeDescription
namestring

The name to give this requestAnimationFrame

fnComponent~GenericCallback

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

selected(selected)

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

Parameters:
NameTypeDescription
selectedboolean

if the menu item is selected or not

setAttribute(attribute, value)

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

Parameters:
NameTypeDescription
attributestring

Name of the attribute to set.

valuestring

Value to set the attribute to.

setIcon(iconName, elopt) → {Element}

Adds an SVG icon element to another element or component.

Parameters:
NameTypeAttributesDefaultDescription
iconNamestring

The name of icon. A list of all the icon names can be found at 'sandbox/svg-icons.html'

elElement<optional>
this.el()

Element to set the title on. Defaults to the current Component's element.

Returns:

The newly created icon element.

Type: 
Element

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:
NameTypeDescription
fnComponent~GenericCallback

The function to run every x seconds.

intervalnumber

Execute the specified function every x milliseconds.

Listens to Events:
Returns:

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

Type: 
number

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:
NameTypeDescription
fnComponent~GenericCallback

The function that will be run after timeout.

timeoutnumber

Timeout in milliseconds to delay before executing the specified function.

Listens to Events:
Returns:

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.

Type: 
number

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:
NameTypeAttributesDescription
classToTogglestring

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

predicateboolean | Dom~predicate<optional>

An Dom~predicate function or a boolean

trigger(event, hashopt)

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:
NameTypeAttributesDescription
eventstring | Event | Object

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

hashObject<optional>

Optionally extra argument to pass through to an event listener

triggerReady()

Trigger all the ready listeners for this Component.

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

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

Parameters:
NameTypeAttributesDescription
numnumber | string<optional>

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

skipListenersboolean<optional>

Skip the componentresize event trigger

Returns:

The width when getting, zero if there is no width

Type: 
number | undefined

Events

componentresize

Triggered when a component is resized.

Type:

dispose

Triggered when a Component is disposed.

Type:
Properties
NameTypeAttributesDefaultDescription
bubblesboolean<optional>
false

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

ready

Triggered when a Component is ready.

Type:

tap

Triggered when a Component is tapped.

Type:
  • MouseEvent