OpenTV Player Web HTML5

OpenTV Player Web HTML5

Class: ChaptersButton

ChaptersButton

The button component for toggling and selecting chapters Chapters act much differently than other text tracks Cues are navigation vs. other tracks of alternative languages

new ChaptersButton(player, options, ready)

Creates an instance of this class.

Name Type Description
player Player

The Player that this class should be attached to.
options Object optional

The key/value store of player options.
ready Component~ReadyCallback optional

The function to call when this function is ready.

Extends

Members

inherited overrides 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.

Methods

inherited overrides $(selector, context){Element|null}

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

Name Type Default Description
selector string

A valid CSS selector, which will be passed to querySelector.
context Element | string this.contentEl() optional

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.
See:
Returns:
Type Description
Element | null the dom element that was found, or null

inherited overrides $$(selector, context){NodeList}

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

Name Type Default Description
selector string

A valid CSS selector, which will be passed to querySelectorAll.
context Element | string this.contentEl() optional

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.
See:
Returns:
Type Description
NodeList a list of dom elements that were found

inherited overrides addChild(child, options, index){Component}

Add a child Component inside the current Component.

Name Type 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 this.children_.length optional

The index to attempt to add a child into.
Returns:
Type Description
Component The Component that gets added as a child. When using a string the Component will get created by this process.

inherited overrides addClass(classToAdd)

Add a CSS class name to the Components element.

Name Type Description
classToAdd string

CSS class name to add

inherited overrides blur()

Remove the focus from the actual button, not this element

overrides buildCSSClass(){string}

Builds the default DOM className.

Returns:
Type Description
string The DOM className for this object.

inherited overrides buildWrapperCSSClass(){string}

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

Returns:
Type Description
string The constructed wrapper DOM className

inherited 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!

Name Type Description
id number

The rAF ID to clear. The return value of Component#requestAnimationFrame.
See:
Returns:
Type Description
number Returns the rAF ID that was cleared.

inherited overrides children(){Array}

Get an array of all child components

Returns:
Type Description
Array The children

inherited 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 of window.clearInterval. If you don't your dispose listener will not get cleaned up until Component#dispose!

Name Type Description
intervalId number

The id of the interval to clear. The return value of Component#setInterval or window.setInterval.
See:
Returns:
Type Description
number Returns the interval id that was cleared.

inherited overrides 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!

Name Type Description
timeoutId number

The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.
See:
Returns:
Type Description
number Returns the timeout id that was cleared.

inherited overrides 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:
Type Description
Element The content element for this Component.

inherited overrides controlText(text, el){string}

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

NOTE: This will come from the internal menuButton_ element.

Name Type Default Description
text string optional

Control text for element.
el Element this.menuButton_.el() optional

Element to set the title on.
Returns:
Type Description
string
  • The control text when getting

inherited overrides createEl(){Element}

Create the MenuButtonss DOM element.

Returns:
Type Description
Element The element that gets created.

overrides createItems(){Array.<TextTrackMenuItem>}

Create a menu item for each text track

Returns:
Type Description
Array.<TextTrackMenuItem> Array of menu items

overrides createMenu(){Menu}

Create menu from chapter track

Returns:
Type Description
Menu New menu for the chapter buttons

inherited overrides currentDimension(widthOrHeight){number}

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

Uses window.getComputedStyle.

Name Type Description
widthOrHeight string

A string containing 'width' or 'height'. Whichever one you want to get.
Returns:
Type Description
number The dimension that gets asked for or 0 if nothing was set for that dimension.

inherited overrides currentDimensions(){Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:
Type Description
Component~DimensionObject The computed dimensions of the component's element.

inherited overrides currentHeight(){number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:
Type Description
number The computed height of the component's element.

inherited overrides currentWidth(){number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:
Type Description
number The computed width of the component's element.

inherited overrides dimension(widthOrHeight, num, skipListeners){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
Name Type Description
widthOrHeight string

8 'width' or 'height'
num number | string optional

8 New dimension
skipListeners boolean optional

Skip componentresize event trigger
Fires:
Returns:
Type Description
number The dimension when getting or 0 if unset

inherited overrides dimensions(width, height)

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

Name Type Description
width number | string

Width to set the Components element to.
height number | string

Height to set the Components element to.

inherited overrides disable()

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

inherited overrides dispose()

Dispose of the Component and all child components.

Fires:

inherited overrides el(){Element}

Get the Components DOM element

Returns:
Type Description
Element The DOM element for this Component.

inherited overrides enable()

Enable the MenuButton. Allow it to be clicked.

inherited 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

findChaptersTrack(){TextTrack|undefined}

Find the track object that is currently in use by this ChaptersButton

Returns:
Type Description
TextTrack | undefined The current track or undefined if none was found.

inherited overrides focus()

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

inherited overrides getAttribute(attribute){string|null}

Get the value of an attribute on the Components element.

Name Type Description
attribute string

Name of the attribute to get the value from.
See:
Returns:
Type Description
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.

inherited overrides getChild(name){Component|undefined}

Returns the child Component with the given name.

Name Type Description
name string

The name of the child Component to get.
Returns:
Type Description
Component | undefined The child Component with the given name or undefined.

inherited overrides getChildById(id){Component|undefined}

Returns the child Component with the given id.

Name Type Description
id string

The id of the child Component to get.
Returns:
Type Description
Component | undefined The child Component with the given id or undefined.

getMenuCaption(){string}

Get the caption for the ChaptersButton based on the track label. This will also use the current tracks localized kind as a fallback if a label does not exist.

Returns:
Type Description
string The tracks current label or the localized track kind.

inherited overrides handleBlur(event)

Called when a MenuButton loses focus. Turns off the listener for keydown events. Which Stops this.handleKeyPress from getting called.

Name Type Description
event EventTarget~Event

The blur event that caused this function to be called.
Listens to Events:
  • event:blur

inherited overrides handleClick(event)

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

Name Type Description
event EventTarget~Event

The keydown, tap, or click event that caused this function to be called.
Listens to Events:
  • event:tap
  • event:click

inherited overrides handleFocus(event)

This gets called when a MenuButton gains focus via a focus event. Turns on listening for keydown events. When they happen it calls this.handleKeyPress.

Name Type Description
event EventTarget~Event

The focus event that caused this function to be called.
Listens to Events:
  • event:focus

inherited overrides handleKeyPress(event)

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

Name Type Description
event EventTarget~Event

The keydown event that caused this function to be called.
Listens to Events:
  • event:keydown

inherited overrides handleSubmenuKeyPress(event)

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

Name Type Description
event EventTarget~Event

Key press event
Listens to Events:
  • event:keydown

inherited overrides hasClass(classToCheck){boolean}

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

Name Type Description
classToCheck string

CSS class name to check.
Returns:
Type Description
boolean
  • True if the Component has the class. - False if the Component does not have the class`

inherited overrides height(num, skipListeners){number|string}

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

Name Type 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:
Type Description
number | string The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

inherited overrides hide()

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

inherited overrides id(){string}

Get this Components ID

Returns:
Type Description
string The id of this Component

inherited overrides initChildren()

Add and initialize default child Components based upon options.

inherited overrides localize(string, tokens, defaultValue){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.

Name Type 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:
Type Description
string The localized string or if no localization exists the english string.

inherited overrides name(){string}

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

Returns:
Type Description
string The name of this Component.

inherited 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:mergeOptions

Name Type Description
obj Object

The object that contains new options.
Deprecated
  • since version 5
    Returns:
    Type Description
    Object A new object of this.options_ and obj merged together.

    inherited overrides player(){Player}

    Return the Player that the Component has attached to.

    Returns:
    Type Description
    Player The player that this Component has attached to.

    inherited overrides pressButton()

    Put the current MenuButton into a pressed state.

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

    Returns:
    Type Description
    Component Returns itself; method can be chained.

    inherited overrides removeAttribute(attribute)

    Remove an attribute from the Components element.

    Name Type Description
    attribute string

    Name of the attribute to remove.
    See:

    inherited overrides removeChild(component)

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

    Name Type Description
    component Component

    The child Component to remove.

    inherited overrides removeClass(classToRemove)

    Remove a CSS class name from the Components element.

    Name Type Description
    classToRemove string

    CSS class name to remove

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

    Name Type Description
    fn Component~GenericCallback

    A function that will be bound to this component and executed just before the browser's next repaint.
    See:
    Listens to Events:
    Returns:
    Type Description
    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.

    inherited overrides setAttribute(attribute, value)

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

    Name Type Description
    attribute string

    Name of the attribute to set.
    value string

    Value to set the attribute to.
    See:

    inherited overrides 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
    Name Type Description
    fn Component~GenericCallback

    The function to run every x seconds.
    interval number

    Execute the specified function every x milliseconds.
    See:
    Listens to Events:
    Returns:
    Type Description
    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.

    inherited overrides 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.

    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.
    See:
    Listens to Events:
    Returns:
    Type Description
    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.

    setTrack(track)

    Set the currently selected track for the chapters button.

    Name Type Description
    track TextTrack

    The new track to select. Nothing will change if this is the currently selected track.

    inherited overrides show()

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

    inherited overrides toggleClass(classToToggle, predicate)

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

    Name Type 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

    inherited overrides triggerReady()

    Trigger all the ready listeners for this Component.

    Fires:

    inherited overrides unpressButton()

    Take the current MenuButton out of a pressed state.

    overrides update(event)

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

    Name Type Description
    event EventTarget~Event optional

    An event that triggered this function to run.
    Listens to Events:

    inherited overrides width(num, skipListeners){number|string}

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

    Name Type 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:
    Type Description
    number | string The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

    Events

    inherited overrides componentresize

    Triggered when a component is resized.

    Type:

    inherited overrides dispose

    Triggered when a Component is disposed.

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

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

    inherited overrides ready

    Triggered when a Component is ready.

    Type:

    inherited overrides tap

    Triggered when a Component is tapped.

    Type: