TextTrack

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

プロパティ

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

TextTrack.activeCues (en-US) 読取専用

現在アクティブなテキストトラックキューのセットをリストする TextTrackCueList (en-US) オブジェクト。メディアの現在の再生位置がキューの開始時間と終了時間の間にある場合、トラックキューはアクティブです。つまり、キャプションや字幕のような表示されるキューでは、アクティブキューが現在表示されているものです。

TextTrack.cues (en-US) 読取専用

トラックのすべてのキューを含む TextTrackCueList (en-US)

TextTrack.id (en-US) 読取専用

トラックがある場合は、それを識別する DOMString。 ID がない場合、この値は空の文字列 ("") です。 TextTrack<track> 要素に関連付けられている場合、トラックの ID は要素の ID と一致します。

TextTrack.inBandMetadataTrackDispatchType (en-US) 読取専用

トラックのインバンドメタデータトラックディスパッチタイプ(in-band metadata track dispatch type)を示す DOMString を返します。 詳細が必要

TextTrack.kind (en-US) 読取専用

TextTrack が記述するテキストトラックの kind を示す DOMString を返します。 値は TextTrackKind 列挙型のいずれかでなければなりません。

TextTrack.label (en-US) 読取専用

テキストトラックのラベルがあれば、それを含む人間が読める DOMString。 それ以外の場合、これは空の文字列("")になります。 空の文字列の場合、トラックのラベルをユーザーに公開する必要がある場合は、トラックの他の属性を使用してコードでカスタムラベルを生成する必要があります。

TextTrack.language (en-US) 読取専用

テキストトラックの内容が書かれているテキスト言語を指定する DOMString。 値は、HTML の lang 属性と同じように、IETF の言語を識別するためのタグBCP 47)文書で指定されている形式に準拠する必要があります。 例えば、米国英語の場合は "en-US"、ブラジルポルトガル語の場合は "pt-BR" になります。

TextTrack.mode

トラックの現在のモードを指定する DOMString。 このプロパティの値を変更すると、トラックの現在のモードが一致するように変更されます。 許容値はテキストトラックモード定数にリストされています。既定値は disabled ですが、 <track> 要素の default 論理属性が指定されていた場合は、既定のモードは started になります。

イベント

cuechange

キューが出入りしたときに発生します。 特定のテキストキューは、キューに入ると表示され、キューから出ると消えます。 oncuechange プロパティからも利用できます。

メソッド

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

TextTrack.addCue() (en-US)

(TextTrackCue オブジェクトとして指定された) キューをトラックのキューのリストに追加します。

TextTrack.removeCue() (en-US)

トラックのキューのリストから (TextTrackCue オブジェクトとして指定された) キューを取り除きます。

作成中

仕様書

仕様書 状態 備考
HTML Living Standard
TextTrack の定義
現行の標準

ブラウザーの互換性

BCD tables only load in the browser

関連情報