new BigPlayButton()

[big-play-button.js](https://docs.videojs.com/big-play-button.js.html), [line 15](https://docs.videojs.com/big-play-button.js.html#line15)

Extends

Methods

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

[component.js](https://docs.videojs.com/component.js.html), [line 767](https://docs.videojs.com/component.js.html#line767)

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.

Returns:

Element | null -

the dom element that was found, or null

$$(selector, contextopt) → {NodeList}

[component.js](https://docs.videojs.com/component.js.html), [line 789](https://docs.videojs.com/component.js.html#line789)

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.

Returns:

NodeList -

a list of dom elements that were found

addChild(child, optionsopt) → {Component}

[button.js](https://docs.videojs.com/button.js.html), [line 71](https://docs.videojs.com/button.js.html#line71)

Add a child Component inside of this Button.

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.

Returns:

Component -

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

addClass(classToAdd)

[component.js](https://docs.videojs.com/component.js.html), [line 813](https://docs.videojs.com/component.js.html#line813)

Add a CSS class name to the Components element.

Parameters:
NameTypeDescription
classToAddstring

CSS class name to add

blur()

[component.js](https://docs.videojs.com/component.js.html), [line 1153](https://docs.videojs.com/component.js.html#line1153)

Remove the focus from this component

buildCSSClass() → {string}

[big-play-button.js](https://docs.videojs.com/big-play-button.js.html), [line 30](https://docs.videojs.com/big-play-button.js.html#line30)

Builds the default DOM className.

Returns:

string -

The DOM className for this object. Always returns ‘vjs-big-play-button’.

cancelAnimationFrame(id) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1585](https://docs.videojs.com/component.js.html#line1585)

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:

number -

Returns the rAF ID that was cleared.

cancelNamedAnimationFrame(name)

[component.js](https://docs.videojs.com/component.js.html), [line 1560](https://docs.videojs.com/component.js.html#line1560)

Cancels a current named animation frame if it exists.

Parameters:
NameTypeDescription
namestring

The name of the requestAnimationFrame to cancel.

children() → {Array}

[component.js](https://docs.videojs.com/component.js.html), [line 375](https://docs.videojs.com/component.js.html#line375)

Get an array of all child components

Returns:

Array -

The children

clearInterval(intervalId) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1464](https://docs.videojs.com/component.js.html#line1464)

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!

Parameters:
NameTypeDescription
intervalIdnumber

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.

clearTimeout(timeoutId) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1408](https://docs.videojs.com/component.js.html#line1408)

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:

number -

Returns the timeout id that was cleared.

contentEl() → {Element}

[component.js](https://docs.videojs.com/component.js.html), [line 344](https://docs.videojs.com/component.js.html#line344)

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.

controlText(textopt, elopt) → {string}

[clickable-component.js](https://docs.videojs.com/clickable-component.js.html), [line 128](https://docs.videojs.com/clickable-component.js.html#line128)

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:

string -

createControlTextEl(elopt) → {Element}

[clickable-component.js](https://docs.videojs.com/clickable-component.js.html), [line 99](https://docs.videojs.com/clickable-component.js.html#line99)

Create a control text element on this ClickableComponent

Parameters:
NameTypeAttributesDescription
elElement<optional>

Parent element for the control text.

Returns:

Element -

The control text element that gets created.

createEl(tagopt, propsopt, attributesopt) → {Element}

[button.js](https://docs.videojs.com/button.js.html), [line 33](https://docs.videojs.com/button.js.html#line33)

Create the Buttons DOM element.

Parameters:
NameTypeAttributesDefaultDescription
tagstring<optional>
“button”

The element’s node type. This argument is IGNORED: no matter what is passed, it will always create a button element.

propsObject<optional>
{}

An object of properties that should be set on the element.

attributesObject<optional>
{}

An object of attributes that should be set on the element.

Returns:

Element -

The element that gets created.

currentDimension(widthOrHeight) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1066](https://docs.videojs.com/component.js.html#line1066)

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:

number -

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

currentDimensions() → {Component~DimensionObject}

[component.js](https://docs.videojs.com/component.js.html), [line 1112](https://docs.videojs.com/component.js.html#line1112)

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.

currentHeight() → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1139](https://docs.videojs.com/component.js.html#line1139)

Get the computed height of the component’s element.

Uses window.getComputedStyle.

Returns:

number -

The computed height of the component’s element.

currentWidth() → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1127](https://docs.videojs.com/component.js.html#line1127)

Get the computed width of the component’s element.

Uses window.getComputedStyle.

Returns:

number -

The computed width of the component’s element.

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

[component.js](https://docs.videojs.com/component.js.html), [line 1003](https://docs.videojs.com/component.js.html#line1003)

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

Fires:
Returns:

number -

The dimension when getting or 0 if unset

dimensions(width, height)

[component.js](https://docs.videojs.com/component.js.html), [line 969](https://docs.videojs.com/component.js.html#line969)

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()

[button.js](https://docs.videojs.com/button.js.html), [line 93](https://docs.videojs.com/button.js.html#line93)

Disable the Button element so that it cannot be activated or clicked. Use this with Button#enable.

dispose()

[component.js](https://docs.videojs.com/component.js.html), [line 134](https://docs.videojs.com/component.js.html#line134)

Dispose of the Component and all child components.

Fires:

el() → {Element}

[component.js](https://docs.videojs.com/component.js.html), [line 237](https://docs.videojs.com/component.js.html#line237)

Get the Components DOM element

Returns:

Element -

The DOM element for this Component.

enable()

[button.js](https://docs.videojs.com/button.js.html), [line 84](https://docs.videojs.com/button.js.html#line84)

Enable the Button element so that it can be activated or clicked. Use this with Button#disable.

enableTouchActivity()

[component.js](https://docs.videojs.com/component.js.html), [line 1307](https://docs.videojs.com/component.js.html#line1307)

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()

[component.js](https://docs.videojs.com/component.js.html), [line 1146](https://docs.videojs.com/component.js.html#line1146)

Set the focus to this component

getAttribute(attribute) → {string|null}

[component.js](https://docs.videojs.com/component.js.html), [line 893](https://docs.videojs.com/component.js.html#line893)

Get the value of an attribute on the Components element.

Parameters:
NameTypeDescription
attributestring

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}

[component.js](https://docs.videojs.com/component.js.html), [line 401](https://docs.videojs.com/component.js.html#line401)

Returns the child Component with the given name.

Parameters:
NameTypeDescription
namestring

The name of the child Component to get.

Returns:

Component | undefined -

The child Component with the given name or undefined.

getChildById(id) → {Component|undefined}

[component.js](https://docs.videojs.com/component.js.html), [line 388](https://docs.videojs.com/component.js.html#line388)

Returns the child Component with the given id.

Parameters:
NameTypeDescription
idstring

The id of the child Component to get.

Returns:

Component | undefined -

The child Component with the given id or undefined.

getDescendant(…names) → {Component|undefined}

[component.js](https://docs.videojs.com/component.js.html), [line 423](https://docs.videojs.com/component.js.html#line423)

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:

Component | undefined -

The descendant Component following the given descendant names or undefined.

handleClick(event)

[big-play-button.js](https://docs.videojs.com/big-play-button.js.html), [line 45](https://docs.videojs.com/big-play-button.js.html#line45)

This gets called when a BigPlayButton “clicked”. See ClickableComponent for more detailed information on what a click can be.

Parameters:
NameTypeDescription
eventEventTarget~Event

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

Listens to Events:

handleKeyDown(event)

[button.js](https://docs.videojs.com/button.js.html), [line 107](https://docs.videojs.com/button.js.html#line107)

This gets called when a Button has focus and keydown is triggered via a key press.

Parameters:
NameTypeDescription
eventEventTarget~Event

The event that caused this function to get called.

Listens to Events:

handleKeyPress(event)

[component.js](https://docs.videojs.com/component.js.html), [line 1183](https://docs.videojs.com/component.js.html#line1183)

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
eventEventTarget~Event

The event that caused this function to be called.

handleLanguagechange()

[clickable-component.js](https://docs.videojs.com/clickable-component.js.html), [line 190](https://docs.videojs.com/clickable-component.js.html#line190)

Handles language change in ClickableComponent for the player in components

hasClass(classToCheck) → {boolean}

[component.js](https://docs.videojs.com/component.js.html), [line 803](https://docs.videojs.com/component.js.html#line803)

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

Parameters:
NameTypeDescription
classToCheckstring

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}

[component.js](https://docs.videojs.com/component.js.html), [line 956](https://docs.videojs.com/component.js.html#line956)

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:

number | string -

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

hide()

[component.js](https://docs.videojs.com/component.js.html), [line 854](https://docs.videojs.com/component.js.html#line854)

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

id() → {string}

[component.js](https://docs.videojs.com/component.js.html), [line 354](https://docs.videojs.com/component.js.html#line354)

Get this Components ID

Returns:

string -

The id of this Component

initChildren()

[component.js](https://docs.videojs.com/component.js.html), [line 581](https://docs.videojs.com/component.js.html#line581)

Add and initialize default child Components based upon options.

isDisposed() → {boolean}

[component.js](https://docs.videojs.com/component.js.html), [line 197](https://docs.videojs.com/component.js.html#line197)

Determine whether or not this component has been disposed.

Returns:

boolean -

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

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

[component.js](https://docs.videojs.com/component.js.html), [line 298](https://docs.videojs.com/component.js.html#line298)

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.

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

It is then used like so:

  1. this.localize('progress bar timing: currentTime={1} duration{2}',
  2. [this.player_.currentTime(), this.player_.duration()],
  3. '{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:

string -

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

name() → {string}

[component.js](https://docs.videojs.com/component.js.html), [line 365](https://docs.videojs.com/component.js.html#line365)

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

Returns:

string -

The name of this Component.

options(obj) → {Object}

[component.js](https://docs.videojs.com/component.js.html), [line 222](https://docs.videojs.com/component.js.html#line222)

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

Parameters:
NameTypeDescription
objObject

The object that contains new options.

Returns:

Object -

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

player() → {Player}

[component.js](https://docs.videojs.com/component.js.html), [line 207](https://docs.videojs.com/component.js.html#line207)

Return the Player that the Component has attached to.

Returns:

Player -

The player that this Component has attached to.

ready() → {Component}

[component.js](https://docs.videojs.com/component.js.html), [line 698](https://docs.videojs.com/component.js.html#line698)

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:

Component -

Returns itself; method can be chained.

removeAttribute(attribute)

[component.js](https://docs.videojs.com/component.js.html), [line 920](https://docs.videojs.com/component.js.html#line920)

Remove an attribute from the Components element.

Parameters:
NameTypeDescription
attributestring

Name of the attribute to remove.

removeChild(component)

[component.js](https://docs.videojs.com/component.js.html), [line 542](https://docs.videojs.com/component.js.html#line542)

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(classToRemove)

[component.js](https://docs.videojs.com/component.js.html), [line 823](https://docs.videojs.com/component.js.html#line823)

Remove a CSS class name from the Components element.

Parameters:
NameTypeDescription
classToRemovestring

CSS class name to remove

requestAnimationFrame(fn) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1498](https://docs.videojs.com/component.js.html#line1498)

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:

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.

requestNamedAnimationFrame(name, fn)

[component.js](https://docs.videojs.com/component.js.html), [line 1534](https://docs.videojs.com/component.js.html#line1534)

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.

setAttribute(attribute, value)

[component.js](https://docs.videojs.com/component.js.html), [line 908](https://docs.videojs.com/component.js.html#line908)

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.

setInterval(fn, interval) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1437](https://docs.videojs.com/component.js.html#line1437)

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:

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.

setTimeout(fn, timeout) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1372](https://docs.videojs.com/component.js.html#line1372)

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:

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.

show()

[component.js](https://docs.videojs.com/component.js.html), [line 846](https://docs.videojs.com/component.js.html#line846)

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

toggleClass(classToToggle, predicateopt)

[component.js](https://docs.videojs.com/component.js.html), [line 838](https://docs.videojs.com/component.js.html#line838)

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

triggerReady()

[component.js](https://docs.videojs.com/component.js.html), [line 722](https://docs.videojs.com/component.js.html#line722)

Trigger all the ready listeners for this Component.

Fires:

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

[component.js](https://docs.videojs.com/component.js.html), [line 938](https://docs.videojs.com/component.js.html#line938)

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:

number | string -

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

Events

componentresize

[component.js](https://docs.videojs.com/component.js.html), [line 1021](https://docs.videojs.com/component.js.html#line1021)

Triggered when a component is resized.

Type:

dispose

[component.js](https://docs.videojs.com/component.js.html), [line 145](https://docs.videojs.com/component.js.html#line145)

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

[component.js](https://docs.videojs.com/component.js.html), [line 739](https://docs.videojs.com/component.js.html#line739)

Triggered when a Component is ready.

Type:

tap

[component.js](https://docs.videojs.com/component.js.html), [line 1269](https://docs.videojs.com/component.js.html#line1269)

Triggered when a Component is tapped.

Type: