類別:TextTracksManager

方法

addTracks

addTracks(tracks)

將文字軌加入清單。

參數

歷程

非空值 cast.framework.messages.Track 陣列

值不得為空值。

擲回

non-null Error如果沒有可用的音軌、軌跡 ID 並非專屬 ID,或新增非文字音軌,

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() 會傳回非空值的 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

號碼

擲回

non-null Error如果 ID 無法使用或無效,

傳回

nullable cast.framework.messages.Track 

getTracks

getTracks() 會傳回非空值的 cast.framework.messages.Track

傳回所有 (非強制) 文字軌。

傳回

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

getTracksByLanguage

getTracksByLanguage(language) 會傳回非空值的 cast.framework.messages.Track 陣列

取得不同語言的文字軌。

參數

language

字串

符合 RFC 5646 的語言標記。

擲回

non-null Error如果不支援語言。

傳回

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

setActiveByIds

setActiveByIds(newIds)

將文字軌設為透過 ID 啟用。

參數

newIds

數字陣列

要啟用的文字追蹤 ID。如要清除文字軌跡,請將值設為空白陣列或 null

值可以是空值。

擲回

non-null Error 如果 ID 無效。

setActiveByLanguage

setActiveByLanguage(language)

將文字軌設為以語言顯示。系統只會啟用第一個相符的語言音軌。

參數

language

字串

符合 RFC 5646 的語言標記。

擲回

non-null Error如果系統未提供語言或語言無效。

setTextTrackStyle

setTextTrackStyle(style)

設定文字追蹤樣式。

參數

樣式

cast.framework.messages.TextTrackStyle

值不得為空值。