cast. framework. TextTracksManager
管理文字軌。
- 擲回
-
non-null Error如果直接使用建構函式。 您只能透過呼叫 cast.framework.PlayerManager#getTextTracksManager 存取 TextTracksManager。
方法
addTracks
addTracks(tracks)
將文字軌新增至清單。
參數 |
|
|---|---|
|
曲目 |
非空值的 cast.framework.messages.Track 陣列 值不得為空值。 |
- 擲回
-
non-null Error如果無法使用軌道、 trackId 不重複,或新增非文字軌道。
createTrack
createTrack() 會傳回 cast.framework.messages.Track
建立文字軌。
- 擲回
-
non-null Error如果無法使用曲目管理員。 - 傳回
-
non-null cast.framework.messages.Track
getActiveIds
getActiveIds() 會傳回數字陣列
取得所有有效的文字 ID。
- 傳回
-
non-null Array of number
getActiveTracks
getActiveTracks() 會傳回非空值的 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 |
數字 |
- 擲回
-
non-null Error如果 ID 無效或無法使用。 - 傳回
-
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 |
字串 語言標記 (如 RFC 5646 所述)。 |
- 擲回
-
non-null Error如果無法使用該語言。 - 傳回
-
non-null Array of non-null cast.framework.messages.Track
setActiveByIds
setActiveByIds(newIds)
依 ID 將文字軌設為有效。
參數 |
|
|---|---|
|
newIds |
數字陣列 要啟用的文字軌 ID。如要清除文字軌,請將值設為空陣列或 值可能為空值。 |
- 擲回
-
non-null Error如果 ID 無效。
setActiveByLanguage
setActiveByLanguage(language)
依語言設定要啟用的文字軌。系統只會啟用第一個相符的語言軌。
參數 |
|
|---|---|
|
language |
字串 語言標記 (如 RFC 5646 所述)。 |
- 擲回
-
non-null Error如果語言無效或無法使用。
setTextTrackStyle
setTextTrackStyle(style)
設定文字軌樣式。
參數 |
|
|---|---|
|
樣式 |
cast.framework.messages.TextTrackStyle 值不得為空值。 |
- 擲回
-
non-null Error如果無法使用曲目管理員。