DOM

インターフェイス

TextTrack インターフェイス

  編集:2022.04.01 by T.A.

MS

このインターフェイスは ― WebVTT(メディア表示上のテキスト トラック)を扱う API の一部ですが ― 特定の <track> 要素に関連付けられたテキスト トラックを記述および制御します。

プロパティ

このインターフェイスは EventTarget からプロパティを継承しています。

TextTrack.activeCues 読取専用
現在アクティブなテキストトラックキューのセットをリストする TextTrackCueList (en-US) オブジェクト。メディアの現在の再生位置がキューの開始時間と終了時間の間にある場合、トラック キューはアクティブです。つまり、キャプションや字幕のような表示されるキューでは、アクティブ キューが現在表示されているものです。
TextTrack.cues 読取専用
トラックのすべてのキューを含む TextTrackCueList
TextTrack.id 読取専用
トラックがある場合は、それを識別する DOMString。 ID がない場合、この値は空の文字列("")です。TextTrack が <track> 要素に関連付けられている場合、トラックの ID は要素の ID と一致します。
TextTrack.inBandMetadataTrackDispatchType 読取専用
トラックのインバンド メタデータ トラック ディスパッチ タイプ(in-band metadata track dispatch type)を示す DOMString を返します。詳細が必要
TextTrack.kind 読取専用
TextTrack が記述するテキスト トラックの kind を示す DOMString を返します。値は TextTrackKind 列挙型のいずれかでなければなりません。
TextTrack.label 読取専用
テキスト トラックのラベルがあれば、それを含む人間が読める DOMString。それ以外の場合、これは空の文字列("")になります。空の文字列の場合、トラックのラベルをユーザーに公開する必要がある場合は、トラックの他の属性を使用してコードでカスタム ラベルを生成する必要があります。
TextTrack.language 読取専用
テキスト トラックの内容が書かれているテキスト言語を指定する DOMString。値は、HTML の lang 属性と同じように、IETF の言語を識別するためのタグ(BCP 47)文書で指定されている形式に準拠する必要があります。例えば、米国英語の場合は "en-US"、ブラジル ポルトガル語の場合は "pt-BR" になります。
TextTrack.mode
トラックの現在のモードを指定する DOMString。このプロパティの値を変更すると、トラックの現在のモードが一致するように変更されます。許容値はテキスト トラック モード定数にリストされています。既定値は disabled ですが、<track> 要素の default 論理属性が指定されていた場合は、既定のモードは started になります。
メソッド

このインターフェイスは EventTarget からもメソッドを継承しています。

TextTrack.addCue()
TextTrackCue オブジェクトとして指定された)キューをトラックのキューのリストに追加します。
TextTrack.removeCue()
トラックのキューのリストから(TextTrackCue オブジェクトとして指定された)キューを取り除きます。
イベント
cuechange
キューが出入りしたときに発生します。 特定のテキスト キューは、キューに入ると表示され、キューから出ると消えます。

oncuechange プロパティからも利用できます。


テスト
HTML:

ここに表示
スクリプト組み込み:



スクリプト:


スクリプト:



表示内容:
表示内容: