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

• Button

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:

Returns:

Element | null -

the dom element that was found, or null

• Overrides:

  • Button#$

  See:

  • Information on CSS Selectors

$$(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:

Returns:

NodeList -

a list of dom elements that were found

• Overrides:

  • Button#$$

  See:

  • Information on CSS Selectors

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:

Returns:

Component -

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

• Overrides:

  • Button#addChild

  Deprecated:

  • since version 5

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:

• Overrides:

  • Button#addClass

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

• Overrides:

  • Button#blur

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

• Overrides:

  • Button#buildCSSClass

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:

Returns:

number -

Returns the rAF ID that was cleared.

• Overrides:

  • Button#cancelAnimationFrame

  See:

  • Similar to

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:

• Overrides:

  • Button#cancelNamedAnimationFrame

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

• Overrides:

  • Button#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:

Returns:

number -

Returns the interval id that was cleared.

• Overrides:

  • Button#clearInterval

  See:

  • Similar to

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:

Returns:

number -

Returns the timeout id that was cleared.

• Overrides:

  • Button#clearTimeout

  See:

  • Similar to

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.

• Overrides:

  • Button#contentEl

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:

Returns:

string -

• The control text when getting

• Overrides:

  • Button#controlText

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:

Returns:

Element -

The control text element that gets created.

• Overrides:

  • Button#createControlTextEl

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:

Returns:

Element -

The element that gets created.

• Overrides:

  • Button#createEl

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:

Returns:

number -

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

• Overrides:

  • Button#currentDimension

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.

• Overrides:

  • Button#currentDimensions

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.

• Overrides:

  • Button#currentHeight

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.

• Overrides:

  • Button#currentWidth

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:

Fires:

• Component#event:componentresize

Returns:

number -

The dimension when getting or 0 if unset

• Overrides:

  • Button#dimension

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:

• Overrides:

  • Button#dimensions

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.

• Overrides:

  • Button#disable

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:

• Component#event:dispose

• Overrides:

  • Button#dispose

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.

• Overrides:

  • Button#el

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.

• Overrides:

  • Button#enable

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:

  • Button#enableTouchActivity

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

• Overrides:

  • Button#focus

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:

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:

  • Button#getAttribute

  See:

  • DOM API

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:

Returns:

Component | undefined -

The child Component with the given name or undefined.

• Overrides:

  • Button#getChild

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:

Returns:

Component | undefined -

The child Component with the given id or undefined.

• Overrides:

  • Button#getChildById

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:

Returns:

Component | undefined -

The descendant Component following the given descendant names or undefined.

• Overrides:

  • Button#getDescendant

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:

Listens to Events:

• event:tap

• event:click

• Overrides:

  • Button#handleClick

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:

Listens to Events:

• event:keydown

• Overrides:

  • Button#handleKeyDown

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:

• Overrides:

  • Button#handleKeyPress

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

• Overrides:

  • Button#handleLanguagechange

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:

Returns:

boolean -

• True if the Component has the class. - False if the Component does not have the class`

• Overrides:

  • Button#hasClass

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:

Returns:

number | string -

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

• Overrides:

  • Button#height

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.

• Overrides:

  • Button#hide

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

• Overrides:

  • Button#id

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.

• Overrides:

  • Button#initChildren

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.

• Overrides:

  • Button#isDisposed

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.

{
  "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:

Returns:

string -

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

• Overrides:

  • Button#localize

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.

• Overrides:

  • Button#name

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:

Returns:

Object -

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

• Overrides:

  • Button#options

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.

• Overrides:

  • Button#player

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.

• Overrides:

  • Button#ready

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:

• Overrides:

  • Button#removeAttribute

  See:

  • DOM API

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:

• Overrides:

  • Button#removeChild

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:

• Overrides:

  • Button#removeClass

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:

Listens to Events:

• Component#event:dispose

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:

  • Button#requestAnimationFrame

  See:

  • Similar to

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:

• Overrides:

  • Button#requestNamedAnimationFrame

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:

• Overrides:

  • Button#setAttribute

  See:

  • DOM API

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:

Listens to Events:

• Component#event:dispose

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:

  • Button#setInterval

  See:

  • Similar to

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:

Listens to Events:

• Component#event:dispose

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:

  • Button#setTimeout

  See:

  • Similar to

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.

• Overrides:

  • Button#show

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.

• classToToggle gets added when Component#hasClass would return false.
• classToToggle gets removed when Component#hasClass would return true.

Parameters:

• Overrides:

  • Button#toggleClass

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:

• Component#event:ready

• Overrides:

  • Button#triggerReady

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:

Returns:

number | string -

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

• Overrides:

  • Button#width

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:

• EventTarget~Event

• Overrides:

  • Button#event:componentresize

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:

• EventTarget~Event

Properties:

• Overrides:

  • Button#event:dispose

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:

• EventTarget~Event

• Overrides:

  • Button#event:ready

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:

• EventTarget~Event

• Overrides:

  • Button#event:tap