TextTrack
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since Juli 2015.
* Some parts of this feature may have varying levels of support.
Das TextTrack
-Interface der WebVTT API repräsentiert eine Textspur, die mit einem Medienelement verknüpft ist.
Ein Objekt dieses Typs besitzt die Liste von VTTCue
-Objekten, die zu verschiedenen Zeitpunkten über dem Video angezeigt werden.
TextTrack
-Objekte können einem HTMLVideoElement
oder HTMLAudioElement
-Element hinzugefügt werden, indem die Methode HTMLMediaElement.addTextTrack()
verwendet wird. Dies hat den gleichen Effekt wie das deklarative Hinzufügen von Textspuren mit <track>
-Elementen innerhalb eines <video>
- oder <audio>
-Elements. Die TextTrack
-Objekte werden in einer TextTrackList
gespeichert, die über die Eigenschaft HTMLMediaElement.textTracks
abgerufen werden kann.
Instanz-Eigenschaften
Dieses Interface erbt auch Eigenschaften von EventTarget
.
TextTrack.activeCues
Schreibgeschützt-
Ein
TextTrackCueList
-Objekt, das die aktuell aktive Menge von Texttrack-Cues auflistet. Track-Cues sind aktiv, wenn die aktuelle Wiedergabeposition des Mediums zwischen den Start- und Endzeiten der Cues liegt. Für angezeigte Cues wie Untertitel oder Beschriftungen werden die aktiven Cues derzeit angezeigt. TextTrack.cues
Schreibgeschützt-
Eine
TextTrackCueList
, die alle Cues der Spur enthält. TextTrack.id
Schreibgeschützt-
Eine Zeichenkette, die die Spur identifiziert, falls sie eine hat. Falls sie keine ID hat, ist dieser Wert eine leere Zeichenkette (
""
). Wenn dasTextTrack
mit einem<track>
-Element verknüpft ist, entspricht die ID der Spur der ID des Elements. TextTrack.inBandMetadataTrackDispatchType
Schreibgeschützt-
Gibt eine Zeichenkette zurück, die den In-Band-Metadaten-Spurdaten-Typ der Spur anzeigt.
TextTrack.kind
Schreibgeschützt-
Gibt eine Zeichenkette zurück, die anzeigt, welche Art von Textspur das
TextTrack
beschreibt. Es muss einer der erlaubten Werte sein. TextTrack.label
Schreibgeschützt-
Eine menschenlesbare Zeichenkette, die das Label der Textspur enthält, falls vorhanden; andernfalls ist dies eine leere Zeichenkette (
""
). In diesem Fall muss möglicherweise ein benutzerdefiniertes Label von Ihrem Code generiert werden, indem andere Attribute der Spur verwendet werden, wenn das Label der Spur dem Benutzer angezeigt werden muss. TextTrack.language
Schreibgeschützt-
Eine Zeichenkette, die die Sprache spezifiziert, in der der Inhalt der Textspur geschrieben ist. Der Wert muss ein gültiger BCP 47-Sprachcode sein, zum Beispiel
"en-US"
für Englisch (USA) oder"pt-BR"
für brasilianisches Portugiesisch. TextTrack.mode
-
Eine Zeichenkette, die den aktuellen Modus der Spur angibt, der einer der erlaubten Werte sein muss. Durch Ändern des Wertes dieser Eigenschaft wird der aktuelle Modus der Spur entsprechend angepasst. Der Standard ist
disabled
, es sei denn, dasdefault
-Boolean-Attribut des<track>
-Elements ist auftrue
gesetzt — in diesem Fall ist der Standardmodusshowing
. sourceBuffer
Schreibgeschützt-
Der
SourceBuffer
, der die Spur erstellt hat. Gibtnull
zurück, wenn die Spur nicht von einemSourceBuffer
erstellt wurde oder wenn derSourceBuffer
aus demMediaSource.sourceBuffers
-Attribut seiner übergeordneten Medienquelle entfernt wurde.
Instanz-Methoden
Dieses Interface erbt auch Methoden von EventTarget
.
Hinweis: Das TextTrackCue
-Interface ist eine abstrakte Klasse, die als Elternteil für andere Cue-Interfaces wie VTTCue
verwendet wird. Beim Hinzufügen oder Entfernen eines Cues wird daher einer der Cue-Typen, die von TextTrackCue
erben, übergeben.
TextTrack.addCue()
-
Fügt der Liste der Cues der Spur einen Cue hinzu (spezifiziert als
TextTrackCue
-Objekt). TextTrack.removeCue()
-
Entfernt einen Cue (spezifiziert als
TextTrackCue
-Objekt) aus der Liste der Cues der Spur.
Ereignisse
cuechange
-
Wird ausgelöst, wenn Cues einen- und wieder austreten. Ein bestimmter Text-Cue erscheint, wenn der Cue eintritt, und verschwindet, wenn der Cue austritt. Auch verfügbar über die
oncuechange
-Eigenschaft.
Beispiel
Das folgende Beispiel fügt einem Video eine neue TextTrack
hinzu und stellt dann die Anzeige mit TextTrack.mode
ein.
let video = document.querySelector("video"); let track = video.addTextTrack("captions", "Captions", "en"); track.mode = "showing";
Spezifikationen
Specification |
---|
HTML> # texttrack> |
Browser-Kompatibilität
Loading…