Plugin

所有高级插件的父类。

构造函数

new Plugin(player)

创建此类的实例。

子类应调用 super 以确保插件正确初始化。

参数
名称类型描述
播放器Player

一个 Video.js 播放器实例。

混合特性
源
触发
监听事件
抛出

如果尝试直接实例化基础 Plugin 类而非通过子类。

类型
错误

成员

state :Object

包含任意键值对的哈希表，表示对象的状态。

类型
  • 对象
混合特性
源

state :Object

包含任意键值对的哈希表，表示对象的状态。

类型
  • 对象
混合特性
源

(static) BASE_PLUGIN_NAME :string

注册的基础插件类的名称。

类型
  • 字符串
源

方法

any(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。监听器将在第一个事件触发后仅被调用一次，然后被移除。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

any(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。监听器将在第一个事件触发后仅被调用一次，然后被移除。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

dispose()

处理一个插件。

子类可以重写此方法，但为了安全起见，最好订阅“处理”事件。

源
触发

getEventHash(hashopt) → {PluginEventHash}

插件触发的每个事件都包含一个带有常规属性的附加数据哈希表。

此方法返回该对象或修改现有哈希表。

参数
名称类型属性默认描述
哈希表对象<可选>
{}

一个用作事件哈希的对象。

源
返回

一个混合了所提供属性的事件哈希对象。

类型： 
PluginEventHash

(abstract) handleStateChanged(e)

处理插件上的“statechanged”事件。默认情况下为空操作，子类可重写。

参数
名称类型描述
事件Event

由“statechanged”事件提供的事件对象。

属性
名称类型描述
更改对象

描述“statechanged”事件中发生的更改的对象。

源

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

从事件对象上的事件中移除一个或多个监听器。

参数
名称类型属性描述
目标或类型string | Array | Element | Object<可选>

如果这是字符串或数组，它表示事件类型。

    Another evented object can be passed here instead, in which case
    ALL 3 arguments are _required_.
类型或监听器string | Array | function<可选>

如果第一个参数是字符串或数组，则此参数可以是监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数；否则，将移除绑定到事件类型的所有监听器。

混合特性
源

off(targetOrTypeopt, typeOrListeneropt, listeneropt)

从事件对象上的事件中移除一个或多个监听器。

参数
名称类型属性描述
目标或类型string | Array | Element | Object<可选>

如果这是字符串或数组，它表示事件类型。

    Another evented object can be passed here instead, in which case
    ALL 3 arguments are _required_.
类型或监听器string | Array | function<可选>

如果第一个参数是字符串或数组，则此参数可以是监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数；否则，将移除绑定到事件类型的所有监听器。

混合特性
源

on(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

on(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

one(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。监听器将为每个事件调用一次，然后被移除。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

one(targetOrType, typeOrListener, listeneropt)

为此对象或其他事件对象上的事件（或多个事件）添加监听器。监听器将为每个事件调用一次，然后被移除。

参数
名称类型属性描述
目标或类型string | Array | Element | Object

如果这是字符串或数组，它表示将触发监听器的事件类型。

    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.
类型或监听器string | Array | function

如果第一个参数是字符串或数组，则此参数应为监听函数。否则，此参数是事件类型字符串或数组。

监听器函数<可选>

如果第一个参数是另一个事件对象，则此参数将是监听函数。

混合特性
源

setState(stateUpdates) → {Object|undefined}

通过原地修改对象的 state 属性来设置对象的状态。

参数
名称类型描述
状态更新Object | function

一组新的属性，用于浅合并到插件状态中。可以是普通对象，也可以是返回普通对象的函数。

混合特性
源
触发
返回

一个包含已发生更改的对象。如果未发生更改，则返回 undefined。

类型： 
对象 | undefined

setState(stateUpdates) → {Object|undefined}

通过原地修改对象的 state 属性来设置对象的状态。

参数
名称类型描述
状态更新Object | function

一组新的属性，用于浅合并到插件状态中。可以是普通对象，也可以是返回普通对象的函数。

混合特性
源
触发
返回

一个包含已发生更改的对象。如果未发生更改，则返回 undefined。

类型： 
对象 | undefined

trigger(event, hashopt) → {boolean}

在插件对象上触发事件并覆盖 EventedMixin.trigger。

参数
名称类型属性默认描述
事件string | Object

事件类型或带有 type 属性的对象。

哈希表对象<可选>
{}

要与 PluginEventHash 合并的附加数据哈希。

源
返回

是否阻止了默认行为。

类型： 
布尔值

trigger(event, hashopt) → {boolean}

在此事件对象上触发事件，导致其监听器被调用。

参数
名称类型属性描述
事件string | Object

事件类型或带有 type 属性的对象。

哈希表对象<可选>

要传递给监听器的附加对象。

混合特性
源
返回

是否阻止了默认行为。

类型： 
布尔值

trigger(event, hashopt) → {boolean}

在此事件对象上触发事件，导致其监听器被调用。

参数
名称类型属性描述
事件string | Object

事件类型或带有 type 属性的对象。

哈希表对象<可选>

要传递给监听器的附加对象。

混合特性
源
返回

是否阻止了默认行为。

类型： 
布尔值

version()

获取设置在 .VERSION 的插件版本。.VERSION

源

(static) deregisterPlugin(name)

取消注册一个 Video.js 插件。

参数
名称类型描述
名称字符串

要取消注册的插件名称。必须是与现有插件匹配的字符串。

源
抛出

如果尝试取消注册基础插件。

类型
错误

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

按名称获取插件（如果存在）。

参数
名称类型描述
名称字符串

插件名称。

源
返回

插件（或 undefined）。

类型： 
Class.<Plugin> | function | undefined

(static) getPluginVersion(name) → {string}

获取插件版本（如果可用）

参数
名称类型描述
名称字符串

插件名称。

源
返回

插件版本或空字符串。

类型： 
字符串

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

获取包含多个 Video.js 插件的对象。

参数
名称类型属性描述
名称数组<可选>

如果提供，应为插件名称数组。默认为 *所有* 插件名称。

源
返回

一个包含与插件名称关联的插件（或如果不存在匹配插件则为 undefined）的对象。

类型： 
对象 | undefined

(static) isBasic(plugin) → {boolean}

确定插件是否为基本插件（即不是 Plugin 的子类）。

参数
名称类型描述
插件string | function

如果是字符串，则匹配插件的名称。如果是函数，将直接进行测试。

源
返回

插件是否为基本插件。

类型： 
布尔值

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

注册一个 Video.js 插件。

参数
名称类型描述
名称字符串

要注册的插件名称。必须是字符串，且不能与现有插件或 Player 原型上的方法匹配。

插件Class.<Plugin> | function

Plugin 的子类或基本插件的函数。

源
返回

对于高级插件，是该插件的工厂函数。对于基本插件，是初始化插件的包装函数。

类型： 
Class.<Plugin> | function

事件

dispose

表示一个高级插件即将被处理。

类型
源