TextTrack.mode

TextTrack.mode プロパティはテキストトラックのモードを示す文字列です。 この値を読んで現在のモードを判断し、この値を変更してモードを切り替えることができます。

構文

var mode = TextTrack.mode;

TextTrack.mode = "disabled" | "hidden" | "showing";

値

トラックの現在のモードを示す DOMString。 テキストトラックモードは、テキストトラックモード定数にリストされている値の1つです。

テキストトラックモード定数

テキストトラックモード（IDL 列挙型 TextTrackMode を使用して識別されることもあります）は、次のいずれかの値にする必要があります。

"disabled"

テキストトラックは現在無効になっています。 トラックの存在が DOM に公開されている間は、ユーザーエージェントはそれを無視しています。 アクティブなキューはなく、イベントは発生していません。 また、ユーザーエージェントはトラックのキューを取得しようとしません。

"hidden"

テキストトラックは現在アクティブですが、キューを表示しません。 ユーザーエージェントがまだトラックのキューを取得しようとしていない場合は、すぐに取得します（それにより、トラックの TextTrack.cues プロパティが設定されます）。 テキストが表示されていなくても、ユーザーエージェントはアクティブなキューのリストを（トラックの activeCues プロパティに）保持しており、イベントは対応する時間に発生します。

"showing"

テキストトラックは現在有効になっており、表示しています。 トラックのキューリストをまだ取得していない場合は、すぐに取得します。 activeCues リストは維持されており、イベントは適切なタイミングで発生します。 トラックのテキストも、スタイリングとトラックの kind に基づいて適切に描画します。

モードが "showing" の場合、テキストトラックはその kind によって異なる方法で実行されます。 一般に次のとおりです。

• kind が "subtitles"（字幕）または "captions"（キャプション）のトラックは、動画の上にキューを重ねてレンダリングされます。
• kind が "descriptions" （説明）であるトラックは、視覚的ではない形式で表示されます（例えば、動画においてテキストはアクションを声で説明することがあります）。
• kind が "chapters"（チャプター、章）のトラックは、ユーザーエージェントまたはウェブサイトまたはウェブアプリによって、名前付きチャプターをナビゲートするためのインターフェイスを構築して表示するために使用されます。 ここで、リスト内の各キューはメディア内のチャプターを表します。 その後、ユーザーは、キューの開始位置で開始し、キューの終了位置で終了する目的のチャプターに移動できます。

例

未定

仕様

ブラウザーの互換性

関連情報

• WebVTT
• TextTrack
• TextTrackList
• TextTrackCueList
• VTTCue
• <track>
• HTMLTrackElement