cast. framework。 TextTracksManager
管理文本轨道。
- 抛出
-
non-null Error
如果直接使用构造函数。 您只能通过调用 cast.framework.PlayerManager#getTextTracksManager 来访问 TextTracksManager。
方法
addTracks
addTracks(tracks)
向列表中添加文本轨道。
参数 |
|
---|---|
跟踪 |
非 null cast.framework.messages.Track 数组 值不能为 null。 |
- 抛出
-
non-null Error
如果轨道不可用,或 trackId 不是唯一的,或者添加非文本轨道。
createTrack
createTrack() 会返回 cast.framework.messages.Track
创建文本轨道。
- 返回
-
non-null cast.framework.messages.Track
getActiveIds
getActiveIds() 返回数字数组
获取所有有效文本 ID。
- 抛出
-
non-null Error
如果 trackManager 不可用, - 返回
-
non-null Array of number
getActiveTracks
getActiveTracks() 返回非 null cast.framework.messages.Track 的数组
获取所有有效的文本轨道。
- 抛出
-
non-null Error
如果 trackManager 不可用, - 返回
-
non-null Array of non-null cast.framework.messages.Track
getTextTracksStyle
getTextTracksStyle() returns (cast.framework.messages.TextTrackStyle or undefined)
返回当前文本轨道样式。
- 返回
-
(non-null cast.framework.messages.TextTrackStyle or undefined)
getTrackById
getTrackById(id) 会返回 cast.framework.messages.Track
按 ID 获取文本轨道。
参数 |
|
---|---|
id |
number |
- 抛出
-
non-null Error
:如果 ID 不可用或无效。 - 返回
-
nullable cast.framework.messages.Track
getTracks
getTracks() 返回非 null cast.framework.messages.Track 的数组
返回所有(非强制)文本轨道。
- 返回
-
non-null Array of non-null cast.framework.messages.Track
getTracksByLanguage
getTracksByLanguage(language) 返回非 null cast.framework.messages.Track 数组
按语言获取文本轨道。
参数 |
|
---|---|
language |
string 语言标记,符合 RFC 5646 标准。 |
- 抛出
-
non-null Error
如果语言不可用。 - 返回
-
non-null Array of non-null cast.framework.messages.Track
setActiveByIds
setActiveByIds(newId)
根据 ID 将文本轨道设置为活动状态。
参数 |
|
---|---|
newIds |
数字数组 要启用的文本轨道 ID。如需清除文本轨道,请将值设置为空数组或 值可能为 null。 |
- 抛出
-
non-null Error
:如果 ID 无效,
setActiveByLanguage
setActiveByLanguage(language)
根据语言将文本轨道设置为启用状态。系统只会启用第一个匹配的语言轨道。
参数 |
|
---|---|
language |
string 语言标记,符合 RFC 5646 标准。 |
- 抛出
-
non-null Error
如果语言不可用或无效。
setTextTrackStyle
setTextTrackStyle(style)
设置文本轨道样式。
参数 |
|
---|---|
样式 |
cast.framework.messages.TextTrackStyle 值不能为 null。 |