Classes

AudioTrack

EventTarget

TextTrack

VideoTrack

Members

static module:videojs~videojs.bindfunction

Deprecated reference to the fn.bind_ function

Deprecated

• Deprecated and will be removed in 9.0. Please use native Function.prototype.bind instead.

See:

• fn.bind_

static module:videojs~videojs.browserObject

A reference to the browser utility module as an object.

See:

• browser

static module:videojs~videojs.createTimeRangefunction

Deprecated reference to the createTimeRanges function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.time.createTimeRanges instead.

See:

• createTimeRanges

static module:videojs~videojs.createTimeRangesfunction

Deprecated reference to the createTimeRanges function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.time.createTimeRanges instead.

See:

• createTimeRanges

static module:videojs~videojs.defineLazyPropertyfunction

Deprecated reference to the defineLazyProperty function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.obj.defineLazyProperty instead.

See:

• defineLazyProperty

static module:videojs~videojs.domObject

A reference to the DOM utility module as an object.

See:

• dom

static module:videojs~videojs.fnObject

A reference to the fn utility module as an object.

See:

• fn

static module:videojs~videojs.formatTimefunction

Deprecated reference to the formatTime function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.time.format instead.

See:

• formatTime

static module:videojs~videojs.isCrossOriginfunction

Deprecated reference to the Url.isCrossOrigin function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.url.isCrossOrigin instead.

See:

• isCrossOrigin

static module:videojs~videojs.logfunction

A reference to the log utility module as an object.

See:

• log

static module:videojs~videojs.mergeOptionsfunction

Deprecated reference to the merge function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.obj.merge instead.

See:

• merge

static module:videojs~videojs.numObject

A reference to the num utility module as an object.

See:

• num

static module:videojs~videojs.objObject

A reference to the obj utility module as an object.

See:

• obj

static module:videojs~videojs.optionsObject

The global options object. These are the settings that take effect if no overrides are specified when the player is created.

static module:videojs~videojs.parseUrlfunction

Deprecated reference to the Url.parseUrl function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.url.parseUrl instead.

See:

• parseUrl

static module:videojs~videojs.playersObject

Global enumeration of players.

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

static module:videojs~videojs.resetFormatTimefunction

Deprecated reference to the resetFormatTime function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.time.resetFormat instead.

See:

• resetFormatTime

static module:videojs~videojs.setFormatTimefunction

Deprecated reference to the setFormatTime function

Deprecated

• Deprecated and will be removed in 9.0. Please use videojs.time.setFormat instead.

See:

• setFormatTime

static module:videojs~videojs.strObject

A reference to the str utility module as an object.

See:

• str

static module:videojs~videojs.timeObject

A reference to the time utility module as an object.

See:

• time

static module:videojs~videojs.urlObject

A reference to the URL utility module as an object.

See:

• url

static module:videojs~videojs.VERSIONstring

Current Video.js version. Follows semantic versioning.

Methods

staticmodule:videojs~videojs.addLanguage(code, data){Object}

Adding languages so that they're available to all players. Example: videojs.addLanguage('es', { 'Hello': 'Hola' });

Name	Type	Description
code	string	The language code or dictionary property
data	Object	The data values to be translated

Returns:

Type	Description
Object	The resulting language dictionary object

staticmodule:videojs~videojs.deregisterPlugin(name)

De-register a Video.js plugin.

Name	Type	Description
name	string	The name of the plugin to be de-registered. Must be a string that matches an existing plugin.

Throws:

Type	When
Error	If an attempt is made to de-register the base plugin.

staticmodule:videojs~videojs.getAllPlayers(){Array}

Returns an array of all current players.

Returns:

Type	Description
Array	An array of all players. The array will be in the order that Object.keys provides, which could potentially vary between JavaScript engines.

staticmodule:videojs~videojs.getComponent(name)

Get a Component based on the name it was registered with.

Name	Type	Description
name	string	The Name of the component to get.

Returns:

staticmodule:videojs~videojs.getPlayer(id){Player|undefined}

Get a single player based on an ID or DOM element.

This is useful if you want to check if an element or ID has an associated Video.js player, but not create one if it doesn't.

Name	Type	Description
id	string | Element	An HTML element - <video>, <audio>, or <video-js> - or a string matching the id of such an element.

Returns:

Type	Description
Player | undefined	A player instance or undefined if there is no player instance matching the argument.

staticmodule:videojs~videojs.getPlayers(){Object}

Get an object with the currently created players, keyed by player ID

Returns:

Type	Description
Object	The created players

staticmodule:videojs~videojs.getPlugin(name)

Gets a plugin by name if it exists.

Name	Type	Description
name	string	The name of a plugin.

Returns:

staticmodule:videojs~videojs.getPlugins(names){Object|undefined}

Gets an object containing multiple Video.js plugins.

Name	Type	Description
names	Array	optional If provided, should be an array of plugin names. Defaults to all plugin names.

Returns:

Type	Description
Object | undefined	An object containing plugin(s) associated with their name(s) or undefined if no matching plugins exist).

staticmodule:videojs~videojs.getPluginVersion(name){string}

Gets a plugin's version, if available

Name	Type	Description
name	string	The name of a plugin.

Returns:

Type	Description
string	The plugin's version or an empty string.

staticmodule:videojs~videojs.getTech(name){Tech|undefined}

Get a Tech from the shared list by name.

Name	Type	Description
name	string	camelCase or TitleCase name of the Tech to get

Returns:

Type	Description
Tech | undefined	The Tech or undefined if there was no tech with the name requested.

staticmodule:videojs~videojs.off(elem, type, fn)

Removes event listeners from an element

Name	Type	Description
elem	Element | Object	Object to remove listeners from.
type	string | Array.<string>	optional Type of listener to remove. Don't include to remove all events from element.
fn	function	optional Specific listener to remove. Don't include to remove listeners for an event type.

staticmodule:videojs~videojs.on(elem, type, fn)

Add an event listener to element It stores the handler function in a separate cache object and adds a generic handler to the element's event, along with a unique id (guid) to the element.

Name	Type	Description
elem	Element | Object	Element or object to bind listeners to
type	string | Array.<string>	Type of event to bind to.
fn	function	Event listener.

staticmodule:videojs~videojs.one(elem, type, fn)

Trigger a listener only once for an event.

Name	Type	Description
elem	Element | Object	Element or object to bind to.
type	string | Array.<string>	Name/type of event
fn	Event~EventListener	Event listener function

staticmodule:videojs~videojs.plugin(name, plugin)

Deprecated method to register a plugin with Video.js

Name	Type	Description
name	string	The plugin name
plugin

Deprecated

• Deprecated and will be removed in 9.0. Use videojs.registerPlugin() instead.

Returns:

staticmodule:videojs~videojs.registerComponent(name, comp)

Register a component so it can referred to by name. Used when adding to other components, either through addChild component.addChild('myComponent') or through default children options { children: ['myComponent'] }.

NOTE: You could also just initialize the component before adding. component.addChild(new MyComponent());

Name	Type	Description
name	string	The class name of the component
comp

Returns:

staticmodule:videojs~videojs.registerPlugin(name, plugin)

Register a Video.js plugin.

Name	Type	Description
name	string	The name of the plugin to be registered. Must be a string and must not match an existing plugin or a method on the Player prototype.
plugin

Returns:

staticmodule:videojs~videojs.registerTech(name, tech)

Registers a Tech into a shared list for videojs.

Name	Type	Description
name	string	Name of the Tech to register.
tech	Object	The Tech class to register.

staticmodule:videojs~videojs.trigger(elem, event, hash){boolean|undefined}

Trigger an event for an element

Name	Type	Description
elem	Element | Object	Element to trigger an event on
event	EventTarget~Event | string	A string (the type) or an event object with a type attribute
hash	Object	optional data hash to pass along with the event

Returns:

Type	Description
boolean | undefined	Returns the opposite of defaultPrevented if default was prevented. Otherwise, returns undefined

staticmodule:videojs~videojs.use(type, middleware)

Define a middleware that the player should use by way of a factory function that returns a middleware object.

Name	Type	Description
type	string	The MIME type to match or "*" for all MIME types.
middleware	MiddlewareFactory	A middleware factory function that will be executed for matching types.

staticmodule:videojs~videojs.xhr(options){XMLHttpRequest|XDomainRequest}

A cross-browser XMLHttpRequest wrapper.

Name	Type	Description
options	Object	Settings for the request.

See:

• https://github.com/Raynos/xhr

Returns:

Type	Description
XMLHttpRequest | XDomainRequest	The request object.