在本页

文本轨道

单个 TextTrack 的表示。

构造函数

new TextTrack(options)

创建此类的实例。

参数

名称类型默认描述

选项

对象

{}

选项名称和值的对象

属性

名称	类型	属性	默认	描述
`技术`	技术			对拥有此 TextTrack 的技术的引用。
`类型`	文本轨道类型	<可选>	'subtitles'	有效的文本轨道类型。
`模式`	文本轨道模式	<可选>	'disabled'	有效的文本轨道模式。
`ID`	字符串	<可选>	'vjs_track_' + Guid.newGUID()	此文本轨道的唯一ID。
`标签`	字符串	<可选>	''	此轨道的菜单标签。
`语言`	字符串	<可选>	''	有效的两位字符语言代码。
`源语言`	字符串	<可选>	''	有效的双字符语言代码。是`options.language`的替代版本，但优先级较低。
`源`	字符串	<可选>		文本轨道提示的URL。
`默认`	布尔值	<可选>		此轨道是否应默认为开启或关闭。

源: tracks/text-track.js, 第 126 行
参见: 规范

继承

轨道

成员

activeCues :TextTrackCueList

此 TextTrack 当前活动的文本轨道提示列表。

类型

文本轨道提示列表

源: tracks/text-track.js, 第 307 行

(受保护) allowedEvents_

cuechange - 轨道中的一个或多个提示已变为活动状态或停止活动。

覆盖: Track#allowedEvents_
源: tracks/text-track.js, 第 460 行

cues :TextTrackCueList

此 TextTrack 的文本轨道提示列表。

类型

文本轨道提示列表

源: tracks/text-track.js, 第 290 行

(只读) default :boolean

如果此轨道默认设置为开启或关闭。创建后无法更改。

类型

布尔值

源: tracks/text-track.js, 第 229 行

(只读) id :字符串

此轨道的ID。创建后无法更改。

类型

字符串

覆盖: Track#id
源: tracks/track.js, 第50行

(只读) kind :字符串

此轨道的类型。创建后无法更改。

类型

字符串

覆盖: Track#kind
源: tracks/track.js, 第59行

label :字符串

此轨道的标签。创建后无法更改。

类型

字符串

覆盖: Track#label
源: tracks/track.js, 第87行

触发

Track#event:labelchange

(只读) language :字符串

此轨道的两位字母语言代码。创建后无法更改。

类型

字符串

覆盖: Track#language
源: tracks/track.js, 第68行

mode :string

将此 TextTrack 的模式设置为有效的 TextTrack~Mode。如果设置为无效模式，则不会设置。

类型

字符串

源: tracks/text-track.js, 第 245 行

触发

TextTrack#event:modechange

方法

addCue(cue)

将提示添加到内部提示列表中。

参数

名称	类型	描述
`提示`	TextTrack~Cue	要添加到内部列表的提示

源: tracks/text-track.js, 第 394 行

addEventListener()

EventTarget#on 的别名。允许 EventTarget 模拟标准 DOM API。

覆盖: Track#addEventListener
源: event-target.js, 第199行
参见: EventTarget#on

any(type, fn)

此函数将添加一个 事件监听器，该监听器只触发一次，然后从所有事件中移除。这类似于使用 EventTarget#on 添加一个 事件监听器 数组，当它首次触发时，会在所有事件上调用 EventTarget#off。

参数

名称	类型	描述
`类型`	字符串 \| Array.<字符串>	一个事件名称或事件名称数组。
`函数`	函数	为每个事件名称调用一次的函数。

覆盖: Track#any
源: event-target.js, 第83行

dispatchEvent()

EventTarget#trigger 的别名。允许 EventTarget 模拟标准 DOM API。

覆盖: Track#dispatchEvent
源: event-target.js, 第217行
参见: EventTarget#trigger

off(type, fn)

从EventTarget实例中移除特定事件的事件监听器。这使得当指定事件发生时，事件监听器将不再被调用。

参数

名称	类型	描述
`类型`	字符串 \| Array.<字符串>	一个事件名称或事件名称数组。
`函数`	函数	要移除的函数。

覆盖: Track#off
源: event-target.js, 第48行

on(type, fn)

向EventTarget实例添加一个事件监听器。事件监听器是一个函数，当某个名称的事件被触发时，该函数将被调用。

参数

名称	类型	描述
`类型`	字符串 \| Array.<字符串>	一个事件名称或事件名称数组。
`函数`	函数	使用`EventTarget`s调用的函数。

覆盖: Track#on
源: event-target.js, 第28行

one(type, fn)

此函数将添加一个 事件监听器，该监听器只触发一次。首次触发后，它将被移除。这类似于使用 EventTarget#on 添加一个 事件监听器，该监听器会在自身上调用 EventTarget#off。

参数

名称	类型	描述
`类型`	字符串 \| Array.<字符串>	一个事件名称或事件名称数组。
`函数`	函数	为每个事件名称调用一次的函数。

覆盖: Track#one
源: event-target.js, 第62行

removeCue(removeCue)

从内部列表中移除提示

参数

名称	类型	描述
`要移除的提示`	TextTrack~Cue	要从内部列表中移除的提示

源: tracks/text-track.js, 第 440 行

removeEventListener()

EventTarget#off 的别名。允许 EventTarget 模拟标准 DOM API。

覆盖: Track#removeEventListener
源: event-target.js, 第208行
参见: EventTarget#off

toJSON() → {Object}

创建文本轨道的副本，并通过移除循环依赖使其可序列化。

源: tracks/text-track.js, 第 430 行

返回

可序列化的轨道信息对象

类型：: 对象

trigger(event)

此函数会触发一个事件的发生。这将导致所有等待该事件的事件监听器被调用。如果事件没有事件监听器，则什么都不会发生。

如果正在触发的事件名称在EventTarget.allowedEvents_中，Trigger 还会调用 on + uppercaseEventName 函数。

示例：'click' 在EventTarget.allowedEvents_中，因此，如果存在，Trigger 将尝试调用 onClick。

参数

名称	类型	描述
`事件`	字符串 \| EventTarget~事件 \| 对象	事件的名称，一个`Event`对象，或一个其类型键设置为事件名称的对象。

覆盖: Track#trigger
源: event-target.js, 第108行

类型定义

类型

所有可能的 TextTrackKind

源: tracks/track-enums.js, 第 37 行
参见: https://html.whatwg.com.cn/multipage/embedded-content.html#dom-texttrack-kind

模式

所有可能的 TextTrackMode

源: tracks/track-enums.js, 第 52 行
参见: https://html.whatwg.com.cn/multipage/embedded-content.html#texttrackmode

事件

标签改变

当此轨道上的label属性更改时触发的事件。

注意：这不是规范的一部分！

类型

事件

覆盖: Track#event:labelchange
源: tracks/track.js, 第103行

模式改变

当此轨道的模式更改时触发的事件。这使得包含此轨道的 TextTrackList 能够相应地采取行动。

注意：这不是规范的一部分！

类型

事件

源: tracks/text-track.js, 第 276 行