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: The Web Video Text Tracks Format
mode の定義
勧告候補 初期定義

ブラウザーの互換性

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewAndroid 版 ChromeAndroid 版 FirefoxAndroid 版 OperaiOSのSafariSamsung Internet
modeChrome 完全対応 18Edge 完全対応 12Firefox 完全対応 31
補足
完全対応 31
補足
補足 Before Firefox 52, using JavaScript to change the mode of a text track that's part of a media element would send one change event to the element's textTracks TextTrackList for each change, even if mutliple changes are made in a single pass through the Firefox event loop. Starting in Firefox 52, these changes are reflected by a single event.
IE 完全対応 10Opera 完全対応 15Safari 完全対応 6WebView Android 完全対応 4.4Chrome Android 完全対応 18Firefox Android 完全対応 31Opera Android 未対応 なしSafari iOS 完全対応 7.1Samsung Internet Android 完全対応 あり

凡例

完全対応  
完全対応
未対応  
未対応
実装ノートを参照してください。
実装ノートを参照してください。

 

関連情報