Player(tag, optionsopt, readyopt)

An instance of the Player class is created when any of the Video.js setup methods are used to initialize a video.

After an instance has been created it can be accessed globally in two ways:

  1. By calling videojs('example_video_1');
  2. By using it directly via videojs.players.example_video_1;

new Player(tag, optionsopt, readyopt)

Create an instance of this class.

Parameters:
Name Type Attributes Description
tag Element

The original video DOM element used for configuring options.

options Object <optional>

Object of option names and values.

ready Component~ReadyCallback <optional>

Ready callback function.

Extends

Members

static players :Object

Global player list

Methods

static getTagSettings(tag) → {Object}

Gets tag settings

Parameters:
Name Type Description
tag Element

The player tag

Returns:
Object -

An object containing all of the settings for a player tag

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

Find a single DOM element matching a selector. This can be within the Components contentEl() 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. If this.contentEl() returns nothing it falls back to document.

Returns:
Element | null -

the dom element that was found, or null

Inherited From:
See:

$$(selector, contextopt) → {NodeList}

Finds all DOM element matching a selector. This can be within the Components contentEl() 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. If this.contentEl() returns nothing it falls back to document.

Returns:
NodeList -

a list of dom elements that were found

Inherited From:
See:

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

Add a child Component inside the current Component.

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 the Component will get created by this process.

Inherited From:

addClass(classToAdd)

Add a CSS class name to the Components element.

Parameters:
Name Type Description
classToAdd string

CSS class name to add

Inherited From:

addRemoteTextTrack(options, manualCleanupopt) → {HtmlTrackElement}

Create a remote TextTrack and an HTMLTrackElement. It will automatically removed from the video element whenever the source changes, unless manualCleanup is set to false.

Parameters:
Name Type Attributes Default Description
options Object

Options to pass to HTMLTrackElement during creation. See HTMLTrackElement for object properties that you should use.

manualCleanup boolean <optional>
true

if set to false, the TextTrack will be

Returns:
HtmlTrackElement -

the HTMLTrackElement that was created and added to the HtmlTrackElementList and the remote TextTrackList

Deprecated:
  • The default value of the "manualCleanup" parameter will default to "false" in upcoming versions of Video.js

addTextTrack(kindopt, labelopt, languageopt) → {TextTrack|undefined}

A helper method for adding a TextTrack to our TextTrackList.

In addition to the W3C settings we allow adding additional info through options.

Parameters:
Name Type Attributes Description
kind string <optional>

the kind of TextTrack you are adding

label string <optional>

the label to give the TextTrack label

language string <optional>

the language to set on the TextTrack

Returns:
TextTrack | undefined -

the TextTrack that was added or undefined if there is no tech

See:

aspectRatio(ratioopt) → {string|undefined}

A getter/setter for the Player's aspect ratio.

Parameters:
Name Type Attributes Description
ratio string <optional>

The value to set the `Player's aspect ratio to.

Returns:
string | undefined -
  • The current aspect ratio of the Player when getting.
      - undefined when setting

audioTracks() → {AudioTrackList}

Get the AudioTrackList

Returns:
AudioTrackList -

the current audio track list

autoplay(valueopt) → {string}

Get or set the autoplay attribute.

Parameters:
Name Type Attributes Description
value boolean <optional>
  • true means that we should autoplay
     - false means that we should not autoplay
Returns:
string -

The current value of autoplay when getting

blur()

Remove the focus from this component

Inherited From:

buffered() → {TimeRange}

Get a TimeRange object with an array of the times of the video that have been downloaded. If you just want the percent of the video that's been downloaded, use bufferedPercent.

Returns:
TimeRange -

A mock TimeRange object (following HTML spec)

See:

bufferedEnd() → {number}

Get the ending time of the last buffered time range This is used in the progress bar to encapsulate all time ranges.

Returns:
number -

The end of the last buffered time range

bufferedPercent() → {number}

Get the percent (as a decimal) of the video that's been downloaded. This method is not a part of the native HTML video API.

Returns:
number -

A decimal between 0 and 1 representing the percent that is bufferred 0 being 0% and 1 being 100%

abstract buildCSSClass() → {string}

Builds the default DOM class name. Should be overriden by sub-components.

Returns:
string -

The DOM class name for this object.

Inherited From:

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.

Inherited From:
See:

canPlayType(type) → {string}

Check whether the player can play a given mimetype

Parameters:
Name Type Description
type string

The mimetype to check

Returns:
string -

'probably', 'maybe', or '' (empty string)

See:

children() → {Array}

Get an array of all child components

Returns:
Array -

The children

Inherited From:

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!

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.

Inherited From:
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 of window.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.

Inherited From:
See:

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:
Element -

The content element for this Component.

Inherited From:

controls(boolopt) → {boolean}

Get or set whether or not the controls are showing.

Parameters:
Name Type Attributes Description
bool boolean <optional>
  • true to turn controls on
     - false to turn controls off
Fires:
Returns:
boolean -

The current value of controls when getting

createEl() → {Element}

Create the Player's DOM element.

Returns:
Element -

The DOM element that gets created.

Overrides:

createModal(content, optionsopt) → {ModalDialog}

Creates a simple modal dialog (an instance of the ModalDialog component) that immediately overlays the player with arbitrary content and removes itself when closed.

Parameters:
Name Type Attributes Description
content string | function | Element | Array | null

Same as ModalDialog#content's param of the same name. The most straight-forward usage is to provide a string or DOM element.

options Object <optional>

Extra options which will be passed on to the ModalDialog.

Returns:
ModalDialog -

the ModalDialog that was created

currentDimension(widthOrHeight) → {number}

Get the width or the height of the Component elements computed style. 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.

Inherited From:

currentDimensions() → {Component~DimensionObject}

Get an object that contains width and height values of the Components computed style.

Returns:
Component~DimensionObject -

The dimensions of the components element

Inherited From:

currentHeight() → {number}

Get the height of the Components computed style. Uses window.getComputedStyle.

Returns:
number -

height The height of the Components computed style.

Inherited From:

currentSource() → {Tech~SourceObject}

Returns the current source object.

Returns:
Tech~SourceObject -

The current source object

currentSources() → {Array.<Tech~SourceObject>}

Returns all of the current source objects.

Returns:
Array.<Tech~SourceObject> -

The current source objects

currentSrc() → {string}

Returns the fully qualified URL of the current source value e.g. http://mysite.com/video.mp4 Can be used in conjuction with currentType to assist in rebuilding the current source object.

Returns:
string -

The current source

currentTime(secondsopt) → {number}

Get or set the current time (in seconds)

Parameters:
Name Type Attributes Description
seconds number | string <optional>

The time to seek to in seconds

Returns:
number -
  • the current time in seconds when getting

currentType() → {string}

Get the current source type e.g. video/mp4 This can allow you rebuild the current source object so that you could load the same source and tech later

Returns:
string -

The source MIME type

currentWidth() → {number}

Get the width of the Components computed style. Uses window.getComputedStyle.

Returns:
number -

width The width of the Components computed style.

Inherited From:

defaultMuted(defaultMutedopt) → {boolean|Player}

Get the current defaultMuted state, or turn defaultMuted on or off. defaultMuted indicates the state of muted on intial playback.

  var myPlayer = videojs('some-player-id');

  myPlayer.src("http://www.example.com/path/to/video.mp4");

  // get, should be false
  console.log(myPlayer.defaultMuted());
  // set to true
  myPlayer.defaultMuted(true);
  // get should be true
  console.log(myPlayer.defaultMuted());
Parameters:
Name Type Attributes Description
defaultMuted boolean <optional>
  • true to mute
     - false to unmute
Returns:
boolean | Player -
  • true if defaultMuted is on and getting
      - false if defaultMuted is off and getting
      - A reference to the current player when setting

defaultPlaybackRate(rateopt) → {number|Player}

Gets or sets the current default playback rate. A default playback rate of 1.0 represents normal speed and 0.5 would indicate half-speed playback, for instance. defaultPlaybackRate will only represent what the intial playbackRate of a video was, not not the current playbackRate.

Parameters:
Name Type Attributes Description
rate number <optional>

New default playback rate to set.

Returns:
number | Player -
  • The default playback rate when getting or 1.0
      - the player when setting
See:

dimension(dimension, valueopt) → {number}

A getter/setter for the Player's width & height.

Parameters:
Name Type Attributes Description
dimension string

This string can be:

   - 'width'
   - 'height'
value number <optional>

Value for dimension specified in the first argument.

Returns:
number -

The dimension arguments value when getting (width/height).

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 Components element to.

height number | string

Height to set the Components element to.

Inherited From:

dispose()

Destroys the video player and does any necessary cleanup.

This is especially helpful if you are dynamically adding and removing videos to/from the DOM.

Fires:
Overrides:

duration(secondsopt) → {number}

Normally gets the length in time of the video in seconds; in all but the rarest use cases an argument will NOT be passed to the method

NOTE: The video must have started loading before the duration can be known, and in the case of Flash, may not be known until the video starts playing.

Parameters:
Name Type Attributes Description
seconds number <optional>

The duration of the video to set in seconds

Fires:
Returns:
number -
  • The duration of the video in seconds when getting

el() → {Element}

Get the Components DOM element

Returns:
Element -

The DOM element for this Component.

Inherited From:

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
Inherited From:

ended() → {Boolean}

Returns whether or not the player is in the "ended" state.

Returns:
Boolean -

True if the player is in the ended state, false if not.

enterFullWindow()

When fullscreen isn't supported we can stretch the video container to as wide as the browser will let us.

Fires:

error(erropt) → {MediaError|null}

Set or get the current MediaError

Parameters:
Name Type Attributes Description
err MediaError | string | number <optional>

A MediaError or a string/number to be turned into a MediaError

Fires:
Returns:
MediaError | null -

The current MediaError when getting (or null)

exitFullscreen()

Return the video to its normal size after having been in full screen mode

Fires:

exitFullWindow()

Exit full window

Fires:

flexNotSupported_() → {boolean}

Determine wether or not flexbox is supported

Returns:
boolean -
  • true if flexbox is supported
      - false if flexbox is not supported

fluid(boolopt) → {boolean|undefined}

A getter/setter/toggler for the vjs-fluid className on the Player.

Parameters:
Name Type Attributes Description
bool boolean <optional>
  • A value of true adds the class.
     - A value of false removes the class.
     - No value will toggle the fluid class.
Returns:
boolean | undefined -
  • The value of fluid when getting.
      - `undefined` when setting.

focus()

Set the focus to this component

Inherited From:

fullWindowOnEscKey(event)

Check for call to either exit full window or full screen on ESC key

Parameters:
Name Type Description
event string

Event to check for key press

getAttribute(attribute) → {string|null}

Get the value of an attribute on the Components 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.
Inherited From:
See:

getCache() → {Object}

Get object for cached values.

Returns:
Object -

get the current object cache

getChild(name) → {Component|undefined}

Returns the child Component with the given name.

Parameters:
Name Type Description
name string

The name of the child Component to get.

Returns:
Component | undefined -

The child Component with the given name or undefined.

Inherited From:

getChildById(id) → {Component|undefined}

Returns the child Component with the given id.

Parameters:
Name Type Description
id string

The id of the child Component to get.

Returns:
Component | undefined -

The child Component with the given id or undefined.

Inherited From:

getVideoPlaybackQuality() → {Object|undefined}

Gets available media playback quality metrics as specified by the W3C's Media Playback Quality API.

Returns:
Object | undefined -

An object with supported media playback quality metrics or undefined if there is no tech or the tech does not support it.

See:

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 the `Component` does not have the class`
Inherited From:

hasPlugin(name) → {boolean}

Reports whether or not a player has a plugin available.

This does not report whether or not the plugin has ever been initialized on this player. For that, usingPlugin.

Parameters:
Name Type Description
name string

The name of a plugin.

Returns:
boolean -

Whether or not this player has the requested plugin available.

hasStarted(request) → {boolean}

Add/remove the vjs-has-started class

Parameters:
Name Type Description
request boolean
  • true: adds the class
     - false: remove the class
Fires:
Returns:
boolean -

the boolean value of hasStarted_

height(valueopt) → {number}

A getter/setter for the Player's height. Returns the player's configured value. To get the current height use currentheight().

Parameters:
Name Type Attributes Description
value number <optional>

The value to set the Player's heigth to.

Returns:
number -

The current height of the Player when getting.

Overrides:

hide()

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

Inherited From:

id() → {string}

Get this Components ID

Returns:
string -

The id of this Component

Inherited From:

initChildren()

Add and initialize default child Components based upon options.

Inherited From:

isAudio(bool) → {boolean}

Gets or sets the audio flag

Parameters:
Name Type Description
bool boolean
  • true signals that this is an audio player
     - false signals that this is not an audio player
Returns:
boolean -

The current value of isAudio when getting

isFullscreen(isFSopt) → {boolean}

Check if the player is in fullscreen mode or tell the player that it is or is not in fullscreen mode.

NOTE: As of the latest HTML5 spec, isFullscreen is no longer an official property and instead document.fullscreenElement is used. But isFullscreen is still a valuable property for internal player workings.

Parameters:
Name Type Attributes Description
isFS boolean <optional>

Set the players current fullscreen state

Returns:
boolean -
  • true if fullscreen is on and getting
      - false if fullscreen is off and getting

language(codeopt) → {string}

The player's language code NOTE: The language should be set in the player options if you want the the controls to be built with a specific language. Changing the lanugage later will not update controls text.

Parameters:
Name Type Attributes Description
code string <optional>

the language code to set the player to

Returns:
string -

The current language code when getting

languages() → {Array}

Get the player's language dictionary Merge every time, because a newly added plugin might call videojs.addLanguage() at any time Languages specified directly in the player options have precedence

Returns:
Array -

An array of of supported languages

load()

Begin loading the src data.

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 loooks 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:
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.

Inherited From:

loop(valueopt) → {string}

Get or set the loop attribute on the video element.

Parameters:
Name Type Attributes Description
value boolean <optional>
  • true means that we should loop the video
     - false means that we should not loop the video
Returns:
string -

The current value of loop when getting

muted(mutedopt) → {boolean}

Get the current muted state, or turn mute on or off

Parameters:
Name Type Attributes Description
muted boolean <optional>
  • true to mute
     - false to unmute
Returns:
boolean -
  • true if mute is on and getting
      - false if mute is off and getting

name() → {string}

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

Returns:
string -

The name of this Component.

Inherited From:

networkState() → {number}

Returns the current state of network activity for the element, from the codes in the list below.

  • NETWORK_EMPTY (numeric value 0) The element has not yet been initialised. All attributes are in their initial states.
  • NETWORK_IDLE (numeric value 1) The element's resource selection algorithm is active and has selected a resource, but it is not actually using the network at this time.
  • NETWORK_LOADING (numeric value 2) The user agent is actively trying to download data.
  • NETWORK_NO_SOURCE (numeric value 3) The element's resource selection algorithm is active, but it has not yet found a resource to use.
Returns:
number -

the current network activity state

See:

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

Parameters:
Name Type Description
obj Object

The object that contains new options.

Returns:
Object -

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

Inherited From:
Deprecated:
  • since version 5

pause() → {Player}

Pause the video playback

Returns:
Player -

A reference to the player object this function was called on

paused() → {boolean}

Check if the player is paused or has yet to play

Returns:
boolean -
  • false: if the media is currently playing
      - true: if media is not currently playing

play() → {Promise|undefined}

Attempt to begin playback at the first opportunity.

Returns:
Promise | undefined -

Returns a Promise only if the browser returns one and the player is ready to begin playback. For some browsers and all non-ready situations, this will return undefined.

playbackRate(rateopt) → {number}

Gets or sets the current playback rate. A playback rate of 1.0 represents normal speed and 0.5 would indicate half-speed playback, for instance.

Parameters:
Name Type Attributes Description
rate number <optional>

New playback rate to set.

Returns:
number -

The current playback rate when getting or 1.0

See:

played() → {TimeRange}

Get a TimeRange object representing the current ranges of time that the user has played.

Returns:
TimeRange -

A time range object that represents all the increments of time that have been played.

player() → {Player}

Return the Player that the Component has attached to.

Returns:
Player -

The player that this Component has attached to.

Inherited From:

playsinline(valueopt) → {string|Player}

Set or unset the playsinline attribute. Playsinline tells the browser that non-fullscreen playback is preferred.

Parameters:
Name Type Attributes Description
value boolean <optional>
  • true means that we should try to play inline by default
     - false means that we should use the browser's default playback mode,
       which in most cases is inline. iOS Safari is a notable exception
       and plays fullscreen by default.
Returns:
string | Player -
  • the current value of playsinline
      - the player when setting
See:

poster(srcopt) → {string}

Get or set the poster image source url

Parameters:
Name Type Attributes Description
src string <optional>

Poster image source URL

Fires:
Returns:
string -

The current value of poster when getting

preload(valueopt) → {string}

Get or set the preload attribute

Parameters:
Name Type Attributes Description
value boolean <optional>
  • true means that we should preload
     - false maens that we should not preload
Returns:
string -

The preload attribute value when getting

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:
Component -

Returns itself; method can be chained.

Inherited From:

readyState() → {number}

Returns a value that expresses the current state of the element with respect to rendering the current playback position, from the codes in the list below.

  • HAVE_NOTHING (numeric value 0) No information regarding the media resource is available.
  • HAVE_METADATA (numeric value 1) Enough of the resource has been obtained that the duration of the resource is available.
  • HAVE_CURRENT_DATA (numeric value 2) Data for the immediate current playback position is available.
  • HAVE_FUTURE_DATA (numeric value 3) Data for the immediate current playback position is available, as well as enough data for the user agent to advance the current playback position in the direction of playback.
  • HAVE_ENOUGH_DATA (numeric value 4) The user agent estimates that enough data is available for playback to proceed uninterrupted.
Returns:
number -

the current playback rendering state

See:

remainingTime() → {number}

Calculates how much time is left in the video. Not part of the native video API.

Returns:
number -

The time remaining in seconds

remainingTimeDisplay() → {number}

A remaining time function that is intented to be used when the time is to be displayed directly to the user.

Returns:
number -

The rounded time remaining in seconds

remoteTextTrackEls() → {HtmlTrackElementList}

Get the remote HtmlTrackElementList tracks.

Returns:
HtmlTrackElementList -

The current remote text track element list

remoteTextTracks() → {TextTrackList}

Get the remote TextTrackList

Returns:
TextTrackList -

The current remote text track list

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to remove.

Inherited From:
See:

removeChild(component)

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

Parameters:
Name Type Description
component Component

The child Component to remove.

Inherited From:

removeClass(classToRemove)

Remove a CSS class name from the Components element.

Parameters:
Name Type Description
classToRemove string

CSS class name to remove

Inherited From:

removeRemoteTextTrack(track) → {undefined}

Remove a remote TextTrack from the respective TextTrackList and HtmlTrackElementList.

Parameters:
Name Type Description
track Object

Remote TextTrack to remove

Returns:
undefined -

does not return anything

reportUserActivity(event)

Report user activity

Parameters:
Name Type Description
event Object

Event object

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.

Inherited From:
See:

requestFullscreen()

Increase the size of the video to full screen In some browsers, full screen is not supported natively, so it enters "full window mode", where the video fills the browser window. In browsers and devices that support native full screen, sometimes the browser's default controls will be shown, and not the Video.js custom skin. This includes most mobile devices (iOS, Android) and older versions of Safari.

Fires:

reset()

Reset the player. Loads the first tech in the techOrder, and calls reset on the tech`.

scrubbing(isScrubbingopt) → {boolean}

Returns whether or not the user is "scrubbing". Scrubbing is when the user has clicked the progress bar handle and is dragging it along the progress bar.

Parameters:
Name Type Attributes Description
isScrubbing boolean <optional>

wether the user is or is not scrubbing

Returns:
boolean -

The value of scrubbing when getting

seekable() → {TimeRanges}

Returns the TimeRanges of the media that are currently available for seeking to.

Returns:
TimeRanges -

the seekable intervals of the media timeline

seeking() → {Boolean}

Returns whether or not the player is in the "seeking" state.

Returns:
Boolean -

True if the player is in the seeking state, false if not.

selectSource(sources) → {Object|boolean}

Select source based on tech-order or source-order Uses source-order selection if options.sourceOrder is truthy. Otherwise, defaults to tech-order selection

Parameters:
Name Type Description
sources Array

The sources for a media asset

Returns:
Object | boolean -

Object of source and tech order or false

setAttribute(attribute, value)

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

Parameters:
Name Type Description
attribute string

Name of the attribute to set.

value string

Value to set the attribute to.

Inherited From:
See:

setInterval(fn, interval) → {number}

Creates a function that gets run every x milliseconds. This function is a wrapper around window.setInterval. There are a few reasons to use this one instead though.

  1. It gets cleared via Component#clearInterval when Component#dispose gets called.
  2. The function callback will be a Component~GenericCallback
Parameters:
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.

Inherited From:
See:

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

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.

Inherited From:
See:

show()

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

Inherited From:

src(sourceopt) → {string|undefined}

Get or set the video source.

Parameters:
Name Type Attributes Description
source Tech~SourceObject | Array.<Tech~SourceObject> | string <optional>

A SourceObject, an array of SourceObjects, or a string referencing a URL to a media source. It is highly recommended that an object or array of objects is used here, so that source selection algorithms can take the type into account.

   If not provided, this method acts as a getter.
Returns:
string | undefined -

If the source argument is missing, returns the current source URL. Otherwise, returns nothing/undefined.

supportsFullScreen() → {boolean}

Check if current tech can support native fullscreen (e.g. with built in controls like iOS, so not our flash swf)

Returns:
boolean -

if native fullscreen is supported

tech(safetyopt) → {Tech}

Return a reference to the current Tech. It will print a warning by default about the danger of using the tech directly but any argument that is passed in will silence the warning.

Parameters:
Name Type Attributes Description
safety * <optional>

Anything passed in to silence the warning

Returns:
Tech -

The Tech

textTracks() → {TextTrackList}

Get the TextTrackList

Returns:
TextTrackList -

the current text track list

toggleClass(classToToggle, predicateopt)

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

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

Inherited From:

toJSON() → {Object}

returns a JavaScript object reperesenting the current track information. DOES not return it as JSON

Returns:
Object -

Object representing the current of track info

triggerReady()

Trigger all the ready listeners for this Component.

Fires:
Inherited From:

userActive(boolopt) → {boolean}

Get/set if user is active

Parameters:
Name Type Attributes Description
bool boolean <optional>
  • true if the user is active
     - false if the user is inactive
Fires:
Returns:
boolean -

The current value of userActive when getting

usingNativeControls(boolopt) → {boolean}

Toggle native controls on/off. Native controls are the controls built into devices (e.g. default iPhone controls), Flash, or other techs (e.g. Vimeo Controls) This should only be set by the current tech, because only the tech knows if it can support native controls

Parameters:
Name Type Attributes Description
bool boolean <optional>
  • true to turn native controls on
     - false to turn native controls off
Fires:
Returns:
boolean -

The current value of native controls when getting

usingPlugin(name) → {boolean}

Reports whether or not a player is using a plugin by name.

For basic plugins, this only reports whether the plugin has ever been initialized on this player.

Parameters:
Name Type Description
name string

The name of a plugin.

Returns:
boolean -

Whether or not this player is using the requested plugin.

videoHeight() → {number}

Get video height

Returns:
number -

current video height

videoTracks() → {VideoTrackList}

Get the VideoTrackList

Returns:
VideoTrackList -

the current video track list

videoWidth() → {number}

Get video width

Returns:
number -

current video width

volume(percentAsDecimalopt) → {number}

Get or set the current volume of the media

Parameters:
Name Type Attributes Description
percentAsDecimal number <optional>

The new volume as a decimal percent:

    - 0 is muted/0%/off
    - 1.0 is 100%/full
    - 0.5 is half volume or 50%
Returns:
number -

The current volume as a percent when getting

width(valueopt) → {number}

A getter/setter for the Player's width. Returns the player's configured value. To get the current width use currentWidth().

Parameters:
Name Type Attributes Description
value number <optional>

The value to set the Player's width to.

Returns:
number -

The current width of the Player when getting.

Overrides:

Events

beforepluginsetup:$name

Signals that a plugin is about to be set up on a player - by name. The name is the name of the plugin.

Type:

abort

Fires when the loading of an audio/video is aborted.

Type:

beforepluginsetup

Signals that a plugin is about to be set up on a player.

Type:

canplay

The media has a readyState of HAVE_FUTURE_DATA or greater.

Type:

canplaythrough

The media has a readyState of HAVE_ENOUGH_DATA or greater. This means that the entire media file can be played without buffering.

Type:

componentresize

Triggered when a component is resized.

Type:
Inherited From:

controlsdisabled

Type:

controlsenabled

Type:

dispose

Called when the player is being disposed of.

Type:
Listeners of This Event:
Overrides:

durationchange

Type:
Listeners of This Event:

emptied

Fires when the current playlist is empty.

Type:

ended

Fired when the end of the media resource is reached (currentTime == duration)

Type:
Listeners of This Event:

enterFullWindow

Type:

error

Type:

exitFullWindow

Type:

firstplay

Fired the first time a video is played. Not part of the HLS spec, and this is probably not the best implementation yet, so use sparingly. If you don't have a reason to prevent playback, use myPlayer.one('play'); instead.

Type:
Deprecated:
  • As of 6.0 firstplay event is deprecated.

fullscreenchange

Fired when going in and out of fullscreen.

Type:
Listeners of This Event:

fullscreenchange

Type:

fullscreenchange

Type:

fullscreenchange

Type:

loadeddata

Fires when the browser has loaded the current frame of the audio/video.

Type:
  • event

loadeddata

Fired when the player has downloaded data at the current playback position

Type:

loadedmetadata

Fires when the browser has loaded meta data for the audio/video.

Type:
Listeners of This Event:

loadedmetadata

Fired when the player has initial duration and dimension information

Type:

loadstart

Fired when the user agent begins looking for media data

Type:
Listeners of This Event:

pause

Fired whenever the media has been paused

Type:
Listeners of This Event:

play

Triggered whenever an Tech#play event happens. Indicates that playback has started or resumed.

Type:
Listeners of This Event:

playing

The media is no longer blocked from playback, and has started playing.

Type:

pluginsetup

Signals that a plugin has just been set up on a player.

Type:

posterchange

This event fires when the poster image is changed on the player.

Type:
Listeners of This Event:

progress

Fired while the user agent is downloading media data.

Type:
Listeners of This Event:

ratechange

Fires when the playing speed of the audio/video is changed

Type:
  • event
Listeners of This Event:

ready

Triggered when a Component is ready.

Type:
Inherited From:

resize

Fires when the video's intrinsic dimensions change

Type:
  • event

seeked

Fired when the player has finished jumping to a new time

Type:
Listeners of This Event:

seeking

Fired whenever the player is jumping to a new time

Type:

stalled

Fires when the browser is trying to get media data, but data is not available.

Type:

suspend

Fires when the browser is intentionally not getting media data.

Type:

tap

Triggered when a Component is tapped.

Type:
Inherited From:

textdata

Fires when we get a textdata event from tech

Type:

texttrackchange

Fires when the text track has been changed

Type:
  • event
Listeners of This Event:

timeupdate

Fired when the current playback position has changed * During playback this is fired every 15-250 milliseconds, depending on the playback technology in use.

Type:
Listeners of This Event:

timeupdate

Fires when the current playback position has changed.

Type:
  • event

useractive

Type:

userinactive

Type:

usingcustomcontrols

player is using the custom HTML controls

Type:

usingnativecontrols

player is using the native device controls

Type:

volumechange

Fires when the volume has been changed

Type:
  • event
Listeners of This Event:

volumechange

Fired when the volume changes

Type:

waiting

A readyState change on the DOM element has caused playback to stop.

Type:

pluginsetup:$name

Signals that a plugin has just been set up on a player - by name. The name is the name of the plugin.

Type: