Plugin

Parent class for all advanced plugins.

Constructor

new Plugin(player)

Creates an instance of this class.

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

Parameters:
NameTypeDescription
playerPlayer

A Video.js player instance.

Listens to Events:
Throws:

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

Type
Error

Members

(static) BASE_PLUGIN_NAME :string

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

Type:
  • string

state :Object

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

Type:
  • Object

state :Object

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

Type:
  • Object

Methods

(static) deregisterPlugin(name)

De-register a Video.js plugin.

Parameters:
NameTypeDescription
namestring

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

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:
NameTypeDescription
namestring

The name of a plugin.

Returns:

The plugin (or undefined).

Type: 
Class.<Plugin> | function | undefined

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

Gets an object containing multiple Video.js plugins.

Parameters:
NameTypeAttributesDescription
namesArray<optional>

If provided, should be an array of plugin names. Defaults to all plugin names.

Returns:

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

Type: 
Object | undefined

(static) getPluginVersion(name) → {string}

Gets a plugin's version, if available

Parameters:
NameTypeDescription
namestring

The name of a plugin.

Returns:

The plugin's version or an empty string.

Type: 
string

(static) isBasic(plugin) → {boolean}

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

Parameters:
NameTypeDescription
pluginstring | function

If a string, matches the name of a plugin. If a function, will be tested directly.

Returns:

Whether or not a plugin is a basic plugin.

Type: 
boolean

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

Register a Video.js plugin.

Parameters:
NameTypeDescription
namestring

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.

pluginClass.<Plugin> | function

A sub-class of Plugin or a function for basic plugins.

Returns:

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

Type: 
Class.<Plugin> | function

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:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

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:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

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.

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:
NameTypeAttributesDefaultDescription
hashObject<optional>
{}

An object to be used as event an event hash.

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:
NameTypeDescription
eEvent

An event object provided by a "statechanged" event.

Properties
NameTypeDescription
changesObject

An object describing changes that occurred with the "statechanged" event.

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

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

Parameters:
NameTypeAttributesDescription
targetOrTypestring | 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_.
typeOrListenerstring | 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).

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

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

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

Parameters:
NameTypeAttributesDescription
targetOrTypestring | 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_.
typeOrListenerstring | 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).

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

on(targetOrType, typeOrListener, listeneropt)

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

Parameters:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

on(targetOrType, typeOrListener, listeneropt)

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

Parameters:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

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:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

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:
NameTypeAttributesDescription
targetOrTypestring | 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.
typeOrListenerstring | 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).

listenerfunction<optional>

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

setState(stateUpdates) → {Object|undefined}

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

Parameters:
NameTypeDescription
stateUpdatesObject | 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.

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:
NameTypeDescription
stateUpdatesObject | 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.

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:
NameTypeAttributesDefaultDescription
eventstring | Object

An event type or an object with a type property.

hashObject<optional>
{}

Additional data hash to merge with a PluginEventHash.

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:
NameTypeAttributesDescription
eventstring | Object

An event type or an object with a type property.

hashObject<optional>

An additional object to pass along to listeners.

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:
NameTypeAttributesDescription
eventstring | Object

An event type or an object with a type property.

hashObject<optional>

An additional object to pass along to listeners.

Returns:

Whether or not the default behavior was prevented.

Type: 
boolean

version()

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

Events

dispose

Signals that a advanced plugin is about to be disposed.

Type: