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)
player.js, line 304

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
player.js, line 4828

Global enumeration of players.

The keys are the player IDs and the values are either the Player instance or null for disposed players.

crossorigin
player.js, line 4818

Get or set the Player's crossorigin option. For the HTML5 player, this sets the crossOrigin property on the <video> tag to control the CORS behavior.

See:

Methods

static getTagSettings(tag) → {Object}
player.js, line 4668

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}
component.js, line 777

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

Overrides:
See:

$$(selector, contextopt) → {NodeList}
component.js, line 799

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

Overrides:
See:

addChild(child, optionsopt, indexopt) → {Component}
component.js, line 468

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.

Overrides:

addClass(classToAdd)
component.js, line 823

Add a CSS class name to the Components element.

Parameters:
Name Type Description
classToAdd string

CSS class name to add
Overrides:

addRemoteTextTrack(options, manualCleanupopt) → {HtmlTrackElement}
player.js, line 4208

Create a remote TextTrack and an HTMLTrackElement. When manualCleanup is set to false, the track will be automatically removed on source changes.

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 removed on a source change
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}
player.js, line 4182

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}
player.js, line 970

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}
player.js, line 4749

Get the AudioTrackList

Returns:
AudioTrackList -

the current audio track list

autoplay(valueopt) → {boolean|string}
player.js, line 3587

Get or set the autoplay option. When this is a boolean it will modify the attribute on the tech. When this is a string the attribute on the tech will be removed and Player will handle autoplay on loadstarts.

Parameters:
Name Type Attributes Description
value boolean | string <optional>
  • true: autoplay using the browser behavior - false: do not autoplay - 'play': call play() on every loadstart - 'muted': call muted() then play() on every loadstart - 'any': call play() on every loadstart. if that fails call muted() then play(). - *: values other than those listed here will be set autoplay to true
Returns:
boolean | string -

The current value of autoplay when getting

blur()
component.js, line 1163

Remove the focus from this component

Overrides:

breakpoints(breakpointsopt) → {Object}
player.js, line 4448

Get or set breakpoints on the player.

Calling this method with an object or true will remove any previous custom breakpoints and start from the defaults again.

Parameters:
Name Type Attributes Description
breakpoints Object | boolean <optional>

If an object is given, it can be used to provide custom breakpoints. If true is given, will set default breakpoints. If this argument is not given, will simply return the current breakpoints.

Properties
Name Type Attributes Description
tiny number <optional>

The maximum width for the "vjs-layout-tiny" class.
xsmall number <optional>

The maximum width for the "vjs-layout-x-small" class.
small number <optional>

The maximum width for the "vjs-layout-small" class.
medium number <optional>

The maximum width for the "vjs-layout-medium" class.
large number <optional>

The maximum width for the "vjs-layout-large" class.
xlarge number <optional>

The maximum width for the "vjs-layout-x-large" class.
huge number <optional>

The maximum width for the "vjs-layout-huge" class.
Returns:
Object -

An object mapping breakpoint names to maximum width values.

buffered() → {TimeRange}
player.js, line 2578

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}
player.js, line 2607

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}
player.js, line 2596

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 buffered 0 being 0% and 1 being 100%

abstract buildCSSClass() → {string}
component.js, line 694

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

Returns:
string -

The DOM class name for this object.

Overrides:

cancelAnimationFrame(id) → {number}
component.js, line 1548

Cancels a queued callback passed to Component#requestAnimationFrame (rAF).

If you queue an rAF callback via Component#requestAnimationFrame, use this function instead of window.cancelAnimationFrame. If you don't, your dispose listener will not get cleaned up until Component#dispose!

Parameters:
Name Type Description
id number

The rAF ID to clear. The return value of Component#requestAnimationFrame.
Returns:
number -

Returns the rAF ID that was cleared.

Overrides:
See:

canPlayType(type) → {string}
player.js, line 3193

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}
component.js, line 385

Get an array of all child components

Returns:
Array -

The children

Overrides:

clearInterval(intervalId) → {number}
component.js, line 1474

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.

Overrides:
See:

clearTimeout(timeoutId) → {number}
component.js, line 1418

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.

Overrides:
See:

contentEl() → {Element}
component.js, line 354

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:

controls(boolopt) → {boolean}
player.js, line 3748

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}
player.js, line 634

Create the Player's DOM element.

Returns:
Element -

The DOM element that gets created.

Overrides:

createModal(content, optionsopt) → {ModalDialog}
player.js, line 4346

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

crossOrigin(valueopt) → {string|undefined}
player.js, line 802

Get or set the Player's crossOrigin option. For the HTML5 player, this sets the crossOrigin property on the <video> tag to control the CORS behavior.

Parameters:
Name Type Attributes Description
value string <optional>

The value to set the Player's crossOrigin to. If an argument is given, must be one of anonymous or use-credentials.
Returns:
string | undefined -
  • The current crossOrigin value of the Player when getting. - undefined when setting
See:

currentBreakpoint() → {string}
player.js, line 4518

Get current breakpoint name, if any.

Returns:
string -

If there is currently a breakpoint set, returns a the key from the breakpoints object matching it. Otherwise, returns an empty string.

currentBreakpointClass() → {string}
player.js, line 4530

Get the current breakpoint class name.

Returns:
string -

The matching class name (e.g. "vjs-layout-tiny" or "vjs-layout-large") for the current breakpoint. Empty string if there is no current breakpoint.

currentDimension(widthOrHeight) → {number}
component.js, line 1076

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

Uses window.getComputedStyle.

Parameters:
Name Type Description
widthOrHeight string

A string containing 'width' or 'height'. Whichever one you want to get.
Returns:
number -

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

Overrides:

currentDimensions() → {Component~DimensionObject}
component.js, line 1122

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:

currentHeight() → {number}
component.js, line 1149

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed height of the component's element.

Overrides:

currentSource() → {Tech~SourceObject}
player.js, line 3525

Returns the current source object.

Returns:
Tech~SourceObject -

The current source object

currentSources() → {Array.<Tech~SourceObject>}
player.js, line 3507

Returns all of the current source objects.

Returns:
Array.<Tech~SourceObject> -

The current source objects

currentSrc() → {string}
player.js, line 3536

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

Returns:
string -

The current source

currentTime(secondsopt) → {number}
player.js, line 2457

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}
player.js, line 3548

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}
component.js, line 1137

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed width of the component's element.

Overrides:

defaultMuted(defaultMutedopt) → {boolean|Player}
player.js, line 2697

Get the current defaultMuted state, or turn defaultMuted on or off. defaultMuted indicates the state of muted on initial 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}
player.js, line 4131

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 initial 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}
player.js, line 859

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)
component.js, line 979

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

disablePictureInPicture(value)
player.js, line 2996

Disable Picture-in-Picture mode.

Parameters:
Name Type Description
value boolean
  • true will disable Picture-in-Picture mode - false will enable Picture-in-Picture mode

dispose()
player.js, line 563

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:

documentFullscreenChange_()
player.js, line 2044

when the document fschange event triggers it calls this

duration(secondsopt) → {number}
player.js, line 2508

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}
component.js, line 255

Get the Components DOM element

Returns:
Element -

The DOM element for this Component.

Overrides:

enableTouchActivity()
component.js, line 1317

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:

ended() → {Boolean}
player.js, line 4889

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()
player.js, line 2924

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}
player.js, line 3857

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()
player.js, line 2867

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

Fires:

exitFullWindow()
player.js, line 2969

Exit full window

Fires:

exitPictureInPicture() → {Promise}
player.js, line 3059

Exit Picture-in-Picture mode.

Fires:
Returns:
Promise -

A promise.

See:

fill(boolopt) → {boolean|undefined}
player.js, line 935

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

Turning this on will turn off fluid mode.

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 be a getter.
Returns:
boolean | undefined -
  • The value of fluid when getting. - undefined when setting.

flexNotSupported_() → {boolean}
player.js, line 4725

Determine whether or not flexbox is supported

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

fluid(boolopt) → {boolean|undefined}
player.js, line 898

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

Turning this on will turn off fill mode.

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 be a getter.
Returns:
boolean | undefined -
  • The value of fluid when getting. - undefined when setting.

focus()
component.js, line 1156

Set the focus to this component

Overrides:

fullWindowOnEscKey(event)
player.js, line 2954

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}
component.js, line 903

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.
Overrides:
See:

getCache() → {Object}
player.js, line 2169

Get object for cached values.

Returns:
Object -

get the current object cache

getChild(name) → {Component|undefined}
component.js, line 411

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.

Overrides:

getChildById(id) → {Component|undefined}
component.js, line 398

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.

Overrides:

getDescendant(…names) → {Component|undefined}
component.js, line 433

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:
Name Type Attributes Description
names ...Array.<string> | string <repeatable>

The name of the child Component to get.
Returns:
Component | undefined -

The descendant Component following the given descendant names or undefined.

Overrides:

getMedia() → {Player~MediaObject}
player.js, line 4631

Get a clone of the current Player~MediaObject for this player.

If the loadMedia method has not been used, will attempt to return a Player~MediaObject based on the current state of the player.

Returns:
Player~MediaObject

getVideoPlaybackQuality() → {Object|undefined}
player.js, line 4249

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:

handleHotkeys(event)
player.js, line 3144

Called when this Player receives a hotkey keydown event. Supported player-wide hotkeys are:

f - toggle fullscreen m - toggle mute k or Space - toggle play/pause

Parameters:
Name Type Description
event EventTarget~Event

The keydown event that caused this function to be called.

handleKeyDown(event)
player.js, line 3082

Called when this Player has focus and a key gets pressed down, or when any Component of this player receives a key press that it doesn't handle. This allows player-wide hotkeys (either as defined below, or optionally by an external function).

Parameters:
Name Type Description
event EventTarget~Event

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

handleKeyPress(event)
component.js, line 1193

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:
Name Type Description
event EventTarget~Event

The event that caused this function to be called.
Overrides:

hasClass(classToCheck) → {boolean}
component.js, line 813

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`
Overrides:

hasPlugin(name) → {boolean}
player.js, line 4998

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}
player.js, line 1613

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}
player.js, line 841

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()
component.js, line 864

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

Overrides:

id() → {string}
component.js, line 364

Get this Components ID

Returns:
string -

The id of this Component

Overrides:

initChildren()
component.js, line 591

Add and initialize default child Components based upon options.

Overrides:

isAudio(bool) → {boolean}
player.js, line 4152

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

isDisposed() → {boolean}
component.js, line 215

Determine whether or not this component has been disposed.

Returns:
boolean -

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

Overrides:

isFullscreen(isFSopt) → {boolean}
player.js, line 2752

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

isInPictureInPicture(isPiPopt) → {boolean}
player.js, line 3016

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

Parameters:
Name Type Attributes Description
isPiP boolean <optional>

Set the players current Picture-in-Picture state
Returns:
boolean -
  • true if Picture-in-Picture is on and getting - false if Picture-in-Picture is off and getting

language(codeopt) → {string}
player.js, line 4285

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 language 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}
player.js, line 4301

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()
player.js, line 3423

Begin loading the src data.

loadMedia(media, ready)
player.js, line 4588

Populate the player using a MediaObject.

Parameters:
Name Type Description
media Player~MediaObject

A media object.
ready function

A callback to be called when the player is ready.

localize(string, tokensopt, defaultValueopt) → {string}
component.js, line 316

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:
Name Type Attributes Description
string string

The string to localize and the key to lookup in the language files.
tokens Array.<string> <optional>

If the current item has token replacements, provide the tokens here.
defaultValue string <optional>

Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.
Returns:
string -

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

Overrides:

loop(valueopt) → {boolean}
player.js, line 3657

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

The current value of loop when getting

manualAutoplay_()
player.js, line 1401

Handle autoplay string values, rather than the typical boolean values that should be handled by the tech. Note that this is not part of any specification. Valid values and what they do can be found on the autoplay getter at Player#autoplay()

muted(mutedopt) → {boolean}
player.js, line 2663

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}
component.js, line 375

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:

networkState() → {number}
player.js, line 4911

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}
component.js, line 240

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.

Overrides:

pause() → {Player}
player.js, line 2395

Pause the video playback

Returns:
Player -

A reference to the player object this function was called on

paused() → {boolean}
player.js, line 2406

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}
player.js, line 2294

Attempt to begin playback at the first opportunity.

Returns:
Promise | undefined -

Returns a promise if the browser supports Promises (or one was passed in as an option). This promise will be resolved on the return value of play. If this is undefined it will fulfill the promise chain otherwise the promise chain will be fulfilled when the promise from play is fulfilled.

playbackRate(rateopt) → {number}
player.js, line 4102

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}
player.js, line 2419

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}
component.js, line 225

Return the Player that the Component has attached to.

Returns:
Player -

The player that this Component has attached to.

Overrides:

playsinline(valueopt) → {string|Player}
player.js, line 3638

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}
player.js, line 3677

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}
player.js, line 3562

Get or set the preload attribute

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

The preload attribute value when getting

ready() → {Component}
component.js, line 708

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:

readyState() → {number}
player.js, line 4932

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}
player.js, line 2550

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}
player.js, line 2561

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}
player.js, line 4779

Get the remote HtmlTrackElementList tracks.

Returns:
HtmlTrackElementList -

The current remote text track element list

remoteTextTracks() → {TextTrackList}
player.js, line 4770

Get the remote TextTrackList

Returns:
TextTrackList -

The current remote text track list

removeAttribute(attribute)
component.js, line 930

Remove an attribute from the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to remove.
Overrides:
See:

removeChild(component)
component.js, line 552

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

removeClass(classToRemove)
component.js, line 833

Remove a CSS class name from the Components element.

Parameters:
Name Type Description
classToRemove string

CSS class name to remove
Overrides:

removeRemoteTextTrack(track) → {undefined}
player.js, line 4224

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)
player.js, line 3913

Report user activity

Parameters:
Name Type Description
event Object

Event object

requestAnimationFrame(fn) → {number}
component.js, line 1508

Queues up a callback to be passed to requestAnimationFrame (rAF), but with a few extra bonuses:

  • Supports browsers that do not support rAF by falling back to Component#setTimeout.

  • The callback is turned into a Component~GenericCallback (i.e. bound to the component).

  • Automatic cancellation of the rAF callback is handled if the component is disposed before it is called.

Parameters:
Name Type Description
fn Component~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.
Listens to Events:
Returns:
number -

Returns an rAF ID that gets used to identify the timeout. It can also be used in Component#cancelAnimationFrame to cancel the animation frame callback.

Overrides:
See:

requestFullscreen(fullscreenOptionsopt)
player.js, line 2789

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.

Parameters:
Name Type Attributes Description
fullscreenOptions Object <optional>

Override the player fullscreen options
Fires:

requestPictureInPicture() → {Promise}
player.js, line 3037

Create a floating video window always on top of other windows so that users may continue consuming media while they interact with other content sites, or applications on their device.

Fires:
Returns:
Promise -

A promise with a Picture-in-Picture window.

See:

reset()
player.js, line 3432

Reset the player. Loads the first tech in the techOrder, removes all the text tracks in the existing tech, and calls reset on the tech.

resetControlBarUI_()
player.js, line 3462

Reset Control Bar's UI by calling sub-methods that reset all of Control Bar's components

resetPlaybackRate_()
player.js, line 3488

Reset Playback ratio

resetProgressBar_()
player.js, line 3471

Reset tech's progress so progress bar is reset in the UI

resetVolumeBar_()
player.js, line 3496

Reset Volume bar

responsive(value) → {boolean}
player.js, line 4478

Get or set a flag indicating whether or not this player should adjust its UI based on its dimensions.

Parameters:
Name Type Description
value boolean

Should be true if the player should adjust its UI based on its dimensions; otherwise, should be false.
Returns:
boolean -

Will be true if this player should adjust its UI based on its dimensions; otherwise, will be false.

runPlayCallbacks_(val)
player.js, line 2377

When a callback to play is delayed we have to run these callbacks when play is actually called on the tech. This function runs the callbacks that were delayed and accepts the return value from the tech.

Parameters:
Name Type Description
val undefined | Promise

The return value from the tech.

runPlayTerminatedQueue_()
player.js, line 2358

These functions will be run when if play is terminated. If play runPlayCallbacks_ is run these function will not be run. This allows us to differenciate between a terminated play and an actual call to play.

scrubbing(isScrubbingopt) → {boolean}
player.js, line 2434

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>

whether the user is or is not scrubbing
Returns:
boolean -

The value of scrubbing when getting

seekable() → {TimeRanges}
player.js, line 4903

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

Returns:
TimeRanges -

the seekable intervals of the media timeline

seeking() → {Boolean}
player.js, line 4896

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}
player.js, line 3237

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)
component.js, line 918

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.
Overrides:
See:

setInterval(fn, interval) → {number}
component.js, line 1447

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.

Overrides:
See:

setTimeout(fn, timeout) → {number}
component.js, line 1382

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

The function that will be run after timeout.
timeout number

Timeout in milliseconds to delay before executing the specified function.
Listens to Events:
Returns:
number -

Returns a timeout ID that gets used to identify the timeout. It can also get used in Component#clearTimeout to clear the timeout that was set.

Overrides:
See:

show()
component.js, line 856

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

Overrides:

src(sourceopt) → {string|undefined}
player.js, line 3311

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}
player.js, line 2733

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}
player.js, line 1260

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}
player.js, line 4759

Get the TextTrackList

Returns:
TextTrackList -

the current text track list

toggleClass(classToToggle, predicateopt)
component.js, line 848

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

toJSON() → {Object}
player.js, line 4312

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()
component.js, line 732

Trigger all the ready listeners for this Component.

Fires:
Overrides:

updateSourceCaches_(srcObj)
player.js, line 1465

Update the internal source caches so that we return the correct source from src(), currentSource(), and currentSources().

Note: currentSources will not be updated if the source that is passed in exists in the current currentSources cache.

Parameters:
Name Type Description
srcObj Tech~SourceObject

A string or object source to update our caches to.

userActive(boolopt) → {boolean}
player.js, line 3930

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}
player.js, line 3808

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}
player.js, line 5012

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}
player.js, line 4269

Get video height

Returns:
number -

current video height

videoTracks() → {VideoTrackList}
player.js, line 4739

Get the VideoTrackList

Returns:
VideoTrackList -

the current video track list

videoWidth() → {number}
player.js, line 4259

Get video width

Returns:
number -

current video width

volume(percentAsDecimalopt) → {number}
player.js, line 2631

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}
player.js, line 827

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:

Type Definitions

MediaObject
player.js, line 4534

An object that describes a single piece of media.

Properties that are not part of this type description will be retained; so, this can be viewed as a generic metadata storage mechanism as well.

Properties:
Name Type Attributes Description
album string <optional>

Unused, except if this object is passed to the MediaSession API.
artist string <optional>

Unused, except if this object is passed to the MediaSession API.
artwork Array.<Object> <optional>

Unused, except if this object is passed to the MediaSession API. If not specified, will be populated via the poster, if available.
poster string <optional>

URL to an image that will display before playback.
src Tech~SourceObject | Array.<Tech~SourceObject> | string <optional>

A single source object, an array of source objects, 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.
title string <optional>

Unused, except if this object is passed to the MediaSession API.
textTracks Array.<Object> <optional>

An array of objects to be used to create text tracks, following the native track element format. For ease of removal, these will be created as "remote" text tracks and set to automatically clean up on source changes.

      These objects may have properties like `src`, `kind`, `label`,
      and `language`, see Tech#createRemoteTextTrack.
See:

Events

beforepluginsetup:$name
plugin.js, line 485

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
player.js, line 75

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

Type:

beforepluginsetup
plugin.js, line 478

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

Type:

canplay
player.js, line 1724

The media has a readyState of HAVE_FUTURE_DATA or greater.

Type:

canplaythrough
player.js, line 1742

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
component.js, line 1031

Triggered when a component is resized.

Type:
Overrides:

controlsdisabled
player.js, line 3780

Type:

controlsenabled
player.js, line 3769

Type:

dispose
player.js, line 564

Called when the player is being disposed of.

Type:
Listeners of This Event:
Overrides:

durationchange
player.js, line 2534

Type:
Listeners of This Event:

emptied
player.js, line 107

Fires when the current playlist is empty.

Type:

ended
player.js, line 1872

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

Type:
Listeners of This Event:

enterFullWindow
player.js, line 2940

Type:

enterpictureinpicture
player.js, line 3039

This event fires when the player enters picture in picture mode

Type:
Listeners of This Event:

error
player.js, line 3898

Type:

exitFullWindow
player.js, line 2982

Type:

firstplay
player.js, line 1825

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
player.js, line 2762

Type:
Listeners of This Event:

leavepictureinpicture
player.js, line 3061

This event fires when the player leaves picture in picture mode

Type:
Listeners of This Event:

loadeddata
player.js, line 154

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

Type:
  • event

loadeddata
player.js, line 4975

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

Type:

loadedmetadata
player.js, line 138

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

Type:
Listeners of This Event:

loadedmetadata
player.js, line 4968

Fired when the player has initial duration and dimension information

Type:

loadstart
player.js, line 1376

Fired when the user agent begins looking for media data

Type:
Listeners of This Event:

pause
player.js, line 1847

Fired whenever the media has been paused

Type:
Listeners of This Event:

play
player.js, line 1648

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

Type:
Listeners of This Event:

playerresize
resize-manager.js, line 107

Called when the player size has changed

Type:

playing
player.js, line 1761

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

Type:

pluginsetup
plugin.js, line 493

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

Type:

posterchange
player.js, line 3701

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

Type:
Listeners of This Event:

progress
player.js, line 59

Fired while the user agent is downloading media data.

Type:
Listeners of This Event:

ratechange
player.js, line 1675

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

Type:
  • event
Listeners of This Event:

ready
component.js, line 749

Triggered when a Component is ready.

Type:
Overrides:

resize
player.js, line 186

Fires when the video's intrinsic dimensions change

Type:
  • event

seeked
player.js, line 1798

Fired when the player has finished jumping to a new time

Type:
Listeners of This Event:

seeking
player.js, line 1779

Fired whenever the player is jumping to a new time

Type:

sourceset
player.js, line 1517

EXPERIMENTAL Fired when the source is set or changed on the Tech causing the media element to reload.

It will fire for the initial source and each subsequent source. This event is a custom event from Video.js and is triggered by the Tech.

The event object for this event contains a src property that will contain the source that was available when the event was triggered. This is generally only necessary if Video.js is switching techs while the source was being changed.

It is also fired when load is called on the player (or media element) because the specification for load says that the resource selection algorithm needs to be aborted and restarted. In this case, it is very likely that the src property will be set to the empty string "" to indicate we do not know what the source will be but that it is changing.

This event is currently still experimental and may change in minor releases. To use this, pass enableSourceset option to the player.

Type:
Properties:
Name Type Description
src string

The source url available when the sourceset was triggered. It will be an empty string if we cannot know what the source is but know that the source will change.

stalled
player.js, line 122

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

Type:

suspend
player.js, line 91

Fires when the browser is intentionally not getting media data.

Type:

tap
component.js, line 1279

Triggered when a Component is tapped.

Type:
Overrides:

textdata
player.js, line 2154

Fires when we get a textdata event from tech

Type:

texttrackchange
player.js, line 218

Fires when the text track has been changed

Type:
  • event
Listeners of This Event:

timeupdate
player.js, line 170

Fires when the current playback position has changed.

Type:
  • event
Listeners of This Event:

timeupdate
player.js, line 4982

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:

useractive
player.js, line 3947

Type:

userinactive
player.js, line 3973

Type:

usingcustomcontrols
player.js, line 3835

player is using the custom HTML controls

Type:

usingnativecontrols
player.js, line 3825

player is using the native device controls

Type:

volumechange
player.js, line 202

Fires when the volume has been changed

Type:
  • event
Listeners of This Event:

volumechange
player.js, line 4991

Fired when the volume changes

Type:

waiting
player.js, line 1693

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

Type:

pluginsetup:$name
plugin.js, line 500

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

Type: