VTTCue
WebVTT(メディアプレゼンテーションに関するテキストトラック)を処理するための API の一部である
VTTCue
インターフェイスは、特定の <track>
要素に関連付けられたテキストトラックを記述および制御します。
コンストラクタ
VTTCue(startTime, endTime, text)
-
指定された時間範囲をカバーし、指定されたテキストを持つ、新しく作成された
VTTCue
オブジェクトを返します。
プロパティ
このインターフェイスは TextTrackCue
からもプロパティを継承しています。
VTTCue.region
(en-US)-
キューが描画される動画のサブ領域を説明する
VTTRegion
オブジェクト。 割り当てられていない場合はnull
。 VTTCue.vertical
(en-US)-
キューの書き込み方向を表す列挙型を返します。
VTTCue.snapToLines
(en-US)-
VTTCue.line
(en-US) 属性が整数の行数または動画サイズのパーセントである場合、true
を返します。 VTTCue.line
(en-US)-
キューの行位置を返します。 これは、文字列
auto
またはその解釈がVTTCue.snapToLines
(en-US) の値に依存する数値になります。 VTTCue.lineAlign
(en-US)-
VTTCue.line
(en-US) の配置を表す列挙型を返します。 VTTCue.position
(en-US)-
行内のキューのインデントを返します。 これは、文字列
auto
またはVTTCue.region
(en-US) のパーセントを表す数値、またはVTTCue.region
(en-US) がnull
の場合は動画サイズです。 VTTCue.positionAlign
(en-US)-
キューの配置を表す列挙型を返します。 これは
VTTCue.position
(en-US) が何に固定されているかを決定するために使用されます。 VTTCue.size
(en-US)-
キューのサイズを表す
double
型を動画サイズのパーセントで返します。 VTTCue.textAlign
-
キューボックス内のすべてのテキスト行の配置を表す列挙型を返します。
VTTCue.text
(en-US)-
キューの内容を含む
DOMString
を返します。
メソッド
VTTCue.getCueAsHTML
(en-US)-
キューのテキストを
DocumentFragment
として返します。
例
var cue = new VTTCue(2, 3, 'かっこいい文章を表示する');
var tracks = document.querySelector('video').textTracks;
tracks[0].addCue(cue);
新しいキューを作成したら、それを TextTrack
に追加する必要があります。 追加すると、このキューを 2 秒から 3 秒の間に描画し、「かっこいい文章を表示する
」というテキストを表示します。
仕様
Specification |
---|
WebVTT: The Web Video Text Tracks Format # the-vttcue-interface |
ブラウザーの互換性
BCD tables only load in the browser