---
title: TextTrack
slug: Web/API/TextTrack
tags:
  - API
  - Interface
  - Media
  - Reference
  - TextTrack
  - TopicStub
  - Web
  - WebVTT
  - インターフェイス
translation_of: Web/API/TextTrack
---
<div>{{APIRef("WebVTT")}}</div>

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

<h2 id="Properties" name="Properties">プロパティ</h2>

<p class="properties also_inherits"><em>このインターフェイスは {{domxref("EventTarget")}} からプロパティを継承しています。</em></p>

<dl id="property_definitions">
 <dt>{{domxref("TextTrack.activeCues")}} {{readonlyInline}}</dt>
 <dd>現在アクティブなテキストトラックキューのセットをリストする {{domxref("TextTrackCueList")}} オブジェクト。メディアの現在の再生位置がキューの開始時間と終了時間の間にある場合、トラックキューはアクティブです。つまり、キャプションや字幕のような表示されるキューでは、アクティブキューが現在表示されているものです。</dd>
 <dt>{{domxref("TextTrack.cues")}} {{readonlyInline}}</dt>
 <dd>トラックのすべてのキューを含む {{domxref("TextTrackCueList")}}。</dd>
 <dt>{{domxref("TextTrack.id")}} {{readonlyInline}}</dt>
 <dd>トラックがある場合は、それを識別する {{domxref("DOMString")}}。 ID がない場合、この値は空の文字列 (<code>""</code>) です。 <code>TextTrack</code> が {{HTMLElement("track")}} 要素に関連付けられている場合、トラックの ID は要素の ID と一致します。</dd>
 <dt>{{domxref("TextTrack.inBandMetadataTrackDispatchType")}} {{readonlyInline}}</dt>
 <dd>トラックのインバンドメタデータトラックディスパッチタイプ（in-band metadata track dispatch type）を示す {{domxref("DOMString")}} を返します。 <em><strong>詳細が必要</strong></em></dd>
 <dt>{{domxref("TextTrack.kind")}} {{readonlyInline}}</dt>
 <dd><code>TextTrack</code> が記述するテキストトラックの kind を示す {{domxref("DOMString")}} を返します。 値は <code>TextTrackKind</code> 列挙型のいずれかでなければなりません。</dd>
 <dt>{{domxref("TextTrack.label")}} {{readonlyInline}}</dt>
 <dd>テキストトラックのラベルがあれば、それを含む人間が読める {{domxref("DOMString")}}。 それ以外の場合、これは空の文字列（<code>""</code>）になります。 空の文字列の場合、トラックのラベルをユーザーに公開する必要がある場合は、トラックの他の属性を使用してコードでカスタムラベルを生成する必要があります。</dd>
 <dt>{{domxref("TextTrack.language")}} {{readonlyInline}}</dt>
 <dd>テキストトラックの内容が書かれているテキスト言語を指定する {{domxref("DOMString")}}。 値は、HTML の lang 属性と同じように、IETF の<a href="https://tools.ietf.org/html/bcp47">言語を識別するためのタグ</a>（<a href="https://tools.ietf.org/html/bcp47">BCP 47</a>）文書で指定されている形式に準拠する必要があります。 例えば、米国英語の場合は <code>"en-US"</code>、ブラジルポルトガル語の場合は <code>"pt-BR"</code> になります。</dd>
 <dt>{{domxref("TextTrack.mode")}}</dt>
 <dd>トラックの現在のモードを指定する {{domxref("DOMString")}}。 このプロパティの値を変更すると、トラックの現在のモードが一致するように変更されます。 許容値は<a href="/ja/docs/Web/API/TextTrack/mode#Text_track_mode_constants">テキストトラックモード定数</a>にリストされています。既定値は <code>disabled</code> ですが、 {{HTMLElement("track")}} 要素の {{htmlattrxref("default", "track")}} 論理属性が指定されていた場合は、既定のモードは <code>started</code> になります。</dd>
</dl>

<h2 id="Events" name="Events">イベント</h2>

<dl id="event_handler_property_definitions">
 <dt>{{domxref("TextTrack.cuechange_event","cuechange")}}</dt>
 <dd>キューが出入りしたときに発生します。 特定のテキストキューは、キューに入ると表示され、キューから出ると消えます。<br>
 {{domxref("TextTrack.oncuechange","oncuechange")}} プロパティからも利用できます。</dd>
</dl>

<h2 id="methods" name="methods">メソッド</h2>

<p class="methods also_inherits"><em>このインターフェイスは {{domxref("EventTarget")}} からもメソッドを継承しています。</em></p>

<dl id="method_definitions">
 <dt>{{domxref("TextTrack.addCue()")}}</dt>
 <dd>({{domxref("TextTrackCue")}} オブジェクトとして指定された) キューをトラックのキューのリストに追加します。</dd>
 <dt>{{domxref("TextTrack.removeCue()")}}</dt>
 <dd>トラックのキューのリストから ({{domxref("TextTrackCue")}} オブジェクトとして指定された) キューを取り除きます。</dd>
</dl>

<dl id="method_definitions_obsolete">
</dl>

<h2 id="Example" name="Example">例</h2>

<p>作成中</p>

<h2 id="Specifications" name="Specifications">仕様書</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">仕様書</th>
   <th scope="col">状態</th>
   <th scope="col">備考</th>
  </tr>
  <tr>
   <td>{{ SpecName('HTML WHATWG', '#texttrack', 'TextTrack') }}</td>
   <td>{{ Spec2('HTML WHATWG') }}</td>
   <td></td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>

<p>{{Compat("api.TextTrack")}}</p>

<h2 id="See_also" name="See_also">関連情報</h2>

<ul>
 <li><a href="/ja/docs/Web/API/WebVTT_API">WebVTT</a></li>
 <li>{{domxref("TextTrackCueList")}}</li>
 <li>{{domxref("VTTCue")}}</li>
 <li>{{HTMLElement("track")}}</li>
 <li>{{domxref("HTMLTrackElement")}}</li>
</ul>