HTMLMediaElement: addTextTrack() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

addTextTrack() は HTMLMediaElement インターフェイスのメソッドで、新しい TextTrack オブジェクトを作成し、それをこのメディア要素に追加します。このメソッドは、 addtrack イベントをこのメディア要素の textTracks で発行します。このメソッドは、 TextTrackList インターフェイスでは使用できません。 HTMLMediaElement でのみ使用できます。

構文

js
addTextTrack(kind)
addTextTrack(kind, label)
addTextTrack(kind, label, language)

引数

kind

文字列で、 TextTrack.kind プロパティ (subtitles, captions, descriptions, chapters, metadata) を表します。

label

文字列で、 TextTrack.label プロパティを表します。

language

文字列で、 TextTrack.language プロパティを表します。

返値

新しく作成された TextTrack オブジェクトです。

例外

なし。

例

この例では、新しい TextTrack を、 kind を "subtitles" に設定して追加し、それに新しい VTTCue を追加しています。

js
const video = document.querySelector("video");
const newTrack = video.addTextTrack("subtitles");
newTrack.addCue(new VTTCue(3, 6, "Hello world!"));
console.log(newTrack.cues[0].text);
// "Hello world!"

仕様書

Specification
HTML
# dom-media-addtexttrack-dev

ブラウザーの互換性

関連情報