new AudioTrackMenuItem(player, optionsopt)
Creates an instance of this class.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
player |
Player | The |
|
options |
Object |
<optional> |
The key/value store of player options. |
Extends
Methods
-
$(selector, contextopt) → {Element|null}
-
Find a single DOM element matching a
selector
. This can be within theComponent
scontentEl()
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. Ifthis.contentEl()
returns nothing it falls back todocument
.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 theComponent
scontentEl()
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. Ifthis.contentEl()
returns nothing it falls back todocument
.Returns:
NodeList -a list of dom elements that were found
- Overrides:
- See:
-
addChild(child, optionsopt, indexopt) → {Component}
-
Add a child
Component
inside the currentComponent
.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 theComponent
will get created by this process.- Overrides:
-
addClass(classToAdd)
-
Add a CSS class name to the
Component
s element.Parameters:
Name Type Description classToAdd
string CSS class name to add
- Overrides:
-
blur()
-
Remove the focus from this component
- Overrides:
-
buildCSSClass() → {string}
-
Builds the default DOM
className
.Returns:
string -The DOM
className
for this object.- 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 inteval via Component#setInterval use this function instead ofwindow.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 ofwindow.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
Component
s 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 localize text to use for the controls on the
ClickableComponent
.Parameters:
Name Type Attributes Default Description text
string <optional>
Control text for element.
el
Element <optional>
this.el() Element to set the title on.
Returns:
string -- The control text when getting
- Overrides:
-
createControlTextEl(elopt) → {Element}
-
Create a control text element on this
ClickableComponent
Parameters:
Name Type Attributes Description el
Element <optional>
Parent element for the control text.
Returns:
Element -The control text element that gets created.
- Overrides:
-
createEl(typeopt, propsopt, attrsopt) → {Element}
-
Create the `MenuItem's DOM element
Parameters:
Name Type Attributes 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
Returns:
Element -The element that gets created.
- 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
.- 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 theComponent
sstyle.width
and falls back towindow.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
Component
s element to.height
number | string Height to set the
Component
s element to.- Overrides:
-
disable()
-
Disable this
ClickableComponent
- Overrides:
-
dispose(options)
-
Dispose of the
Component
and all child components.Parameters:
Name Type Description options
Object Properties
Name Type Description originalEl
Element element with which to replace player element
Fires:
- Overrides:
-
el() → {Element}
-
Get the
Component
s DOM elementReturns:
Element -The DOM element for this
Component
.- Overrides:
-
enable()
-
Enable this
ClickableComponent
- 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
andtouchend
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 atouchmove
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 this component
- Overrides:
-
getAttribute(attribute) → {string|null}
-
Get the value of an attribute on the
Component
s 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 attibute does not exist or has no value.
- Overrides:
- See:
-
getChild(name) → {Component|undefined}
-
Returns the child
Component
with the givenname
.Parameters:
Name Type Description name
string The name of the child
Component
to get.- Overrides:
-
getChildById(id) → {Component|undefined}
-
Returns the child
Component
with the givenid
.Parameters:
Name Type Description id
string The id of the child
Component
to get.- Overrides:
-
getDescendant(…names) → {Component|undefined}
-
Returns the descendant
Component
following the givent descendantnames
. 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 descendantnames
or undefined.- Overrides:
-
handleClick(eventopt)
-
This gets called when an `AudioTrackMenuItem 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
, orclick
event that caused this function to be called.Listens to Events:
- event:tap
- event:click
- Overrides:
-
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:
Name Type Description event
EventTarget~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 akeydown
event. This method name now delegates tohandleKeyDown
. This means anyone callinghandleKeyPress
will not see their method calls stop working.Parameters:
Name Type Description event
EventTarget~Event The event that caused this function to be called.
- Overrides:
-
handleLanguagechange()
-
Handles language change in ClickableComponent for the player in components
- Overrides:
-
handleTracksChange(eventopt)
-
Handle any AudioTrack change.
Parameters:
Name Type Attributes Description event
EventTarget~Event <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:
Name Type Description classToCheck
string CSS class name to check.
Returns:
boolean -- True if the
Component
has the class. - False if theComponent
does not have the class`
- Overrides:
- True if the
-
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
Component
s element if it is currently showing by adding the 'vjs-hidden` class name to it.- Overrides:
-
id() → {string}
-
Get this
Component
s IDReturns:
string -The id of this
Component
- Overrides:
-
initChildren()
-
Add and initialize default child
Component
s 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 overstring
, 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 requireen.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
Component
s name. The name gets used to reference theComponent
and is set during registration.Returns:
string -The name of this
Component
.- Overrides:
-
options(obj) → {Object}
-
Deep merge of options objects with new options.
Note: When both
obj
andoptions
contain properties whose values are objects. The two properties get merged using module:mergeOptionsParameters:
Name Type Description obj
Object The object that contains new options.
Returns:
Object -A new object of
this.options_
andobj
merged together.- Overrides:
-
player() → {Player}
-
Return the Player that the
Component
has attached to.- Overrides:
-
ready() → {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.
- Overrides:
-
removeAttribute(attribute)
-
Remove an attribute from the
Component
s element.Parameters:
Name Type Description attribute
string Name of the attribute to remove.
- Overrides:
- See:
-
removeChild(component)
-
Remove a child
Component
from thisComponent
s list of children. Also removes the childComponent
s element from thisComponent
s element.Parameters:
Name Type Description component
Component The child
Component
to remove.- Overrides:
-
removeClass(classToRemove)
-
Remove a CSS class name from the
Component
s element.Parameters:
Name Type Description classToRemove
string 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:
-
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
- Overrides:
-
setAttribute(attribute, value)
-
Set the value of an attribute on the
Component
's elementParameters:
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 aroundwindow.setInterval
. There are a few reasons to use this one instead though.- It gets cleared via Component#clearInterval when Component#dispose gets called.
- 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 aroundwindow.setTimeout
. There are a few reasons to use this one instead though:- It gets cleared via Component#clearTimeout when Component#dispose gets called.
- 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
Component
s 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.
classToToggle
gets added when Component#hasClass would return false.classToToggle
gets removed when Component#hasClass would return true.
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:
-
triggerReady()
-
Trigger all the ready listeners for this
Component
.Fires:
- 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:
- Overrides: