构造函数
new Player(tag, options可选, ready可选)
创建此类的实例。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
标签 | 元素 | 用于配置选项的原始视频 DOM 元素。 | |
选项 | 对象 | <可选> | 选项名称和值的对象。 |
准备就绪 | 播放器准备就绪回调 | <可选> | 准备就绪回调函数。 |
继承
成员
controls_ :布尔值
- 布尔值
crossorigin
获取或设置 Player
的 crossorigin
选项。对于 HTML5 播放器,这将设置 <video>
标签上的 crossOrigin
属性以控制 CORS 行为。
- 参见
poster_ :字符串
- 字符串
(static) players :对象
播放器的全局枚举。
键是播放器 ID,值是 Player 实例或已销毁播放器的 null
。
- 对象
方法
$(selector, context可选) → {元素|空}
查找匹配selector
的单个DOM元素。这可以在Component
的contentEl()
中或另一个自定义上下文中进行。
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
选择器 | 字符串 | 一个有效的CSS选择器,将传递给 | ||
上下文 | 元素 | | <可选> | this.contentEl() | 用于查询的 DOM 元素。也可以是选择器字符串,在这种情况下,第一个匹配的元素将用作上下文。如果缺少,则使用 |
- 参见
找到的DOM元素,或null
- 类型:
- 元素 |
空
$$(selector, context可选) → {节点列表}
查找匹配selector
的所有DOM元素。这可以在Component
的contentEl()
中或另一个自定义上下文中进行。
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
选择器 | 字符串 | 一个有效的CSS选择器,将传递给 | ||
上下文 | 元素 | | <可选> | this.contentEl() | 用于查询的 DOM 元素。也可以是选择器字符串,在这种情况下,第一个匹配的元素将用作上下文。如果缺少,则使用 |
- 参见
找到的DOM元素列表
- 类型:
- 节点列表
addChild(child, options可选, index可选) → {Component}
在当前Component
中添加一个子Component
。
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
子项 | 字符串 | | 要添加的子项的名称或实例。 | ||
选项 | 对象 | <可选> | {} | 将传递给子项的子项的选项的键/值存储。 |
索引 | 数字 | <可选> | this.children_.length | 尝试添加子项的索引。 |
作为子项添加的Component
。使用字符串时,Component
将由该过程创建。
- 类型:
- Component
addClass(…要添加的类)
向Component
的元素添加CSS类名。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
要添加的类 | 字符串 | <可重复> | 一个或多个要添加的CSS类名。 |
addRemoteTextTrack(options, manualCleanup可选) → {HtmlTrackElement}
创建一个远程 TextTrack 和一个 HTMLTrackElement。
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
选项 | 对象 | 创建时传递给 HTMLTrackElement 的选项。请参阅 HTMLTrackElement 以了解您应该使用的对象属性。 | ||
手动清理 | 布尔值 | <可选> | 假 | 如果设置为 true,则 TextTrack 在源更改后不会从 TextTrackList 和 HtmlTrackElementList 中移除 |
已创建并添加到 HtmlTrackElementList 和远程 TextTrackList 的 HTMLTrackElement
- 类型:
- HtmlTrackElement
addSourceElement(srcUrl, mimeType可选) → {布尔值}
添加一个
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
srcUrl | 字符串 | 视频源的 URL。 | |
mimeType | 字符串 | <可选> | 视频源的 MIME 类型。可选但推荐。 |
如果源元素添加成功则返回 true,否则返回 false。
- 类型:
- 布尔值
addTextTrack(kind可选, label可选, language可选) → {TextTrack|未定义}
一个用于将 TextTrack 添加到 TextTrackList 的辅助方法。
除了 W3C 设置之外,我们还允许通过选项添加额外信息。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
类型 | 字符串 | <可选> | 您要添加的 TextTrack 类型 |
label | 字符串 | <可选> | 要赋予 TextTrack 的标签 |
语言 | 字符串 | <可选> | 要在 TextTrack 上设置的语言 |
已添加的 TextTrack,如果不存在技术则为 undefined
- 类型:
- TextTrack |
未定义
aspectRatio(ratio可选) → {字符串|未定义}
Player
宽高比的获取器/设置器。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
ratio | 字符串 | <可选> | 要将 |
- 获取时
Player
的当前宽高比。- 设置时为 undefined
- 类型:
- 字符串 |
未定义
audioOnlyMode(value可选) → {Promise|布尔值}
获取当前的 audioOnlyMode
状态或将 audioOnlyMode
设置为 true 或 false。
将此设置为 true
将隐藏所有播放器组件,除了控制栏以及仅视频所需的控制栏组件。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> | 要将 audioOnlyMode 设置到的值。 |
设置状态时返回 Promise,获取当前状态时返回布尔值
- 类型:
- Promise |
布尔值
audioPosterMode(value可选) → {Promise|布尔值}
获取当前的 audioPosterMode
状态或将 audioPosterMode
设置为 true 或 false
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> | 要将 audioPosterMode 设置到的值。 |
设置状态时返回 Promise,获取当前状态时返回布尔值
- 类型:
- Promise |
布尔值
audioTracks() → {AudioTrackList}
当前音频轨道列表
- 类型:
- AudioTrackList
autoplay(value可选) → {布尔值|字符串|未定义}
获取或设置自动播放选项。当这是一个布尔值时,它将修改技术上的属性。当这是一个字符串时,技术上的属性将被移除,Player
将在加载开始时处理自动播放。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | | <可选> |
|
- 获取时自动播放的当前值 - 设置时无
- 类型:
- 布尔值 |
字符串 | 未定义
blur()
从此组件中移除焦点
breakpoints(breakpoints可选) → {对象}
获取或设置播放器上的断点。
使用对象或 true
调用此方法将移除任何先前的自定义断点并从默认值重新开始。
名称 | 类型 | 属性 | 描述 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
breakpoints | 对象 | | <可选> | 如果给定一个对象,它可用于提供自定义断点。如果给定 属性
|
一个将断点名称映射到最大宽度值的对象。
- 类型:
- 对象
buffered() → {时间范围}
获取一个 TimeRange 对象,其中包含已下载视频的时间数组。如果您只想要已下载视频的百分比,请使用 bufferedPercent。
- 参见
一个模拟的 TimeRanges 对象(遵循 HTML 规范)
- 类型:
- 时间范围
bufferedEnd() → {数字}
获取最后一个缓冲时间范围的结束时间。这在进度条中用于封装所有时间范围。
最后一个缓冲时间范围的结束
- 类型:
- 数字
bufferedPercent() → {数字}
获取已下载视频的百分比(以小数形式)。此方法不是原生 HTML 视频 API 的一部分。
一个介于 0 和 1 之间的小数,表示缓冲的百分比,0 表示 0%,1 表示 100%
- 类型:
- 数字
(abstract) buildCSSClass() → {字符串}
构建默认的DOM类名。应由子组件覆盖。
此对象的DOM类名。
- 类型:
- 字符串
canPlayType(type) → {字符串}
检查播放器是否可以播放给定的 MIME 类型
名称 | 类型 | 描述 |
---|---|---|
type | 字符串 | 要检查的 MIME 类型 |
'probably'、'maybe' 或 ''(空字符串)
- 类型:
- 字符串
cancelAnimationFrame(id) → {数字}
取消传递给Component#requestAnimationFrame (rAF) 的排队回调。
如果您通过 Component#requestAnimationFrame 队列了一个 rAF 回调,请使用此函数而不是 window.cancelAnimationFrame
。否则,您的销毁监听器将不会被清理,直到 Component#dispose!
名称 | 类型 | 描述 |
---|---|---|
ID | 数字 | 要清除的rAF ID。Component#requestAnimationFrame的返回值。 |
- 参见
返回已清除的rAF ID。
- 类型:
- 数字
cancelNamedAnimationFrame(name)
如果存在,取消当前的命名动画帧。
名称 | 类型 | 描述 |
---|---|---|
名称 | 字符串 | 要取消的requestAnimationFrame的名称。 |
children() → {数组}
获取所有子组件的数组
子项
- 类型:
- 数组
clearInterval(intervalId) → {数字}
清除通过 window.setInterval
或 Component#setInterval 创建的间隔。如果您通过 Component#setInterval 设置了间隔,请使用此函数而不是 window.clearInterval
。否则,您的销毁监听器将不会被清理,直到 Component#dispose!
名称 | 类型 | 描述 |
---|---|---|
intervalId | 数字 | 要清除的间隔ID。Component#setInterval或 |
- 参见
返回已清除的间隔ID。
- 类型:
- 数字
clearTimeout(timeoutId) → {数字}
清除通过 window.setTimeout
或 Component#setTimeout 创建的超时。如果您通过 Component#setTimeout 设置了超时,请使用此函数而不是 window.clearTimout
。否则,您的销毁监听器将不会被清理,直到 Component#dispose!
名称 | 类型 | 描述 |
---|---|---|
timeoutId | 数字 | 要清除的超时ID。Component#setTimeout或 |
- 参见
返回已清除的超时ID。
- 类型:
- 数字
contentEl() → {元素}
返回Component
的DOM元素。子项将插入到此处。这通常与Component#el中返回的元素相同。
此Component
的内容元素。
- 类型:
- 元素
controls(bool可选) → {布尔值|未定义}
获取或设置控制器是否显示。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 获取时控制器的当前值 - 设置时无
- 类型:
- 布尔值 |
未定义
createEl() → {元素}
创建 Player
的 DOM 元素。
被创建的DOM元素。
- 类型:
- 元素
createModal(content, options可选) → {ModalDialog}
创建一个简单的模态对话框(ModalDialog 组件的一个实例),它会立即用任意内容覆盖播放器,并在关闭时自行移除。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
内容 | 字符串 | | 与 ModalDialog#content 的同名参数相同。最直接的用法是提供一个字符串或 DOM 元素。 | |
选项 | 对象 | <可选> | 将传递给 ModalDialog 的额外选项。 |
已创建的 ModalDialog
- 类型:
- ModalDialog
crossOrigin(value可选) → {字符串|空|未定义}
获取或设置 Player
的 crossOrigin
选项。对于 HTML5 播放器,这将设置 <video>
标签上的 crossOrigin
属性以控制 CORS 行为。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 字符串 | | <可选> | 要将 |
- 参见
- 获取时
Player
的当前crossOrigin
值。- 设置时为 undefined
- 类型:
- 字符串 |
空 | 未定义
currentBreakpoint() → {字符串}
获取当前断点名称(如果有)。
如果当前已设置断点,则返回与其匹配的断点对象的键。否则,返回一个空字符串。
- 类型:
- 字符串
currentBreakpointClass() → {字符串}
获取当前断点类名。
与当前断点匹配的类名(例如 "vjs-layout-tiny"
或 "vjs-layout-large"
)。如果没有当前断点,则为空字符串。
- 类型:
- 字符串
currentDimension(widthOrHeight) → {数字}
获取组件元素的计算宽度或高度。
使用window.getComputedStyle
。
名称 | 类型 | 描述 |
---|---|---|
宽度或高度 | 字符串 | 包含“width”或“height”的字符串。您想获取的任何一个。 |
请求的维度,如果该维度未设置,则为0。
- 类型:
- 数字
currentDimensions() → {Component~DimensionObject}
获取一个包含组件元素计算宽度和高度值的对象。
使用window.getComputedStyle
。
组件元素的计算维度。
currentHeight() → {数字}
获取组件元素的计算高度。
使用window.getComputedStyle
。
组件元素的计算高度。
- 类型:
- 数字
currentSource() → {Tech~SourceObject}
返回当前源对象。
当前源对象
- 类型:
- Tech~SourceObject
currentSources() → {Array.<Tech~SourceObject>}
返回所有当前源对象。
当前源对象
- 类型:
- Array.<Tech~SourceObject>
currentSrc() → {字符串}
返回当前源值的完全限定 URL,例如 http://mysite.com/video.mp4。可与 currentType
结合使用,以帮助重建当前源对象。
当前源
- 类型:
- 字符串
currentTime(seconds可选) → {数字|未定义}
获取或设置当前时间(以秒为单位)
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
seconds | 数字 | | <可选> | 要跳转到的时间(以秒为单位) |
- 获取时当前时间(以秒为单位)- 设置时无
- 类型:
- 数字 |
未定义
currentType() → {字符串}
获取当前源类型,例如 video/mp4。这可以允许您重建当前源对象,以便以后可以加载相同的源和技术。
源 MIME 类型
- 类型:
- 字符串
currentWidth() → {数字}
获取组件元素的计算宽度。
使用window.getComputedStyle
。
组件元素的计算宽度。
- 类型:
- 数字
debug(enabled) → {布尔值|未定义}
设置调试模式以启用/禁用信息级别的日志。
名称 | 类型 | 描述 |
---|---|---|
已启用 | 布尔值 |
- Player#event:debugon
- Player#event:debugoff
- 类型:
- 布尔值 |
未定义
defaultMuted(defaultMuted可选) → {布尔值|未定义}
获取当前的 defaultMuted
状态,或开启或关闭 defaultMuted
。defaultMuted
表示初始播放时的静音状态。
var myPlayer = videojs('some-player-id');
myPlayer.src("http://www.example.com/path/to/video.mp4");
// get, should be false
console.log(myPlayer.defaultMuted());
// set to true
myPlayer.defaultMuted(true);
// get should be true
console.log(myPlayer.defaultMuted());
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
defaultMuted | 布尔值 | <可选> |
|
- 获取时如果 defaultMuted 开启则为 true - 获取时如果 defaultMuted 关闭则为 false - 设置时无
- 类型:
- 布尔值 |
未定义
defaultPlaybackRate(rate可选) → {数字|未定义}
获取或设置当前默认播放速率。例如,默认播放速率 1.0 表示正常速度,0.5 表示半速播放。defaultPlaybackRate
仅表示视频的初始播放速率,而不是当前播放速率。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
rate | 数字 | <可选> | 要设置的新默认播放速率。 |
- 获取时默认播放速率或 1.0 - 设置时无
- 类型:
- 数字 |
未定义
dimension(dimension, value可选) → {数字}
Player
宽度和高度的获取器/设置器。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
dimension | 字符串 | 此字符串可以是:- 'width'(宽度)- 'height'(高度) | |
值 | 数字 | | <可选> | 第一个参数中指定的尺寸值。 |
获取时尺寸参数的值(宽度/高度)。
- 类型:
- 数字
dimensions(width, height)
同时设置Component
元素的宽度和高度。
名称 | 类型 | 描述 |
---|---|---|
宽度 | 数字 | | 要设置 |
高度 | 数字 | | 要设置 |
disablePictureInPicture(value可选)
获取或设置禁用画中画模式。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> |
|
dispose()
销毁视频播放器并执行所有必要的清理。
如果您正在动态地向 DOM 添加和移除视频,这会特别有用。
documentFullscreenChange_()
当文档全屏改变事件触发时,它会调用此方法
duration(seconds可选) → {数字|未定义}
通常以秒为单位获取视频的时长;在除极少数用例之外的所有情况下,都不会向该方法传递参数
注意:视频必须已开始加载才能知道时长,并且根据预加载行为,可能直到视频开始播放才能知道。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
seconds | 数字 | <可选> | 要设置的视频时长(以秒为单位) |
- 获取时视频时长(以秒为单位)- 设置时无
- 类型:
- 数字 |
未定义
el() → {元素}
获取Component
的DOM元素
此Component
的DOM元素。
- 类型:
- 元素
(protected) emitTapEvents()
检测到触摸事件支持时发出“tap”事件。这用于通过轻触视频来支持切换控件。它们之所以启用,是因为否则每个子组件都会有额外的开销。
- Component#event:touchstart
- Component#event:touchmove
- Component#event:touchleave
- Component#event:touchcancel
- Component#event:touchend
enableTouchActivity()
此函数在触摸事件发生时报告用户活动。这可以被任何希望触摸事件以其他方式运行的子组件关闭。
在发生触摸事件时报告用户触摸活动。用户活动用于确定何时显示/隐藏控制器。对于鼠标事件来说这很简单,因为任何鼠标事件都应该显示控制器。所以我们捕获冒泡到播放器的鼠标事件并在发生时报告活动。对于触摸事件,它不像 touchstart
和 touchend
切换播放器控制器那么容易。因此触摸事件在播放器级别也帮不上忙。
用户活动是异步检查的。因此可能发生的情况是,视频上的轻触事件关闭了控制器。然后 touchend
事件冒泡到播放器。如果它报告了用户活动,控制器就会立即重新打开。我们也不希望完全阻止触摸事件冒泡。此外,touchmove
事件和除了轻触之外的任何事件,都不应该重新打开控制器。
- Component#event:touchstart
- Component#event:touchmove
- Component#event:touchend
- Component#event:touchcancel
ended() → {布尔值}
返回播放器是否处于“已结束”状态。
如果播放器处于已结束状态则为 true,否则为 false。
- 类型:
- 布尔值
enterFullWindow()
当不支持全屏时,我们可以将视频容器拉伸到浏览器允许的最大宽度。
error(err可选) → {MediaError|空|未定义}
设置或获取当前 MediaError
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
err | MediaError | | <可选> | 一个 MediaError 或一个将转换为 MediaError 的字符串/数字 |
- 获取时当前 MediaError(或 null)- 设置时无
- 类型:
- MediaError |
空 | 未定义
exitFullWindow()
退出全窗口
exitFullscreen()
将视频从全屏模式返回到正常大小
exitPictureInPicture() → {Promise}
退出画中画模式。
- 参见
一个 Promise。
- 类型:
- Promise
fill(bool可选) → {布尔值|未定义}
Player
上 vjs-fill
类名的获取器/设置器/切换器。
开启此功能将关闭流体模式。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 获取时流体模式的值。- 设置时为
undefined
。
- 类型:
- 布尔值 |
未定义
fluid(bool可选) → {布尔值|未定义}
Player
上 vjs-fluid
类名的获取器/设置器/切换器。
开启此功能将关闭填充模式。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 获取时流体模式的值。- 设置时为
undefined
。
- 类型:
- 布尔值 |
未定义
focus()
将焦点设置到此组件
fullWindowOnEscKey(event)
检查是否通过 ESC 键调用退出全窗口或全屏
名称 | 类型 | 描述 |
---|---|---|
event | 字符串 | 用于检查按键事件 |
getAttribute(attribute) → {字符串|空}
获取Component
元素上的属性值。
名称 | 类型 | 描述 |
---|---|---|
属性 | 字符串 | 要获取其值的属性名称。 |
- 参见
- 请求的属性值。- 在某些浏览器中,如果属性不存在或没有值,则可能为空字符串 - 大多数浏览器在属性不存在或没有值时将返回null。
- 类型:
- 字符串 |
空
getCache() → {对象}
获取缓存值的对象。
获取当前对象缓存
- 类型:
- 对象
getChild(name) → {Component|未定义}
返回具有给定name
的子Component
。
名称 | 类型 | 描述 |
---|---|---|
名称 | 字符串 | 要获取的子 |
具有给定name
的子Component
或undefined。
- 类型:
- Component |
未定义
getChildById(id) → {Component|未定义}
返回具有给定id
的子Component
。
名称 | 类型 | 描述 |
---|---|---|
ID | 字符串 | 要获取的子 |
具有给定id
的子Component
或undefined。
- 类型:
- Component |
未定义
getDescendant(…names) → {Component|undefined}
返回给定后代names
所遵循的后代Component
。例如,['foo', 'bar', 'baz'] 将尝试在当前组件上获取“foo”,在“foo”组件上获取“bar”,在“bar”组件上获取“baz”,如果其中任何一个不存在则返回 undefined。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
名称 | ...Array.<string> | | <可重复> | 要获取的子 |
遵循给定后代names
的后代Component
或undefined。
- 类型:
- Component |
未定义
getIsAvailableToBeFocused(el) → {boolean}
确定此组件是否当前可见/启用/等...
名称 | 类型 | 描述 |
---|---|---|
元素 | HTMLElement | 代表组件的HTML元素。 |
如果组件当前可见且启用,则为true
。否则,为false
。
- 类型:
- 布尔值
getIsFocusable(el) → {boolean}
确定此组件是否可被视为可聚焦组件。
名称 | 类型 | 描述 |
---|---|---|
元素 | HTMLElement | 代表组件的HTML元素。 |
如果组件可以被聚焦,则为true
。否则,为false
。
- 类型:
- 布尔值
getMedia() → {Player~MediaObject}
获取此播放器当前Player~MediaObject的克隆。
如果尚未调用loadMedia
方法,将尝试根据播放器的当前状态返回一个Player~MediaObject。
getPositions() → {Object}
检索组件元素的位置和大小信息。
一个包含boundingClientRect
和center
属性的对象。 - boundingClientRect
:一个包含x
、y
、width
、height
、top
、right
、bottom
和left
属性的对象,表示元素的边界矩形。 - center
:一个包含x
和y
属性的对象,表示元素的中心点。width
和height
设置为0。
- 类型:
- 对象
getVideoPlaybackQuality() → {Object|undefined}
获取 W3C 媒体播放质量 API 指定的可用媒体播放质量指标。
- 参见
一个包含支持的媒体播放质量指标的对象,如果当前播放技术不存在或不支持则为 undefined。
- 类型:
- 对象 |
undefined
handleHotkeys(event)
当此播放器接收到快捷键 keydown 事件时调用。支持的播放器范围内的快捷键有
f - 切换全屏 m - 切换静音 k 或 Space - 切换播放/暂停
名称 | 类型 | 描述 |
---|---|---|
event | 事件 | 导致此函数被调用的 |
handleKeyDown(event)
当此播放器获得焦点并按下某个键时,或当此播放器的任何组件收到其未处理的按键事件时调用。这允许播放器范围内的快捷键(无论是如下定义的,还是由外部函数可选定义的)。
名称 | 类型 | 描述 |
---|---|---|
event | KeyboardEvent | 导致此函数被调用的 |
- event:keydown
handleKeyPress(event)
许多组件曾有一个handleKeyPress
方法,但其命名不佳,因为它监听的是keydown
事件。此方法名现在委托给handleKeyDown
。这意味着任何调用handleKeyPress
的人都不会看到他们的方法调用停止工作。
名称 | 类型 | 描述 |
---|---|---|
event | KeyboardEvent | 导致此函数被调用的事件。 |
(抽象) handleLanguagechange()
处理组件中播放器的语言变化。应由子组件覆盖。
handleSrc_(sourceopt, isRetryopt) → {string|undefined}
执行源设置和获取逻辑
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
源 | Tech~SourceObject | | <可选> | 一个 SourceObject、一个 SourceObject 数组或一个引用媒体源 URL 的字符串。强烈建议在此处使用对象或对象数组,以便源选择算法能够考虑
|
isRetry | 布尔值 | <可选> | 指示这是否是由于重试而在内部调用的。 |
如果source
参数缺失,则返回当前源 URL。否则,不返回任何内容/undefined。
- 类型:
- 字符串 |
未定义
hasClass(classToCheck) → {boolean}
检查组件元素是否具有CSS类名。
名称 | 类型 | 描述 |
---|---|---|
classToCheck | 字符串 | 要检查的CSS类名。 |
- 如果
Component
具有该类,则为True。- 如果Component
不具有该类,则为False。
- 类型:
- 布尔值
hasStarted(request) → {boolean}
添加/移除 vjs-has-started 类
名称 | 类型 | 描述 |
---|---|---|
request | 布尔值 |
|
hasStarted_ 的布尔值
- 类型:
- 布尔值
height(valueopt) → {number|undefined}
Player
高度的 getter/setter。返回播放器的配置值。要获取当前高度,请使用currentheight()
。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 数字 | | <可选> | 用于设置 |
- 获取时,
Player
的当前高度。 - 设置时,无返回值
- 类型:
- 数字 |
未定义
hide()
如果Component
的元素当前正在显示,则通过向其添加“vjs-hidden”类名来隐藏它。
id() → {string}
获取此Component
的ID
此Component
的ID
- 类型:
- 字符串
initChildren()
根据选项添加和初始化默认子Component
。
isAudio(boolopt) → {boolean|undefined}
获取或设置音频标志
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 获取时,isAudio 的当前值 - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
isDisposed() → {boolean}
确定此组件是否已销毁。
如果组件已销毁,则为true
。否则,为false
。
- 类型:
- 布尔值
isFullscreen(isFSopt) → {boolean|undefined}
检查播放器是否处于全屏模式,或者告知播放器是否处于全屏模式。
注意:根据最新的 HTML5 规范,isFullscreen 不再是官方属性,而是使用 document.fullscreenElement。但 isFullscreen 对于播放器内部运作仍然是一个有价值的属性。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
isFS | 布尔值 | <可选> | 设置播放器当前的全屏状态 |
- 获取时,如果全屏开启则为 true - 获取时,如果全屏关闭则为 false - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
isInPictureInPicture(isPiPopt) → {boolean|undefined}
检查播放器是否处于画中画模式,或者告知播放器是否处于画中画模式。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
isPiP | 布尔值 | <可选> | 设置播放器当前的画中画状态 |
- 获取时,如果画中画开启则为 true - 获取时,如果画中画关闭则为 false - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
language(codeopt) → {string|undefined}
设置或获取播放器的语言代码。
更改语言将触发languagechange事件,组件可利用此事件更新控制文本。ClickableComponent 默认会在languagechange事件上更新其控制文本。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
code | 字符串 | <可选> | 要为播放器设置的语言代码 |
- 获取时,当前的语言代码 - 设置时,无返回值
- 类型:
- 字符串 |
未定义
languages() → {Array}
获取播放器的语言字典。每次都合并,因为新添加的插件可能随时调用 videojs.addLanguage()。直接在播放器选项中指定的语言具有优先权。
一个包含支持语言的数组
- 类型:
- 数组
load()
开始加载 src 数据。
loadMedia(media, ready)
使用MediaObject填充播放器。
名称 | 类型 | 描述 |
---|---|---|
媒体对象 | Player~MediaObject | 一个媒体对象。 |
准备就绪 | 函数 | 当播放器准备就绪时要调用的回调函数。 |
localize(string, tokensopt, defaultValueopt) → {string}
给定英文字符串,将字符串本地化。
如果提供了令牌,它将尝试对提供的字符串进行简单的令牌替换。它查找的令牌看起来像{1}
,其中索引是令牌数组中的1-indexed。
如果提供了defaultValue
,当在提供的语言文件中未找到值时,将优先使用它而不是string
。这在您希望为令牌替换设置描述性键但又需要一个简洁的本地化字符串且不需要包含en.json
时非常有用。
目前,它用于进度条计时。
{
"progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}
然后像这样使用
this.localize('progress bar timing: currentTime={1} duration{2}',
[this.player_.currentTime(), this.player_.duration()],
'{1} of {2}');
输出类似:01:23 of 24:56
。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
字符串 | 字符串 | 要本地化的字符串和在语言文件中查找的键。 | |
令牌 | Array.<string> | <可选> | 如果当前项有令牌替换,请在此处提供令牌。 |
默认值 | 字符串 | <可选> | 默认为 |
本地化字符串,或者如果不存在本地化,则为英文字符串。
- 类型:
- 字符串
loop(valueopt) → {boolean|undefined}
获取或设置视频元素的循环属性。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> |
|
- 获取时,loop 的当前值 - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
manualAutoplay_()
处理自动播放字符串值,而不是应由技术栈处理的典型布尔值。请注意,这不是任何规范的一部分。有效值及其作用可以在 Player#autoplay() 的自动播放 getter 上找到。
muted(mutedopt) → {boolean|undefined}
获取当前的静音状态,或开启/关闭静音
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
muted | 布尔值 | <可选> |
|
- 获取时,如果静音开启则为 true - 获取时,如果静音关闭则为 false - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
name() → {string}
获取Component
的名称。该名称用于引用Component
并在注册期间设置。
此Component
的名称。
- 类型:
- 字符串
networkState() → {number}
返回元素的当前网络活动状态,来自以下列表中的代码。
- NETWORK_EMPTY (数值 0) 元素尚未初始化。所有属性均处于其初始状态。
- NETWORK_IDLE (数值 1) 元素的资源选择算法处于活动状态并已选择了一个资源,但此时并未实际使用网络。
- NETWORK_LOADING (数值 2) 用户代理正在积极尝试下载数据。
- NETWORK_NO_SOURCE (数值 3) 元素的资源选择算法处于活动状态,但尚未找到可用的资源。
当前网络活动状态
- 类型:
- 数字
options(obj) → {Object}
使用新选项深度合并选项对象。
注意:当
obj
和options
都包含其值为对象的属性时。这两个属性将使用module:obj.merge合并
名称 | 类型 | 描述 |
---|---|---|
对象 | 对象 | 包含新选项的对象。 |
this.options_
和obj
合并后的新对象。
- 类型:
- 对象
pause()
暂停视频播放
paused() → {boolean}
检查播放器是否已暂停或尚未播放
- false: 如果媒体当前正在播放 - true: 如果媒体当前未播放
- 类型:
- 布尔值
play() → {Promise|undefined}
尝试在第一时间开始播放。
如果浏览器支持 Promise (或作为选项传入),则返回一个 Promise。此 Promise 将在 play 的返回值上解析。如果此值为 undefined,它将实现 Promise 链;否则,当 play 返回的 Promise 被实现时,Promise 链将被实现。
- 类型:
- Promise |
undefined
playbackRate(rateopt) → {number|undefined}
获取或设置当前播放速率。例如,播放速率 1.0 表示正常速度,0.5 表示半速播放。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
rate | 数字 | <可选> | 要设置的新播放速率。 |
- 获取时,当前播放速率或 1.0 - 设置时,无返回值
- 类型:
- 数字 |
未定义
playbackRates(newRatesopt) → {Array.<number>}
设置或获取当前播放速率。接受一个数组并用新项目更新播放速率菜单。传入一个空数组将隐藏菜单。非数组值将被忽略。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
newRates | Array.<number> | <可选> | 播放速率菜单应更新到的新速率。一个空数组将隐藏菜单 |
用作 getter 时,将返回当前播放速率
- 类型:
- Array.<number>
played() → {TimeRange}
获取一个 TimeRange 对象,表示用户已播放的时间范围。
一个时间范围对象,表示所有已播放的时间增量。
- 类型:
- 时间范围
player() → {Player}
返回Component
所附着的Player。
此Component
所附着的播放器。
- 类型:
- Player
playsinline(valueopt) → {string|undefined}
设置或取消设置 playsinline 属性。Playsinline 告知浏览器非全屏播放是首选。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> |
|
- 参见
- 获取时,playsinline 的当前值 - 设置时,无返回值
- 类型:
- 字符串 |
未定义
poster(srcopt) → {string|undefined}
获取或设置海报图片的源 URL
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
src | 字符串 | <可选> | 海报图片源 URL |
- 获取时,poster 的当前值 - 设置时,无返回值
- 类型:
- 字符串 |
未定义
preload(valueopt) → {string|undefined}
获取或设置预加载属性
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 'none' | | <可选> | 要传递给技术的预加载模式 |
- 获取时,预加载属性值 - 设置时,无返回值
- 类型:
- 字符串 |
未定义
ready(fn)
将监听器绑定到组件的就绪状态。与事件监听器不同,如果就绪事件已经发生,它将立即触发函数。
名称 | 类型 | 描述 |
---|---|---|
函数 | 准备就绪回调 | 当 |
readyState() → {number}
返回一个值,表示元素相对于渲染当前播放位置的当前状态,来自以下列表中的代码。
- HAVE_NOTHING (数值 0) 没有关于媒体资源的可用信息。
- HAVE_METADATA (数值 1) 已获得足够的资源,使得资源的持续时间可用。
- HAVE_CURRENT_DATA (数值 2) 当前播放位置的即时数据可用。
- HAVE_FUTURE_DATA (数值 3) 当前播放位置的即时数据可用,并且有足够的数据供用户代理在播放方向上推进当前播放位置。
- HAVE_ENOUGH_DATA (数值 4) 用户代理估计有足够的数据可供播放不中断地进行。
当前播放渲染状态
- 类型:
- 数字
remainingTime() → {number}
计算视频剩余时间。不是原生视频 API 的一部分。
剩余时间(秒)
- 类型:
- 数字
remainingTimeDisplay() → {number}
一个剩余时间函数,旨在当时间需要直接显示给用户时使用。
四舍五入后的剩余时间(秒)
- 类型:
- 数字
remoteTextTrackEls() → {HtmlTrackElementList}
获取远程HtmlTrackElementList轨道。
当前远程文本轨道元素列表
remoteTextTracks() → {TextTrackList}
获取远程TextTrackList
当前远程文本轨道列表
- 类型:
- TextTrackList
removeAttribute(attribute)
从Component
的元素中移除属性。
名称 | 类型 | 描述 |
---|---|---|
属性 | 字符串 | 要移除的属性名称。 |
- 参见
removeChild(component)
从此Component
的子项列表中移除子Component
。同时从此Component
的元素中移除子Component
的元素。
名称 | 类型 | 描述 |
---|---|---|
组件 | Component | 要移除的子 |
removeClass(…classesToRemove)
从Component
的元素中移除CSS类名。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
要移除的类 | 字符串 | <可重复> | 一个或多个要移除的CSS类名。 |
removeRemoteTextTrack(track) → {undefined}
从相应的TextTrackList和HtmlTrackElementList中移除一个远程TextTrack。
名称 | 类型 | 描述 |
---|---|---|
track | 对象 | 要移除的远程TextTrack |
不返回任何内容
- 类型:
- undefined
removeSourceElement(srcUrl) → {boolean}
移除一个
名称 | 类型 | 描述 |
---|---|---|
srcUrl | 字符串 | 要移除的源的 URL。 |
如果源元素成功移除则返回 true,否则返回 false。
- 类型:
- 布尔值
reportUserActivity(event)
报告用户活动
名称 | 类型 | 描述 |
---|---|---|
event | 对象 | 事件对象 |
requestAnimationFrame(fn) → {number}
将回调排队传递给requestAnimationFrame (rAF),但有一些额外的优点
通过回退到Component#setTimeout来支持不支持rAF的浏览器。
回调被转换为Component~GenericCallback(即绑定到组件)。
如果组件在调用之前被销毁,则会自动取消rAF回调。
名称 | 类型 | 描述 |
---|---|---|
函数 | Component~GenericCallback | 一个函数,它将绑定到此组件并在浏览器下一次重绘之前执行。 |
- 参见
返回一个rAF ID,用于标识超时。它也可以在Component#cancelAnimationFrame中使用以取消动画帧回调。
- 类型:
- 数字
requestFullscreen(fullscreenOptionsopt)
将视频尺寸增加到全屏。在某些浏览器中,全屏不支持原生模式,因此会进入“全窗口模式”,视频将填充浏览器窗口。在支持原生全屏的浏览器和设备中,有时会显示浏览器的默认控件,而不是 Video.js 自定义皮肤。这包括大多数移动设备(iOS、Android)和旧版本的 Safari。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
fullscreenOptions | 对象 | <可选> | 覆盖播放器的全屏选项 |
requestNamedAnimationFrame(name, fn)
请求一个动画帧,但只排队一个命名动画帧。在前面的动画帧完成之前,永远不会添加另一个。
名称 | 类型 | 描述 |
---|---|---|
名称 | 字符串 | 此requestAnimationFrame的名称 |
函数 | Component~GenericCallback | 一个函数,它将绑定到此组件并在浏览器下一次重绘之前执行。 |
requestPictureInPicture() → {Promise}
创建一个浮动视频窗口,始终置于其他窗口之上,以便用户在与设备上的其他内容网站或应用程序交互时,可以继续观看媒体。
这可以使用文档画中画(document picture-in-picture)或元素画中画(element picture in picture)
在支持的浏览器上,将enableDocumentPictureInPicture
设置为true
以使用 docPiP;否则,将disablePictureInPicture
设置为false
以禁用支持浏览器上的 elPiP。
一个带有画中画窗口的 Promise。
- 类型:
- Promise
reset()
重置播放器。加载 techOrder 中的第一个技术,移除现有tech
中的所有文本轨道,并调用tech
上的reset
。
resetControlBarUI_()
通过调用重置控制栏所有组件的子方法来重置控制栏的用户界面。
resetPlaybackRate_()
重置播放比例
resetProgressBar_()
重置技术的进度,以便在用户界面中重置进度条
resetVolumeBar_()
重置音量条
responsive(valueopt) → {boolean|undefined}
获取或设置一个标志,指示此播放器是否应根据其尺寸调整其用户界面。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 布尔值 | <可选> | 如果播放器应根据其尺寸调整其用户界面,则应为 |
获取时,如果此播放器应根据其尺寸调整其用户界面,则为true
;否则为false
。设置时,无返回值
- 类型:
- 布尔值 |
未定义
runPlayCallbacks_(val)
当播放回调被延迟时,我们必须在实际在技术栈上调用播放时运行这些回调。此函数运行被延迟的回调并接受来自技术栈的返回值。
名称 | 类型 | 描述 |
---|---|---|
val | undefined | | 来自技术的返回值。 |
runPlayTerminatedQueue_()
当播放终止时,这些函数将被运行。如果运行了 runPlayCallbacks_,则这些函数将不被运行。这使我们能够区分终止的播放和实际的播放调用。
scrubbing(isScrubbingopt) → {boolean|undefined}
设置或返回用户是否正在“拖动”。“拖动”是指用户点击了进度条滑块并沿进度条拖动它。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
isScrubbing | 布尔值 | <可选> | 用户是否正在拖动 |
- 获取时,scrubbing 的值 - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
seekable() → {TimeRange}
获取当前可用于跳转的媒体时间范围(TimeRanges)。
- 参见
一个模拟的 TimeRanges 对象(遵循 HTML 规范)
- 类型:
- 时间范围
seeking() → {boolean}
返回播放器是否处于“正在跳转”状态。
如果播放器处于正在跳转状态则为 true,否则为 false。
- 类型:
- 布尔值
selectSource(sources) → {Object|boolean}
根据技术顺序或源顺序选择源。如果options.sourceOrder
为真,则使用源顺序选择;否则,默认为技术顺序选择。
名称 | 类型 | 描述 |
---|---|---|
sources | 数组 | 媒体资产的源 |
源和技术顺序的对象,或 false
- 类型:
- 对象 |
布尔值
setAttribute(attribute, value)
设置Component
元素上的属性值
名称 | 类型 | 描述 |
---|---|---|
属性 | 字符串 | 要设置的属性名称。 |
值 | 字符串 | 要将属性设置为的值。 |
- 参见
setIcon(iconName, elopt) → {Element}
向另一个元素或组件添加SVG图标元素。
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
图标名称 | 字符串 | 图标的名称。所有图标名称的列表可以在“sandbox/svg-icons.html”中找到 | ||
元素 | 元素 | <可选> | this.el() | 要设置标题的元素。默认为当前组件的元素。 |
新创建的图标元素。
- 类型:
- 元素
setInterval(fn, interval) → {number}
创建一个每x
毫秒运行一次的函数。此函数是window.setInterval
的包装。但仍有一些原因选择使用此函数。
- 当Component#dispose被调用时,它通过Component#clearInterval被清除。
- 函数回调将是Component~GenericCallback
名称 | 类型 | 描述 |
---|---|---|
函数 | Component~GenericCallback | 每 |
间隔 | 数字 | 每 |
- 参见
返回一个可用于标识间隔的ID。它也可以在Component#clearInterval中使用以清除间隔。
- 类型:
- 数字
setTimeout(fn, timeout) → {number}
创建一个在x
毫秒超时后运行的函数。此函数是window.setTimeout
的包装。但仍有一些原因选择使用此函数
- 当Component#dispose被调用时,它通过Component#clearTimeout被清除。
- 函数回调将被转换为Component~GenericCallback
注意:您不能对此函数返回的 id 使用
window.clearTimeout
。这会导致其 dispose 监听器无法被清除!请改用Component#clearTimeout或Component#dispose。
名称 | 类型 | 描述 |
---|---|---|
函数 | Component~GenericCallback | 将在 |
超时 | 数字 | 在执行指定函数之前延迟的毫秒数。 |
- 参见
返回一个超时ID,用于标识超时。它也可以在Component#clearTimeout中使用以清除已设置的超时。
- 类型:
- 数字
show()
如果Component
的元素被隐藏,则通过从其移除“vjs-hidden”类名来显示它。
src(sourceopt) → {string|undefined}
获取或设置视频源。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
源 | Tech~SourceObject | | <可选> | 一个 SourceObject、一个 SourceObject 数组或一个引用媒体源 URL 的字符串。强烈建议在此处使用对象或对象数组,以便源选择算法能够考虑
|
如果source
参数缺失,则返回当前源 URL。否则,不返回任何内容/undefined。
- 类型:
- 字符串 |
未定义
supportsFullScreen() → {boolean}
检查当前技术栈是否支持原生全屏(例如,带有 iOS 等内置控件)
如果支持原生全屏
- 类型:
- 布尔值
tech(safetyopt) → {Tech}
返回对当前Tech的引用。默认情况下,它会打印关于直接使用该技术栈的危险警告,但传入任何参数都会消除该警告。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
safety | * | <可选> | 传入任何值以消除警告 |
技术栈
- 类型:
- Tech
textTracks() → {TextTrackList}
当前文本轨道列表
- 类型:
- TextTrackList
toJSON() → {Object}
返回一个表示当前轨道信息的 JavaScript 对象。不以 JSON 格式返回
表示当前轨道信息的对象
- 类型:
- 对象
toggleClass(classToToggle, predicateopt)
向组件的元素添加或移除CSS类名。
- 当Component#hasClass返回false时,添加
classToToggle
。 - 当Component#hasClass返回true时,移除
classToToggle
。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
classToToggle | 字符串 | 要添加或移除的类。传递给DOMTokenList的toggle() | |
谓词 | boolean | | <可选> | 一个布尔值或返回布尔值的函数。传递给DOMTokenList的toggle()。 |
triggerReady()
触发此Component
的所有就绪监听器。
updateSourceCaches_(srcObj)
更新内部源缓存,以便我们从src()
、currentSource()
和currentSources()
返回正确的源。
注意:如果传入的源已存在于当前
currentSources
缓存中,则currentSources
不会更新。
名称 | 类型 | 描述 |
---|---|---|
源对象 | Tech~SourceObject | 用于更新我们缓存的字符串或对象源。 |
userActive(boolopt) → {boolean|undefined}
获取/设置用户是否活跃
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 获取时,userActive 的当前值 - 设置时,无返回值
- 类型:
- 布尔值 |
未定义
usingNativeControls(boolopt) → {boolean|undefined}
开启/关闭原生控件。原生控件是设备内置的控件(例如,iPhone 默认控件)或其他技术栈(例如,Vimeo 控件)。此设置应仅由当前技术栈设置,因为只有技术栈才知道它是否支持原生控件
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
bool | 布尔值 | <可选> |
|
- 原生控件的当前值(获取时)- 无(设置时)
- 类型:
- 布尔值 |
未定义
usingPlugin(name) → {boolean}
报告播放器是否按名称使用某个插件。
对于基本插件,这仅报告该插件是否曾在该播放器上初始化过。
名称 | 类型 | 描述 |
---|---|---|
名称 | 字符串 | 插件名称。 |
此播放器是否正在使用所请求的插件。
- 类型:
- 布尔值
version() → {PlayerVersion}
返回一个包含 Video.js 版本的对象。
一个包含 Video.js 版本的对象。
- 类型:
- 播放器版本
videoHeight() → {number}
获取视频高度
当前视频高度
- 类型:
- 数字
videoTracks() → {VideoTrackList}
当前视频轨道列表
- 类型:
- VideoTrackList
videoWidth() → {number}
获取视频宽度
当前视频宽度
- 类型:
- 数字
volume(percentAsDecimalopt) → {number|undefined}
获取或设置媒体的当前音量
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
percentAsDecimal | 数字 | <可选> | 新音量,以小数百分比表示: - 0 为静音/0%/关闭 - 1.0 为 100%/最大音量 - 0.5 为半音量或 50% |
获取时为当前音量百分比
- 类型:
- 数字 |
未定义
width(valueopt) → {number|undefined}
`Player` 宽度的 getter/setter。返回播放器的配置值。要获取当前宽度,请使用 `currentWidth()`。
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
值 | 数字 | | <可选> | 用于设置 `Player` 宽度的 CSS 值。 |
- 获取时 `Player` 的当前宽度。- 设置时无。
- 类型:
- 数字 |
未定义
(static) getTagSettings(tag) → {Object}
获取标签设置
名称 | 类型 | 描述 |
---|---|---|
标签 | 元素 | 播放器标签 |
一个包含播放器标签所有设置的对象
- 类型:
- 对象
类型定义
MediaObject
描述单个媒体的对象。
不属于此类型描述的属性将被保留;因此,这也可以被视为一种通用的元数据存储机制。
- 对象
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
album | 字符串 | <可选> | 未使用,除非此对象传递给 `MediaSession` API。 |
artist | 字符串 | <可选> | 未使用,除非此对象传递给 `MediaSession` API。 |
artwork | 数组.<Object> | <可选> | 未使用,除非此对象传递给 `MediaSession` API。如果未指定,将通过 `poster`(如果可用)填充。 |
poster | 字符串 | <可选> | 播放前将显示的图像的 URL。 |
src | Tech~SourceObject | | <可选> | 单个源对象、源对象数组或引用媒体源 URL 的字符串。强烈建议在此处使用对象或对象数组,以便源选择算法可以考虑 `type`。 |
title | 字符串 | <可选> | 未使用,除非此对象传递给 `MediaSession` API。 |
textTracks | 数组.<Object> | <可选> | 用于创建文本轨道的对象数组,遵循 原生轨道元素格式。为了便于移除,这些轨道将作为“远程”文本轨道创建,并设置为在源更改时自动清理。
|
事件
插件设置前:$name
表示将要通过名称在播放器上设置插件。该名称是插件的名称。
中止
在音频/视频加载中止时触发。
插件设置前
表示将要设置一个插件到播放器上。
可以播放
媒体的 readyState 为 HAVE_FUTURE_DATA 或更高。
可以播放完整
媒体的 readyState 为 HAVE_ENOUGH_DATA 或更高。这意味着整个媒体文件可以不经过缓冲播放。
组件尺寸改变
当组件大小调整时触发。
控制器禁用
控制器启用
销毁
播放器被处置时调用。
时长改变
已清空
当前播放列表为空时触发。
已结束
媒体资源播放结束时触发 (currentTime == duration)
进入全窗口
进入画中画
当播放器进入画中画模式时触发此事件。
错误
退出全窗口
全屏改变
语言改变
当播放器语言更改时触发
离开画中画
当播放器离开画中画模式时触发此事件。
数据已加载
当浏览器加载完音频/视频的当前帧时触发。
- event
数据已加载
当播放器在当前播放位置下载完数据时触发。
元数据已加载
当浏览器加载完音频/视频的元数据时触发。
元数据已加载
当播放器获得初始时长和尺寸信息时触发。
开始加载
当用户代理开始查找媒体数据时触发。
暂停
媒体暂停时触发。
播放
每当发生 Tech#play 事件时触发。表示播放已开始或恢复。
播放速率改变
当播放器中的播放速率更改时触发。
播放器尺寸改变
播放器大小更改时调用。
正在播放
媒体不再被阻止播放,并已开始播放。
插件设置
表示已在播放器上设置了一个插件。
海报改变
当播放器上的海报图像更改时触发此事件。
进度
当用户代理正在下载媒体数据时触发。
速率改变
当音频/视频的播放速度更改时触发。
- event
准备就绪
当Component
就绪时触发。
尺寸改变
当视频的固有尺寸更改时触发。
- event
已跳转
当播放器完成跳到新时间点时触发。
正在跳转
每当播放器跳到新时间点时触发。
源设置
实验性 当在 Tech 上设置或更改源导致媒体元素重新加载时触发。
它将针对初始源和每个后续源触发。此事件是 Video.js 的自定义事件,由 Tech 触发。
此事件的事件对象包含一个 `src` 属性,该属性将包含事件触发时可用的源。这通常仅在 Video.js 在源更改时切换技术时才需要。
当在播放器(或媒体元素)上调用 `load` 时也会触发此事件,因为 `load` 的规范表明资源选择算法需要中止并重新启动。在这种情况下,`src` 属性很可能被设置为空字符串 `""`,以表示我们不知道源将是什么,但它正在更改。
此事件目前仍处于实验阶段,可能会在次要版本中更改。 要使用此功能,请将 `enableSourceset` 选项传递给播放器。
名称 | 类型 | 描述 |
---|---|---|
src | 字符串 | 当 `sourceset` 触发时可用的源 URL。如果我们无法知道源是什么但知道源会更改,它将是一个空字符串。 |
停滞
当浏览器尝试获取媒体数据但数据不可用时触发。
挂起
当浏览器有意不获取媒体数据时触发。
轻触
当Component
被轻触时触发。
- MouseEvent
文本数据
当从 tech 获得 textdata 事件时触发。
文本轨道改变
当文本轨道更改时触发。
- event
时间更新
当当前播放位置更改时触发。
- event
时间更新
当当前播放位置更改时触发 * 在播放过程中,这会根据所使用的播放技术,每 15-250 毫秒触发一次。
用户活跃
用户不活跃
正在使用自定义控制器
播放器正在使用自定义 HTML 控件
正在使用原生控制器
播放器正在使用原生设备控件
音量改变
当音量更改时触发。
- event
音量改变
当音量更改时触发。
等待
DOM 元素上的 readyState 更改导致播放停止。
插件设置:$name
表示已通过名称在播放器上设置了一个插件。该名称是插件的名称。