类:TextTracksManager

方法

addTracks

addTracks(tracks)

将文本轨道添加到列表中。

参数

tracks

非 null cast.framework.messages.Track 数组

值不得为 null。

抛出

如果轨道不可用、trackId 不是唯一的或添加了非文本轨道,则抛出 non-null Error

createTrack

createTrack() 返回 cast.framework.messages.Track

创建文本轨道。

抛出

如果轨道管理器不可用,则抛出 non-null Error

返回

non-null cast.framework.messages.Track 

getActiveIds

getActiveIds() 返回 number 数组

获取所有活跃文本 ID。

返回

non-null Array of number 

getActiveTracks

getActiveTracks() 返回非 null cast.framework.messages.Track 数组

获取所有活跃文本轨道。

返回

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

抛出

如果 ID 不可用或无效,则抛出 non-null Error

返回

nullable cast.framework.messages.Track 

getTracks

getTracks() returns Array of non-null cast.framework.messages.Track

返回所有(非强制)文本轨道。

返回

non-null Array of non-null cast.framework.messages.Track 

getTracksByLanguage

getTracksByLanguage(language) returns Array of non-null cast.framework.messages.Track

按语言获取文本轨道。

参数

language

string

语言标记,如 RFC 5646 中所述。

抛出

如果语言不可用,则抛出 non-null Error

返回

non-null Array of non-null cast.framework.messages.Track 

setActiveByIds

setActiveByIds(newIds)

按 ID 将文本轨道设置为活跃状态。

参数

newIds

number 数组

要启用的文本轨道 ID。如需清除 文本轨道,请将值设置为空数组或 null

值可以为 null。

抛出

如果 ID 无效,则抛出 non-null Error

setActiveByLanguage

setActiveByLanguage(language)

按语言将文本轨道设置为活跃状态。系统只会启用第一个匹配的 语言轨道。

参数

language

string

语言标记,如 RFC 5646 中所述。

抛出

如果语言不可用或无效,则抛出 non-null Error

setTextTrackStyle

setTextTrackStyle(style)

设置文本轨道样式。

参数

style

cast.framework.messages.TextTrackStyle

值不得为 null。

抛出

如果轨道管理器不可用,则抛出 non-null Error