Tech

这是媒体播放技术控制器的基类,例如 HTML5。

构造函数

new Tech(optionsopt, readyopt)

创建此 Tech 的实例。

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

播放器选项的键/值存储。

readyfunction<可选>

HTML5 Tech 准备就绪时要调用的回调函数。

继承

成员

featuresFullscreenResize :boolean

布尔值,指示此 Tech 是否支持全屏调整大小控制。使用 request fullscreen 调整插件大小会重新加载插件。

类型
  • 布尔值

featuresMuteControl :boolean

布尔值,指示此 Tech 是否支持音量静音。

类型
  • 布尔值
默认值
  • true

featuresNativeTextTracks :boolean

布尔值,指示此 Tech 是否支持原生 TextTrack。如果浏览器支持,这将帮助我们与原生 TextTrack 集成。

类型
  • 布尔值

featuresPlaybackRate :boolean

布尔值,指示此 Tech 是否支持更改视频播放速度。示例:

  • 将播放器设置为 2 倍(两倍)速播放
  • 将播放器设置为 0.5 倍(一半)速播放
类型
  • 布尔值

featuresProgressEvents :boolean

布尔值,指示此 Tech 是否支持 progress 事件。这将用于确定是否应调用 Tech#manualProgressOn

类型
  • 布尔值

featuresSourceset :boolean

布尔值,指示此 Tech 是否支持 sourceset 事件。

Tech 应该将其设置为 true,然后使用 Tech#triggerSourceset 在获取新源后尽早触发 Tech#event:sourceset

类型
  • 布尔值

featuresTimeupdateEvents :boolean

布尔值,指示此 Tech 是否支持 timeupdate 事件。这将用于确定是否应调用 Tech#manualTimeUpdates。

类型
  • 布尔值

featuresVideoFrameCallback :boolean

布尔值,指示此 Tech 是否支持 requestVideoFrameCallback

类型
  • 布尔值

featuresVolumeControl :boolean

布尔值,指示此 Tech 是否支持音量控制。

类型
  • 布尔值
默认值
  • true

方法

$(selector, contextopt) → {Element|null}

查找匹配selector的单个DOM元素。这可以在ComponentcontentEl()中或另一个自定义上下文中进行。

参数
名称类型属性默认描述
选择器string

一个有效的CSS选择器,将传递给querySelector

上下文Element | string<可选>
this.contentEl()

用于查询的 DOM 元素。也可以是选择器字符串,在这种情况下,第一个匹配的元素将用作上下文。如果缺失,则使用 this.contentEl()。如果 this.contentEl() 未返回任何内容,则回退到 document

返回

找到的DOM元素,或null

类型: 
Element | null

$$(selector, contextopt) → {NodeList}

查找匹配selector的所有DOM元素。这可以在ComponentcontentEl()中或另一个自定义上下文中进行。

参数
名称类型属性默认描述
选择器string

一个有效的CSS选择器,将传递给querySelectorAll

上下文Element | string<可选>
this.contentEl()

用于查询的 DOM 元素。也可以是选择器字符串,在这种情况下,第一个匹配的元素将用作上下文。如果缺失,则使用 this.contentEl()。如果 this.contentEl() 未返回任何内容,则回退到 document

返回

找到的DOM元素列表

类型: 
NodeList

addChild(child, optionsopt, indexopt) → {Component}

在当前Component中添加一个子Component

参数
名称类型属性默认描述
子项string | Component

要添加的子项的名称或实例。

选项Object<可选>
{}

将传递给子项的子项的选项的键/值存储。

索引数字<可选>
this.children_.length

尝试添加子项的索引。

返回

作为子项添加的Component。使用字符串时,Component将由该过程创建。

类型: 
Component

addClass(…classesToAdd)

Component的元素添加CSS类名。

参数
名称类型属性描述
要添加的类string<可重复>

一个或多个要添加的CSS类名。

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

创建远程文本轨道对象并返回一个 HTML 轨道元素。

注意:这可以是一个模拟的 HTMLTrackElement 或原生的。

参数
名称类型属性默认描述
选项Object

有关更多详细属性,请参阅 Tech#createRemoteTextTrack

手动清理布尔值<可选>
  • 当为 false 时:每当源更改时,TextTrack 将自动从视频元素中移除 - 当为 true 时:TextTrack 将需要手动清理
返回

一个 HTML 轨道元素。

类型: 
HTMLTrackElement

addTextTrack(kind, labelopt, languageopt) → {TextTrack}

创建并返回一个远程 TextTrack 对象。

参数
名称类型属性描述
类型string

TextTrack 类型(字幕、说明、描述、章节或元数据)

标签string<可选>

用于识别文本轨道的标签

语言string<可选>

两位字母的语言缩写

返回

创建的 TextTrack。

类型: 
TextTrack

addWebVttScript_()

如有必要,使用 vtt.js 模拟 TextTrack

触发

audioTracks() → {AudioTrackList}

返回
类型: 
AudioTrackList

blur()

从此组件中移除焦点

buffered() → {TimeRange}

获取并创建一个用于缓冲的 TimeRange 对象。

返回

已创建的时间范围对象。

类型: 
TimeRange

bufferedPercent() → {number}

获取当前视频已缓冲的百分比。

返回

一个介于 0 到 1 之间的数字,表示视频已缓冲的百分比(小数形式)。

类型: 
数字

(abstract) buildCSSClass() → {string}

构建默认的DOM类名。应由子组件覆盖。

返回

此对象的DOM类名。

类型: 
string

(abstract) canPlayType(_type) → {string}

检查 Tech 是否支持给定的 mime 类型。

基本 Tech 不支持任何类型,但源处理程序可能会覆盖此功能。

参数
名称类型描述
_typestring

要检查支持的 mime 类型

参见
返回

'probably'、'maybe' 或空字符串

类型: 
string

cancelAnimationFrame(id) → {number}

取消传递给Component#requestAnimationFrame (rAF) 的排队回调。

如果您通过 Component#requestAnimationFrame 排队一个 rAF 回调,请使用此函数而不是 window.cancelAnimationFrame。否则,您的 dispose 监听器将不会被清理,直到 Component#dispose

参数
名称类型描述
ID数字

要清除的rAF ID。Component#requestAnimationFrame的返回值。

参见
返回

返回已清除的rAF ID。

类型: 
数字

cancelNamedAnimationFrame(name)

如果存在,取消当前的命名动画帧。

参数
名称类型描述
名称string

要取消的requestAnimationFrame的名称。

cancelVideoFrameCallback(id)

cancelVideoFrameCallback 的回退实现

参数
名称类型描述
ID数字

要取消的回调 ID

children() → {Array}

获取所有子组件的数组

返回

子项

类型: 
数组

cleanupAutoTextTracks()

移除通过 addRemoteTextTrack 添加并标记为自动垃圾回收的任何 TextTrack

clearInterval(intervalId) → {number}

清除通过 window.setIntervalComponent#setInterval 创建的间隔。如果您通过 Component#setInterval 设置了一个间隔,请使用此函数而不是 window.clearInterval。否则,您的 dispose 监听器将不会被清理,直到 Component#dispose

参数
名称类型描述
intervalId数字

要清除的间隔ID。Component#setIntervalwindow.setInterval的返回值。

参见
返回

返回已清除的间隔ID。

类型: 
数字

clearTimeout(timeoutId) → {number}

清除通过 window.setTimeoutComponent#setTimeout 创建的超时。如果您通过 Component#setTimeout 设置了一个超时,请使用此函数而不是 window.clearTimout。否则,您的 dispose 监听器将不会被清理,直到 Component#dispose

参数
名称类型描述
timeoutId数字

要清除的超时ID。Component#setTimeoutwindow.setTimeout的返回值。

参见
返回

返回已清除的超时ID。

类型: 
数字

clearTracks(types)

清除单个 TrackList 或给定其名称的 TrackLists 数组。

注意:没有源处理程序的 Tech 应该在 videoaudio 轨道源之间调用此函数。您不希望在轨道之间使用它们!

参数
名称类型描述
类型Array.<string> | string

要清除的 TrackList 名称,有效名称为 videoaudiotext

contentEl() → {Element}

返回Component的DOM元素。子项将插入到此处。这通常与Component#el中返回的元素相同。

返回

Component的内容元素。

类型: 
元素

createEl(tagNameopt, propertiesopt, attributesopt) → {Element}

创建 Component 的 DOM 元素。

参数
名称类型属性描述
tagName (标签名)string<可选>

元素的 DOM 节点类型。例如 'div'

properties (属性)Object<可选>

应设置的属性对象。

属性Object<可选>

应设置的属性对象。

返回

创建的元素。

类型: 
元素

createRemoteTextTrack(options) → {HTMLTrackElement}

创建一个模拟的 TextTrack 供 addRemoteTextTrack 使用

此方法旨在由继承自 Tech 的类覆盖,以创建原生或自定义 TextTrack。

参数
名称类型描述
选项Object

该对象应包含用于初始化 TextTrack 的选项。

属性
名称类型属性描述
类型string<可选>

TextTrack 类型(字幕、说明、描述、章节或元数据)。

标签string<可选>

用于识别文本轨道的标签

语言string<可选>

两位字母的语言缩写。

返回

创建的轨道元素。

类型: 
HTMLTrackElement

(abstract) crossOrigin()

从 Tech 中获取 crossOrigin 的值。

currentDimension(widthOrHeight) → {number}

获取组件元素的计算宽度或高度。

使用window.getComputedStyle

参数
名称类型描述
宽度或高度string

包含“width”或“height”的字符串。您想获取的任何一个。

返回

请求的维度,如果该维度未设置,则为0。

类型: 
数字

currentDimensions() → {Component~DimensionObject}

获取一个包含组件元素计算宽度和高度值的对象。

使用window.getComputedStyle

返回

组件元素的计算维度。

类型: 
Component~DimensionObject

currentHeight() → {number}

获取组件元素的计算高度。

使用window.getComputedStyle

返回

组件元素的计算高度。

类型: 
数字

currentWidth() → {number}

获取组件元素的计算宽度。

使用window.getComputedStyle

返回

组件元素的计算宽度。

类型: 
数字

dimension(widthOrHeight, numopt, skipListenersopt) → {number|undefined}

获取或设置Component元素的宽度或高度。这是Component#widthComponent#height的共享代码。

需要了解的事项

  • 如果宽度或高度是数字,这将返回以“px”为后缀的数字。
  • 如果宽度/高度是百分比,这将返回以“%”为后缀的百分比
  • 隐藏元素在使用 window.getComputedStyle 时宽度为 0。此函数默认使用 Componentstyle.width,并回退到 window.getComputedStyle。有关更多信息,请参阅此处
  • 如果您想要组件的计算样式,请使用Component#currentWidth和{Component#currentHeight
参数
名称类型属性描述
宽度或高度string

8 'width' 或 'height'

数字number | string<可选>

8 新维度

跳过监听器布尔值<可选>

跳过componentresize事件触发

返回

获取时的维度,如果未设置则为0

类型: 
number | undefined

dimensions(width, height)

同时设置Component元素的宽度和高度。

参数
名称类型描述
宽度number | string

要设置Component元素的宽度。

高度number | string

要设置Component元素的高度。

(abstract) disablePictureInPicture()

检查 'disablePictureInPicture' 值的 方法

dispose()

关闭所有事件 polyfill,清除 TechAudioTrackListVideoTrackListTextTrackList,并销毁此 Tech。

el() → {Element}

获取Component的DOM元素

返回

Component的DOM元素。

类型: 
元素

(protected) emitTapEvents()

检测到触摸事件支持时发出“tap”事件。这用于通过轻触视频来支持切换控件。它们之所以启用,是因为否则每个子组件都会有额外的开销。

监听事件
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchleave
  • Component#event:touchcancel
  • Component#event:touchend

emulateTextTracks()

模拟文本轨道

enableTouchActivity()

此函数在触摸事件发生时报告用户活动。这可以被任何希望触摸事件以其他方式运行的子组件关闭。

在触摸事件发生时报告用户触摸活动。用户活动用于确定何时显示/隐藏控件。对于鼠标事件来说很简单,因为任何鼠标事件都应该显示控件。因此,我们捕获冒泡到播放器的鼠标事件,并在发生时报告活动。对于触摸事件,它不像 touchstarttouchend 切换播放器控件那么容易。因此,触摸事件也无法在播放器级别帮助我们。

用户活动是异步检查的。因此可能发生的情况是,视频上的轻触事件关闭了控件。然后 touchend 事件冒泡到播放器。如果它报告了用户活动,就会立即重新打开控件。我们也不希望完全阻止触摸事件冒泡。此外,touchmove 事件和除轻触之外的任何事件都不应重新打开控件。

监听事件
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchend
  • Component#event:touchcancel

error(erropt) → {MediaError|null}

获取或设置 Tech 上的错误。

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

要在 Tech 上设置的错误

返回

Tech 上的当前错误对象,如果没有则为 null。

类型: 
MediaError | null

focus()

将焦点设置到此组件

getAttribute(attribute) → {string|null}

获取Component元素上的属性值。

参数
名称类型描述
属性string

要获取其值的属性名称。

参见
返回
  • 请求的属性值。- 在某些浏览器中,如果属性不存在或没有值,则可能为空字符串 - 大多数浏览器在属性不存在或没有值时将返回null。
类型: 
string | null

getChild(name) → {Component|undefined}

返回具有给定name的子Component

参数
名称类型描述
名称string

要获取的子Component的名称。

返回

具有给定name的子Component或undefined。

类型: 
Component | undefined

getChildById(id) → {Component|undefined}

返回具有给定id的子Component

参数
名称类型描述
IDstring

要获取的子Component的ID。

返回

具有给定id的子Component或undefined。

类型: 
Component | undefined

getDescendant(…names) → {Component|undefined}

返回遵循给定后代 names 的后代 Component。例如,['foo', 'bar', 'baz'] 将尝试在当前组件上获取 'foo',在 'foo' 组件上获取 'bar',在 'bar' 组件上获取 'baz',如果其中任何一个不存在,则返回 undefined。

参数
名称类型属性描述
名称...Array.<string> | string<可重复>

要获取的子Component的名称。

返回

遵循给定后代names的后代Component或undefined。

类型: 
Component | undefined

getIsAvailableToBeFocused(el) → {boolean}

确定此组件是否当前可见/启用/等...

参数
名称类型描述
元素HTMLElement

代表组件的HTML元素。

返回

如果组件当前可见且启用,则为true。否则,为false

类型: 
布尔值

getIsFocusable(el) → {boolean}

确定此组件是否可被视为可聚焦组件。

参数
名称类型描述
元素HTMLElement

代表组件的HTML元素。

返回

如果组件可以被聚焦,则为true。否则,为false

类型: 
布尔值

getPositions() → {Object}

检索组件元素的位置和大小信息。

返回

一个包含 boundingClientRectcenter 属性的对象。 - boundingClientRect:一个包含 xywidthheighttoprightbottomleft 属性的对象,表示元素的边界矩形。 - center:一个包含 xy 属性的对象,表示元素的中心点。widthheight 设置为 0。

类型: 
Object

(abstract) getVideoPlaybackQuality() → {Object}

获取 W3C 媒体播放质量 API 指定的可用媒体播放质量指标。

参见
返回

一个包含支持的媒体播放质量指标的对象

类型: 
Object

handleKeyDown(event)

当此Component接收到一个它不处理的keydown事件时,它会将该事件传递给Player进行处理。

参数
名称类型描述
eventKeyboardEvent

导致此函数被调用的keydown事件。

handleKeyPress(event)

许多组件曾经有一个 handleKeyPress 方法,由于它监听 keydown 事件,所以命名不当。此方法名现在委托给 handleKeyDown。这意味着任何调用 handleKeyPress 的人将不会看到他们的方法调用停止工作。

参数
名称类型描述
eventKeyboardEvent

导致此函数被调用的事件。

(抽象) handleLanguagechange()

处理组件中播放器的语言变化。应由子组件覆盖。

hasClass(classToCheck) → {boolean}

检查组件元素是否具有CSS类名。

参数
名称类型描述
classToCheckstring

要检查的CSS类名。

返回
  • 如果Component具有该类,则为True。- 如果Component不具有该类,则为False。
类型: 
布尔值

height(numopt, skipListenersopt) → {number|undefined}

根据CSS样式获取或设置组件的高度。有关更详细的信息,请参见Component#dimension

参数
名称类型属性描述
数字number | string<可选>

您要设置的高度,后缀为“%”、“px”或无。

跳过监听器布尔值<可选>

跳过componentresize事件触发器

返回

获取时的高度,如果没有高度则为零

类型: 
number | undefined

hide()

如果Component的元素当前正在显示,则通过向其添加“vjs-hidden”类名来隐藏它。

id() → {string}

获取此Component的ID

返回

Component的ID

类型: 
string

initChildren()

根据选项添加和初始化默认子Component

initTrackListeners()

开启 VideoTrackList、{AudioTrackList 和 TextTrackList 事件的监听器。

这会为 addtrackremovetrack 添加 EventTarget~EventListeners。

isDisposed() → {boolean}

确定此组件是否已销毁。

返回

如果组件已销毁,则为true。否则,为false

类型: 
布尔值

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

参数
名称类型属性描述
stringstring

要本地化的字符串和在语言文件中查找的键。

令牌Array.<string><可选>

如果当前项有令牌替换,请在此处提供令牌。

默认值string<可选>

默认为string。如果查找键需要单独,则可以作为令牌替换的默认值。

返回

本地化字符串,或者如果不存在本地化,则为英文字符串。

类型: 
string

manualProgressOff()

关闭在 Tech#manualProgressOn 中创建的 progress 事件的 polyfill。

manualProgressOn()

为不原生支持 progress 事件的浏览器提供 polyfill。

manualTimeUpdatesOff()

关闭在 Tech#manualTimeUpdatesOn 中创建的 timeupdate 事件的 polyfill。

manualTimeUpdatesOn()

为不原生支持 timeupdate 事件的浏览器提供 polyfill。

name() → {string}

获取Component的名称。该名称用于引用Component并在注册期间设置。

返回

Component的名称。

类型: 
string

onDurationChange(event)

通过调用 Tech#duration,在 durationchange 事件上更新我们的内部持续时间。

参数
名称类型描述
eventEvent

导致此运行的 durationchange 事件。

监听事件
  • Tech#event:durationchange

options(obj) → {Object}

使用新选项深度合并选项对象。

注意:当objoptions都包含其值为对象的属性时。这两个属性将使用module:obj.merge合并

参数
名称类型描述
对象Object

包含新选项的对象。

返回

this.options_obj合并后的新对象。

类型: 
Object

(abstract) overrideNativeAudioTracks(override)

尝试强制覆盖原生音轨。

参数
名称类型描述
override布尔值

如果设置为 true,原生音频将被覆盖,否则可能使用原生音频。

(abstract) overrideNativeVideoTracks(override)

尝试强制覆盖原生视频轨道。

参数
名称类型描述
override布尔值

如果设置为 true,原生视频将被覆盖,否则可能使用原生视频。

(abstract) play()

开始播放

参见

played() → {TimeRange}

返回当前源已播放的 TimeRange

注意:此实现不完整。它不跟踪已播放的 TimeRange。它只检查源是否已播放。

返回
  • 如果此视频已播放,则为单个时间范围 - 否则为空范围集。
类型: 
TimeRange

player() → {Player}

返回Component所附着的Player

返回

Component所附着的播放器。

类型: 
Player

(abstract) playsinline()

检查 'playsinline' 是否存在的方法

ready(fn)

将监听器绑定到组件的就绪状态。与事件监听器不同,如果就绪事件已经发生,它将立即触发函数。

参数
名称类型描述
fnReadyCallback

Component就绪时调用的函数。

remoteTextTrackEls() → {HtmlTrackElementList}

获取远程元素 HtmlTrackElementList

返回
类型: 
HtmlTrackElementList

remoteTextTracks() → {TextTrackList}

获取远程元素 TextTrackList

返回
类型: 
TextTrackList

removeAttribute(attribute)

Component的元素中移除属性。

参数
名称类型描述
属性string

要移除的属性名称。

参见

removeChild(component)

从此Component的子项列表中移除子Component。同时从此Component的元素中移除子Component的元素。

参数
名称类型描述
组件Component

要移除的子Component

removeClass(…classesToRemove)

Component的元素中移除CSS类名。

参数
名称类型属性描述
要移除的类string<可重复>

一个或多个要移除的CSS类名。

removeRemoteTextTrack(track)

从远程 TextTrackList 中移除一个远程文本轨道。

参数
名称类型描述
trackTextTrack

要从 TextTrackList 中移除的 TextTrack

requestAnimationFrame(fn) → {number}

将回调排队传递给requestAnimationFrame (rAF),但有一些额外的优点

参数
名称类型描述
fnComponent~GenericCallback

一个函数,它将绑定到此组件并在浏览器下一次重绘之前执行。

参见
返回

返回一个rAF ID,用于标识超时。它也可以在Component#cancelAnimationFrame中使用以取消动画帧回调。

类型: 
数字

requestNamedAnimationFrame(name, fn)

请求一个动画帧,但只排队一个命名动画帧。在前面的动画帧完成之前,永远不会添加另一个。

参数
名称类型描述
名称string

此requestAnimationFrame的名称

fnComponent~GenericCallback

一个函数,它将绑定到此组件并在浏览器下一次重绘之前执行。

(abstract) requestPictureInPicture() → {Promise|undefined}

尝试创建一个浮动视频窗口,该窗口始终位于其他窗口之上,以便用户在与设备上的其他内容站点或应用程序交互时,可以继续观看媒体。

参见
返回

如果浏览器支持 Promises(或者作为选项传入),则返回带有画中画窗口的 Promise。否则返回 undefined。

类型: 
Promise | undefined

requestVideoFrameCallback(cb) → {number}

使用 requestAnimationFrame 实现 requestVideoFrameCallback 的回退方案

参数
名称类型描述
cbfunction
返回

请求 ID

类型: 
数字

(abstract) reset()

重置 Tech,这将移除所有源并重置内部 readyState。

(abstract) scrubbing()

获取当前是否正在擦洗

setAttribute(attribute, value)

设置Component元素上的属性值

参数
名称类型描述
属性string

要设置的属性名称。

string

要将属性设置为的值。

参见

(abstract) setCrossOrigin(crossOrigin)

在 Tech 上设置 crossOrigin 的值。

参数
名称类型描述
crossOriginstring

crossOrigin 值

setCurrentTime(_seconds)

如果之前调用过 Tech#manualTimeUpdatesOn,则会触发手动时间更新。

参数
名称类型描述
_seconds数字

将媒体的当前时间设置为此值。

(abstract) setDisablePictureInPicture()

设置或取消设置 'disablePictureInPicture' 的方法

setIcon(iconName, elopt) → {Element}

向另一个元素或组件添加SVG图标元素。

参数
名称类型属性默认描述
图标名称string

图标的名称。所有图标名称的列表可以在“sandbox/svg-icons.html”中找到

元素元素<可选>
this.el()

要设置标题的元素。默认为当前组件的元素。

返回

新创建的图标元素。

类型: 
元素

setInterval(fn, interval) → {number}

创建一个每x毫秒运行一次的函数。此函数是window.setInterval的包装。但仍有一些原因选择使用此函数。

  1. Component#dispose被调用时,它通过Component#clearInterval被清除。
  2. 函数回调将是Component~GenericCallback
参数
名称类型描述
fnComponent~GenericCallback

x秒运行的函数。

间隔数字

x毫秒执行指定的函数。

参见
返回

返回一个可用于标识间隔的ID。它也可以在Component#clearInterval中使用以清除间隔。

类型: 
数字

(abstract) setPlaysinline()

设置或取消设置 'playsinline' 的方法

(abstract) setPoster()

Tech 设置海报的方法。

(abstract) setScrubbing(_isScrubbing)

设置是否正在擦洗

参数
名称类型描述
_isScrubbing布尔值
  • true 表示当前正在擦洗 - false 表示不再擦洗

setTimeout(fn, timeout) → {number}

创建一个在x毫秒超时后运行的函数。此函数是window.setTimeout的包装。但仍有一些原因选择使用此函数

  1. Component#dispose被调用时,它通过Component#clearTimeout被清除。
  2. 函数回调将被转换为Component~GenericCallback

注意:您不能对此函数返回的 ID 使用 window.clearTimeout。这将导致其 dispose 监听器无法被清理!请改用 Component#clearTimeoutComponent#dispose

参数
名称类型描述
fnComponent~GenericCallback

将在timeout后运行的函数。

超时数字

在执行指定函数之前延迟的毫秒数。

参见
返回

返回一个超时ID,用于标识超时。它也可以在Component#clearTimeout中使用以清除已设置的超时。

类型: 
数字

show()

如果Component的元素被隐藏,则通过从其移除“vjs-hidden”类名来显示它。

stopTrackingCurrentTime()

停止在 Tech#trackCurrentTime 中创建的间隔函数,以便不再触发 timeupdate 事件。

监听事件
  • {Tech#event:pause}

stopTrackingProgress()

关闭在 Tech#manualProgressOn 中创建的 progress 事件的 polyfill。通过清除在 Tech#trackProgress 中设置的间隔来停止手动跟踪进度事件。

textTracks() → {TextTrackList}

返回
类型: 
TextTrackList

toggleClass(classToToggle, predicateopt)

向组件的元素添加或移除CSS类名。

参数
名称类型属性描述
classToTogglestring

要添加或移除的类。传递给DOMTokenList的toggle()

谓词boolean | Dom.PredicateCallback<可选>

一个布尔值或返回布尔值的函数。传递给DOMTokenList的toggle()。

trackCurrentTime()

设置一个间隔函数,每 250 毫秒跟踪当前时间并触发 timeupdate 事件。

监听事件
  • Tech#event:play

trackProgress(event)

当缓冲百分比变化时,此函数用于触发 progress 事件。它设置了一个间隔函数,每 500 毫秒调用一次,以检查缓冲结束百分比是否已更改。

此函数由 Tech#manualProgressOn 调用。

参数
名称类型描述
eventEvent

导致此运行的 ready 事件。

监听事件

triggerReady()

触发此Component的所有就绪监听器。

triggerSourceset(src)

一个特殊函数,以允许播放器在播放器或 Tech 尚未准备好时重新触发的方式触发源设置。

参数
名称类型描述
srcstring

源更改时的源字符串。

videoTracks() → {VideoTrackList}

返回
类型: 
VideoTrackList

width(numopt, skipListenersopt) → {number|undefined}

根据CSS样式获取或设置组件的宽度。有关更详细的信息,请参见Component#dimension

参数
名称类型属性描述
数字number | string<可选>

您要设置的宽度,后缀为“%”、“px”或无。

跳过监听器布尔值<可选>

跳过componentresize事件触发器

返回

获取时的宽度,如果没有宽度则为零

类型: 
number | undefined

(static) canPlaySource(srcObj, options) → {string}

检查 Tech 是否支持给定源

参数
名称类型描述
源对象Object

源对象

选项Object

传递给 Tech 的选项

返回

'probably'、'maybe' 或 ''(空字符串)

类型: 
string

(static) canPlayType(_type) → {string}

检查此 Tech 是否支持该类型。

基本 Tech 不支持任何类型,但源处理程序可能会覆盖此功能。

参数
名称类型描述
_typestring

要检查的媒体类型

返回

返回原生视频元素的响应

类型: 
string

(static) getTech(name) → {Tech|undefined}

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

参数
名称类型描述
名称string

要获取的 Tech 的 camelCaseTitleCase 名称

返回

Tech 或 undefined(如果不存在请求名称的 Tech)。

类型: 
Tech | undefined

(static) registerTech(name, tech)

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

参数
名称类型描述
名称string

要注册的 Tech 的名称。

techObject

要注册的 Tech 类。

(static) withSourceHandlers(_Tech)

一个功能混合器,适用于想要使用源处理程序模式的 Tech。源处理程序是用于处理特定格式的脚本。源处理程序模式用于自适应格式(HLS、DASH),它们手动加载视频数据并将其馈送到源缓冲区(媒体源扩展)。示例:Tech.withSourceHandlers.call(MyTech);

参数
名称类型描述
_TechTech

要添加源处理程序函数的 Tech。

混合特性
  • Tech~SourceHandlerAdditions

事件

audiotrackchange

当 Tech 的 AudioTrackList 中添加或移除轨道时触发

类型

componentresize

当组件大小调整时触发。

类型

dispose

Component被销毁时触发。

类型
属性
名称类型属性默认描述
冒泡布尔值<可选>

设置为false,以便销毁事件不冒泡

此事件的监听器

progress

参见 Player#progress

类型

ready

Component就绪时触发。

类型

sourceset

当在 Tech 上设置源导致媒体元素重新加载时触发。

类型

tap

Component被轻触时触发。

类型
  • MouseEvent

texttrackchange

当 Tech 的 TextTrackList 中添加或移除轨道时触发

类型

timeupdate

触发 timeupdate,因为我们已完成寻道并且时间已更改。这对于播放器暂停以计时显示时间特别有用。

类型

timeupdate

以 250 毫秒的间隔触发,表示视频时间正在流逝。

类型

timeupdate

一个手动的 timeupdate 事件。

类型

videotrackchange

当 Tech 的 VideoTrackList 中添加或移除轨道时触发

类型

vttjsloaded

当 vtt.js 加载完成时触发。

类型

vttjsloaded

因错误导致 vtt.js 未加载时触发

类型