命名空间：videojs - Video.js API 文档

videojs(id, optionsopt, readyopt) → {Player}

videojs() 函数既是用户创建 Player 实例的主要函数，也是主库的命名空间。

它也可以用作获取现有 Player 实例的 getter。但是，我们强烈建议为此目的使用 videojs.getPlayer()，因为它避免了任何意外初始化的可能性。

由于我们的 JSDoc 模板的限制，我们无法将其同时正确地记录为函数和命名空间，因此其函数签名在此处进行文档说明。

参数

ID

字符串|元素，必填

视频元素或视频元素ID。

选项

对象，可选

用于提供设置的选项对象。请参阅：选项指南。

ready

Component~ReadyCallback，可选

当 Player 和 Tech 准备就绪时要调用的函数。

返回值

videojs() 函数返回一个 Player 实例。

参数

名称	类型	属性	描述
`ID`	字符串 \| 元素		视频元素或视频元素ID。
`选项`	对象	<可选>	用于提供设置的选项对象。请参阅：选项指南。
`ready`	PlayerReadyCallback	<可选>	当 Player 和 Tech 准备就绪时要调用的函数。

源: video.js, 第 130 行

videojs() 函数返回一个 Player 实例。

类型：: Player

类

AudioTrack
EventTarget
TextTrack
VideoTrack

成员

(静态) VERSION :string

当前 Video.js 版本。遵循语义化版本控制。

类型

字符串

源: video.js, 第 234 行

(静态) bind :function

对 fn.bind_ 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用原生 Function.prototype.bind。
源: video.js, 第 401 行
参见: fn.bind_

(静态) browser :Object

对浏览器实用工具模块的对象引用。

类型

对象

源: video.js, 第 366 行
参见: browser

(静态) createTimeRange :function

对 createTimeRanges 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.time.createTimeRanges。
源: video.js, 第 476 行
参见: createTimeRanges

(静态) createTimeRanges :function

对 createTimeRanges 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.time.createTimeRanges。
源: video.js, 第 485 行
参见: createTimeRanges

(静态) defineLazyProperty :function

对 defineLazyProperty 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.obj.defineLazyProperty。
源: video.js, 第 392 行
参见: defineLazyProperty

(静态) dom :Object

对 DOM 实用工具模块的对象引用。

类型

对象

源: video.js, 第 590 行
参见: dom

(静态) fn :Object

对 fn 实用工具模块的对象引用。

类型

对象

源: video.js, 第 598 行
参见: fn

(静态) formatTime :function

对 formatTime 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.time.format。
源: video.js, 第 494 行
参见: formatTime

(静态) isCrossOrigin :function

对 Url.isCrossOrigin 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.url.isCrossOrigin。
源: video.js, 第 530 行
参见: isCrossOrigin

(静态) log :function

对日志实用工具模块的对象引用。

类型

函数

源: video.js, 第 458 行
参见: log

(静态) mergeOptions :function

对 merge 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.obj.merge。
源: video.js, 第 383 行
参见: merge

(静态) num :Object

对数字实用工具模块的对象引用。

类型

对象

源: video.js, 第 606 行
参见: num

(静态) obj :Object

对对象实用工具模块的对象引用。

类型

对象

源: video.js, 第 374 行
参见: obj

(静态) options :Object

全局选项对象。这些是创建播放器时未指定任何覆盖设置的情况下生效的设置。

类型

对象

源: video.js, 第 242 行

(静态) parseUrl :function

对 Url.parseUrl 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.url.parseUrl。
源: video.js, 第 521 行
参见: parseUrl

(静态) players :Object

播放器的全局枚举。

键是播放器ID，值是 Player 实例，或者对于已释放的播放器是 null。

类型

对象

源: player.js, 第 5509 行

(静态) resetFormatTime :function

对 resetFormatTime 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.time.resetFormat。
源: video.js, 第 512 行
参见: resetFormatTime

(静态) setFormatTime :function

对 setFormatTime 函数的已弃用引用

类型

函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.time.setFormat。
源: video.js, 第 503 行
参见: setFormatTime

(静态) str :Object

对 str 实用工具模块的对象引用。

类型

对象

源: video.js, 第 614 行
参见: str

(静态) time :Object

对时间实用工具模块的对象引用。

类型

对象

源: video.js, 第 467 行
参见: time

(静态) url :Object

对 URL 实用工具模块的对象引用。

类型

对象

源: video.js, 第 622 行
参见: url

方法

(静态) addLanguage(code, data) → {Object}

添加语言，使其可供所有播放器使用。示例：videojs.addLanguage('es', { 'Hello': 'Hola' });

参数

名称	类型	描述
`code`	字符串	语言代码或字典属性
`data`	对象	要翻译的数据值

源: video.js, 第 441 行

结果语言字典对象

类型：: 对象

(静态) deregisterPlugin(name)

注销 Video.js 插件。

参数

名称	类型	描述
`名称`	字符串	要注销的插件名称。必须是与现有插件匹配的字符串。

源: plugin.js, 第 386 行

抛出

如果尝试注销基本插件。
类型 错误

(静态) getAllPlayers() → {Array}

返回所有当前播放器的数组。

源: video.js, 第 303 行

所有播放器的数组。该数组将按照 Object.keys 提供的顺序排列，该顺序在不同的 JavaScript 引擎之间可能有所不同。

类型：: 数组

(静态) getComponent(name) → {Class.<Component>}

根据注册名称获取 Component。

参数

名称	类型	描述
`名称`	字符串	要获取的组件名称。

源: component.js, 第 2052 行

在给定名称下注册的 Component。

类型：: Class.<Component>

(静态) getPlayer(id) → {Player|undefined}

根据 ID 或 DOM 元素获取单个播放器。

如果您想检查某个元素或 ID 是否关联了 Video.js 播放器，但又不想在没有关联的情况下创建新的播放器，此功能会很有用。

参数

名称	类型	描述
`ID`	字符串 \| 元素	HTML 元素 - `<video>`、`<audio>` 或 `<videojs>` - 或与此类元素的 `id` 匹配的字符串。

源: video.js, 第 266 行

播放器实例，如果不存在与参数匹配的播放器实例，则为 undefined。

类型：: Player | undefined

(静态) getPlayers() → {Object}

获取一个对象，其中包含当前创建的播放器，以播放器 ID 为键。

源: video.js, 第 250 行

创建的播放器

类型：: 对象

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

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

参数

名称	类型	描述
`名称`	字符串	插件名称。

源: plugin.js, 第 438 行

插件（或 undefined）。

类型：: Class.<Plugin> | 函数 | undefined

(静态) getPluginVersion(name) → {string}

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

参数

名称	类型	描述
`名称`	字符串	插件名称。

源: plugin.js, 第 431 行

插件的版本或空字符串。

类型：: 字符串

(静态) getPlugins(namesopt) → {Object|undefined}

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

参数

名称	类型	属性	描述
`名称`	数组	<可选>	如果提供，应为插件名称数组。默认为所有插件名称。

源: plugin.js, 第 407 行

一个包含插件及其名称的对象（如果不存在匹配的插件，则为 undefined）。

类型：: 对象 | undefined

(静态) getTech(name) → {Tech|undefined}

从共享列表中按名称获取一个 Tech。

参数

名称	类型	描述
`名称`	字符串	要获取的 Tech 的 `camelCase` 或 `TitleCase` 名称

源: tech/tech.js, 第 1048 行

Tech 或 undefined，如果不存在请求名称的 tech。

类型：: Tech | undefined

(静态) off(elem, typeopt, fnopt)

从元素中移除事件监听器

参数

名称	类型	属性	描述
`elem`	元素 \| 对象		要从中移除监听器的对象。
`type`	字符串 \| Array.<string>	<可选>	要移除的监听器类型。不包含此参数以从元素中移除所有事件。
`fn`	函数	<可选>	要移除的特定监听器。不包含此参数以移除某个事件类型的所有监听器。

源: utils/events.js, 第 352 行

(静态) on(elem, type, fn)

向元素添加事件监听器。它将处理函数存储在一个单独的缓存对象中，并向元素的事件添加一个通用处理程序，同时向元素添加一个唯一的 ID (guid)。

参数

名称	类型	描述
`elem`	元素 \| 对象	要绑定监听器的元素或对象
`type`	字符串 \| Array.<string>	要绑定的事件类型。
`fn`	函数	事件监听器。

源: utils/events.js, 第 266 行

(静态) one(elem, type, fn)

仅触发一次事件监听器。

参数

名称	类型	描述
`elem`	元素 \| 对象	要绑定到的元素或对象。
`type`	字符串 \| Array.<string>	事件名称/类型
`fn`	Event~EventListener	事件监听函数

源: utils/events.js, 第 491 行

(静态) plugin(name, plugin) → {Class.<Plugin>|function}

参数

名称	类型	描述
`名称`	字符串	插件名称
`plugin`	Class.<Plugin> \| 函数	插件子类或函数

已废弃: 已弃用，并将在 9.0 版本中移除。请改用 videojs.registerPlugin()。
源: video.js, 第 419 行

类型：: Class.<Plugin> | 函数

(静态) registerComponent(name, comp) → {Class.<Component>}

注册一个组件，以便可以通过名称引用它。在添加到其他组件时使用，可以通过 addChild component.addChild('myComponent') 或通过默认子选项 { children: ['myComponent'] }。

注意：您也可以在添加之前初始化组件。component.addChild(new MyComponent());

参数

名称	类型	描述
`名称`	字符串	组件的类名
`comp`	Class.<Component>	组件类

源: video.js, 第 329 行

新注册的组件

类型：: Class.<Component>

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

注册一个 Video.js 插件。

参数

名称	类型	描述
`名称`	字符串	要注册的插件名称。必须是字符串，且不得与现有插件或 `Player` 原型上的方法冲突。
`plugin`	Class.<Plugin> \| 函数	`Plugin` 的子类或基本插件的函数。

源: plugin.js, 第 346 行

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

类型：: Class.<Plugin> | 函数

(静态) registerTech(name, tech)

将 Tech 注册到 videojs 的共享列表中。

参数

名称	类型	描述
`名称`	字符串	要注册的 `Tech` 的名称。
`tech`	对象	要注册的 `Tech` 类。

源: tech/tech.js, 第 1012 行

(静态) trigger(elem, event, hashopt) → {boolean|undefined}

触发元素的事件

参数

名称	类型	属性	描述
`elem`	元素 \| 对象		要触发事件的元素
`event`	EventTarget~Event \| 字符串		一个字符串（类型）或具有类型属性的事件对象
`hash`	对象	<可选>	随事件传递的数据哈希

源: utils/events.js, 第 426 行

如果阻止了默认行为，则返回 defaultPrevented 的相反值。否则，返回 undefined。

类型：: 布尔值 | undefined

(静态) use(type, middleware)

定义一个中间件，播放器应通过返回中间件对象的工厂函数来使用该中间件。

参数

名称	类型	描述
`type`	字符串	要匹配的 MIME 类型，或 `"*"` 表示所有 MIME 类型。
`middleware`	MiddlewareFactory	一个中间件工厂函数，将针对匹配的类型执行。

源: tech/middleware.js, 第 48 行

(静态) xhr(options) → {XMLHttpRequest|XDomainRequest}

跨浏览器 XMLHttpRequest 包装器。

参数

名称	类型	描述
`选项`	对象	请求设置。

源: video.js, 第 552 行
参见: https://github.com/Raynos/xhr

请求对象。

类型：: XMLHttpRequest | XDomainRequest