Class: Plugin

Constructor

new Plugin(player)

Creates an instance of this class.

Sub-classes should call super to ensure plugins are properly initialized.

Parameters:

Name	Type	Description
`player`	Player	A Video.js player instance.

Mixes In: module:evented~EventedMixin
module:stateful~StatefulMixin
Source: plugin.js, line 188

Fires:

Listens to Events:

Player#event:dispose

Throws:

If attempting to instantiate the base Plugin class directly instead of via a sub-class.
Type Error

Members

state :Object

A hash containing arbitrary keys and values representing the state of the object.

Type:

Object

Mixes In: module:stateful~StatefulMixin.state
Source: mixins/stateful.js, line 22

state :Object

A hash containing arbitrary keys and values representing the state of the object.

Type:

Object

Mixes In: module:stateful~StatefulMixin.state
Source: mixins/stateful.js, line 22

(static) BASE_PLUGIN_NAME :string

The name of the base plugin class as it is registered.

Type:

string

Source: plugin.js, line 518

Methods

any(type, fn)

This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to be called once for each event name.

Source: plugin.js, line 310

any(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object. The listener will only be called once for the first event that is triggered then removed.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.any
Source: mixins/evented.js, line 361

any(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object. The listener will only be called once for the first event that is triggered then removed.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.any
Source: mixins/evented.js, line 361

dispose()

Disposes a plugin.

Subclasses can override this if they want, but for the sake of safety, it's probably best to subscribe the "dispose" event.

Source: plugin.js, line 352

Fires:

Plugin#event:dispose

getEventHash(hashopt) → {PluginEventHash}

Each event triggered by plugins includes a hash of additional data with conventional properties.

This returns that object or mutates an existing hash.

Parameters:

Name	Type	Attributes	Default	Description
`hash`	Object	<optional>	{}	An object to be used as event an event hash.

Source: plugin.js, line 250

Returns:

An event hash object with provided properties mixed-in.

Type:: PluginEventHash

(abstract) handleStateChanged(e)

Handles "statechanged" events on the plugin. No-op by default, override by subclassing.

Parameters:

Name Type Description

e

Event

An event object provided by a "statechanged" event.

Properties

Name	Type	Description
`changes`	Object	An object describing changes that occurred with the "statechanged" event.

Source: plugin.js, line 342

off(type, fnopt)

Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.

Parameters:

Name	Type	Attributes	Description
`type`	string \| Array.<string>		An event name or an array of event names.
`fn`	function	<optional>	The function to remove. If not specified, all listeners managed by Video.js will be removed.

Source: plugin.js, line 283

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

Removes listener(s) from event(s) on an evented object.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object	<optional>	If this is a string or array, it represents the event type(s). `Another evented object can be passed here instead, in which case ALL 3 arguments are _required_.`
`typeOrListener`	string \| Array \| function	<optional>	If the first argument was a string or array, this may be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function; otherwise, all listeners bound to the event type(s) will be removed.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s).

    Another evented object can be passed here instead, in which case
    ALL 3 arguments are _required_.

typeOrListener

string | Array | function

If the first argument was a string or array, this may be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function; otherwise, all listeners bound to the event type(s) will be removed.

Mixes In: module:evented~EventedMixin.off
Source: mixins/evented.js, line 401

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

Removes listener(s) from event(s) on an evented object.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object	<optional>	If this is a string or array, it represents the event type(s). `Another evented object can be passed here instead, in which case ALL 3 arguments are _required_.`
`typeOrListener`	string \| Array \| function	<optional>	If the first argument was a string or array, this may be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function; otherwise, all listeners bound to the event type(s) will be removed.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s).

    Another evented object can be passed here instead, in which case
    ALL 3 arguments are _required_.

typeOrListener

string | Array | function

If the first argument was a string or array, this may be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function; otherwise, all listeners bound to the event type(s) will be removed.

Mixes In: module:evented~EventedMixin.off
Source: mixins/evented.js, line 401

on(type, fn)

Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to call with `EventTarget`s

Source: plugin.js, line 270

on(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.on
Source: mixins/evented.js, line 260

on(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.on
Source: mixins/evented.js, line 260

one(type, fn)

This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.

Parameters:

Name	Type	Description
`type`	string \| Array.<string>	An event name or an array of event names.
`fn`	function	The function to be called once for each event name.

Source: plugin.js, line 296

one(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object. The listener will be called once per event and then removed.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.one
Source: mixins/evented.js, line 312

one(targetOrType, typeOrListener, listeneropt)

Add a listener to an event (or events) on this object or another evented object. The listener will be called once per event and then removed.

Parameters:

Name Type Attributes Description

Name	Type	Attributes	Description
`targetOrType`	string \| Array \| Element \| Object		If this is a string or array, it represents the event type(s) that will trigger the listener. Another evented object can be passed here instead, which will cause the listener to listen for events on _that_ object. In either case, the listener's `this` value will be bound to this object.
`typeOrListener`	string \| Array \| function		If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).
`listener`	function	<optional>	If the first argument was another evented object, this will be the listener function.

targetOrType

string | Array | Element | Object

If this is a string or array, it represents the event type(s) that will trigger the listener.

    Another evented object can be passed here instead, which will
    cause the listener to listen for events on _that_ object.

    In either case, the listener's `this` value will be bound to
    this object.

typeOrListener

string | Array | function

If the first argument was a string or array, this should be the listener function. Otherwise, this is a string or array of event type(s).

listener

function

If the first argument was another evented object, this will be the listener function.

Mixes In: module:evented~EventedMixin.one
Source: mixins/evented.js, line 312

setState(stateUpdates) → {Object|undefined}

Set the state of an object by mutating its state object in place.

Parameters:

Name	Type	Description
`stateUpdates`	Object \| function	A new set of properties to shallow-merge into the plugin state. Can be a plain object or a function returning a plain object.

Mixes In: module:stateful~StatefulMixin.setState
Source: mixins/stateful.js, line 37

Fires:

module:stateful~StatefulMixin#event:statechanged

Returns:

An object containing changes that occurred. If no changes occurred, returns undefined.

Type:: Object | undefined

setState(stateUpdates) → {Object|undefined}

Set the state of an object by mutating its state object in place.

Parameters:

Name	Type	Description
`stateUpdates`	Object \| function	A new set of properties to shallow-merge into the plugin state. Can be a plain object or a function returning a plain object.

Mixes In: module:stateful~StatefulMixin.setState
Source: mixins/stateful.js, line 37

Fires:

module:stateful~StatefulMixin#event:statechanged

Returns:

An object containing changes that occurred. If no changes occurred, returns undefined.

Type:: Object | undefined

trigger(event, hashopt) → {boolean}

Triggers an event on the plugin object and overrides EventedMixin.trigger.

Parameters:

Name	Type	Attributes	Default	Description
`event`	string \| Object			An event type or an object with a type property.
`hash`	Object	<optional>	{}	Additional data hash to merge with a PluginEventHash.

Source: plugin.js, line 326

Returns:

Whether or not default was prevented.

Type:: boolean

trigger(event, hashopt) → {boolean}

Fire an event on this evented object, causing its listeners to be called.

Parameters:

Name	Type	Attributes	Description
`event`	string \| Object		An event type or an object with a type property.
`hash`	Object	<optional>	An additional object to pass along to listeners.

Mixes In: module:evented~EventedMixin.trigger
Source: mixins/evented.js, line 446

Returns:

Whether or not the default behavior was prevented.

Type:: boolean

trigger(event, hashopt) → {boolean}

Fire an event on this evented object, causing its listeners to be called.

Parameters:

Name	Type	Attributes	Description
`event`	string \| Object		An event type or an object with a type property.
`hash`	Object	<optional>	An additional object to pass along to listeners.

Mixes In: module:evented~EventedMixin.trigger
Source: mixins/evented.js, line 446

Returns:

Whether or not the default behavior was prevented.

Type:: boolean

version()

Get the version of the plugin that was set on.VERSION

Source: plugin.js, line 234

(static) deregisterPlugin(name)

De-register a Video.js plugin.

Parameters:

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

Source: plugin.js, line 447

Throws:

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

(static) getPlugin(name) → {Class.<Plugin>|function|undefined}

Gets a plugin by name if it exists.

Parameters:

Name	Type	Description
`name`	string	The name of a plugin.

Source: plugin.js, line 499

Returns:

The plugin (or undefined).

Type:: Class.<Plugin> | function | undefined

(static) getPluginVersion(name) → {string}

Gets a plugin's version, if available

Parameters:

Name	Type	Description
`name`	string	The name of a plugin.

Source: plugin.js, line 492

Returns:

The plugin's version or an empty string.

Type:: string

(static) getPlugins(namesopt) → {Object|undefined}

Gets an object containing multiple Video.js plugins.

Parameters:

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

Source: plugin.js, line 468

Returns:

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

Type:: Object | undefined

(static) isBasic(plugin) → {boolean}

Determines if a plugin is a basic plugin (i.e. not a sub-class of Plugin).

Parameters:

Name	Type	Description
`plugin`	string \| function	If a string, matches the name of a plugin. If a function, will be tested directly.

Source: plugin.js, line 386

Returns:

Whether or not a plugin is a basic plugin.

Type:: boolean

(static) registerPlugin(name, plugin) → {Class.<Plugin>|function}

Parameters:

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`	Class.<Plugin> \| function	A sub-class of `Plugin` or a function for basic plugins.

Source: plugin.js, line 407

Returns:

For advanced plugins, a factory function for that plugin. For basic plugins, a wrapper function that initializes the plugin.

Type:: Class.<Plugin> | function

Events

dispose

Signals that a advanced plugin is about to be disposed.

Type:

Event

Source: plugin.js, line 355