TextTrackList

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.

Die TextTrackList Schnittstelle wird verwendet, um eine Liste der für das zugehörige <video>- oder <audio>-Element definierten Textspuren darzustellen, wobei jede Spur durch ein separates textTrack-Objekt in der Liste repräsentiert wird.

Textspuren können einem Medienelement deklarativ mithilfe des <track>-Elements oder programmgesteuert mithilfe der Methode HTMLMediaElement.addTextTrack() hinzugefügt werden.

Eine Instanz dieses Objekts kann über die textTracks-Eigenschaft eines HTMLMediaElement-Objekts abgerufen werden.

Für ein gegebenes HTMLMediaElement-Objekt media können die einzelnen Spuren wie folgt abgerufen werden:

media.TextTracks[n], um die n-te Textspur aus der Liste der Textspuren des Objekts zu erhalten
die Methode media.textTracks.getTrackById()

Instanz-Eigenschaften

Diese Schnittstelle erbt auch Eigenschaften ihrer übergeordneten Schnittstelle, EventTarget.

length Schreibgeschützt: Die Anzahl der Spuren in der Liste.

Instanz-Methoden

Diese Schnittstelle erbt auch Methoden ihrer übergeordneten Schnittstelle, EventTarget.

getTrackById(): Gibt die innerhalb der TextTrackList gefundene TextTrack zurück, deren id mit dem angegebenen String übereinstimmt. Wenn keine Übereinstimmung gefunden wird, wird null zurückgegeben.

Ereignisse

addtrack: Wird ausgelöst, wenn eine neue Textspur zum Medienelement hinzugefügt wurde. Auch über die onaddtrack-Eigenschaft verfügbar.
change: Wird ausgelöst, wenn eine Textspur aktiv oder inaktiv gemacht wird. Auch über die onchange-Eigenschaft verfügbar.
removetrack: Wird ausgelöst, wenn eine neue Textspur aus dem Medienelement entfernt wurde. Auch über die onremovetrack-Eigenschaft verfügbar.

Anwendungshinweise

Zusätzlich zur Möglichkeit, direkten Zugriff auf die auf einem Medienelement vorhandenen Textspuren zu erhalten, ermöglicht TextTrackList das Setzen von Ereignishandlern für die Ereignisse addtrack und removetrack, sodass Sie erkennen können, wenn Spuren zum oder vom Stream des Medienelements hinzugefügt oder entfernt werden.

Beispiele

Abrufen der Textspurenliste eines Videoelements

Um die TextTrackList eines Medienelements zu erhalten, verwenden Sie die textTracks-Eigenschaft.

const textTracks = document.querySelector("video").textTracks;

Überwachung von Spurenzahlenänderungen

In diesem Beispiel haben wir eine App, die Informationen über die Anzahl der verfügbaren Kanäle anzeigt. Um sie auf dem neuesten Stand zu halten, werden Handler für die Ereignisse addtrack und removetrack eingerichtet.

textTracks.onaddtrack = updateTrackCount;
textTracks.onremovetrack = updateTrackCount;

function updateTrackCount(event) {
  trackCount = textTracks.length;
  drawTrackCountIndicator(trackCount);
}

Spezifikationen

Specification
HTML Standard # text-track-api

Browser-Kompatibilität

BCD tables only load in the browser