cast. framework. TextTracksManager
テキスト トラックを管理します。
- 例外
-
non-null Error
コンストラクタを直接使用する場合。 TextTracksManager には、cast.framework.PlayerManager#getTextTracksManager を呼び出してのみアクセスする必要があります。
Methods
トラック
addTracks(トラック)
リストにテキスト トラックを追加します。
パラメータ |
|
---|---|
トラック |
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
tracksManager を使用できない場合。 - 戻り値
-
non-null Array of number
getActiveTracks
getActiveTracks() は、null 以外の cast.framework.messages.Track の配列を返します
アクティブなテキスト トラックをすべて取得します。
- 例外
-
non-null Error
tracksManager を使用できない場合。 - 戻り値
-
non-null Array of non-null cast.framework.messages.Track
getTextTracksStyle
getTextTracksStyle() (cast.framework.messages.TextTrackStyle または 未定義)を返す
現在のテキスト トラック スタイルを返します。
- 戻り値
-
(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
getTrack
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(newIds)
ID でテキスト トラックをアクティブにします。
パラメータ |
|
---|---|
新しい ID |
数値の配列 有効にするテキスト トラック ID。テキスト トラックを消去するには、値を空の配列または 値を null にすることもできます。 |
- 例外
-
non-null Error
ID が無効な場合。
setActiveByLanguage
setActiveByLanguage(language)
テキスト トラックを有効にする言語を設定します。最初に一致した言語トラックのみが有効になります。
パラメータ |
|
---|---|
language |
string RFC 5646 に準拠した言語タグ。 |
- 例外
-
non-null Error
言語が利用できない場合や無効な場合。
setTextTrackStyle
setTextTrackStyle(style)
テキスト トラック スタイルを設定します。
パラメータ |
|
---|---|
スタイル |
cast.framework.messages.TextTrackStyle 値を null にすることはできません。 |