TextTrack

La interfaz TextTrack, parte de la API para manejar WebVTT (pistas de texto en presentaciones multimedia), describe y controla la pista de texto asociada con un elemento <track> en particular.

EventTarget TextTrack

Propiedades de instancia

Esta interfaz también hereda propiedades de EventTarget.

TextTrack.activeCues (en-US) Read only

Un objeto TextTrackCueList (en-US) que enumera el conjunto de pistas de texto activas actualmente. Las señales de pista están activas si la posición de reproducción actual de los medios se encuentra entre las horas de inicio y finalización de las señales. Por lo tanto, para las señales mostradas, como leyendas o subtítulos, las señales activas se muestran actualmente.

TextTrack.cues (en-US) Read only

Un TextTrackCueList (en-US) que contiene todas las señales de la pista.

TextTrack.id (en-US) Read only

Una cadena que identifica la pista, si la tiene. Si no tiene un ID, entonces este valor es una cadena vacía (""). Si TextTrack está asociado con un elemento <track>, entonces el ID de la pista coincide con el ID del elemento.

TextTrack.inBandMetadataTrackDispatchType (en-US) Read only

Devuelve una cadena que indica el tipo de envío de la pista de metadatos en banda de la pista.

TextTrack.kind (en-US) Read only

Devuelve una cadena que indica qué tipo de pista de texto describe TextTrack. Debe ser uno de los valores permitidos.

TextTrack.label (en-US) Read only

Una cadena legible por humanos que contiene la etiqueta de la pista de texto, si está presente; de lo contrario, se trata de una cadena vacía (""), en cuyo caso es posible que su código deba generar una etiqueta personalizada utilizando otros atributos de la pista, si la etiqueta de la pista debe exponerse al usuario.

TextTrack.language (en-US) Read only

Una cadena que especifica el idioma del texto en el que se escribe el contenido de la pista de texto. El valor debe cumplir con el formato especificado en RFC 5646: Etiquetas para identificar idiomas (también conocido como BCP 47), al igual que el atributo HTML lang. Por ejemplo, puede ser "en-US" para inglés de Estados Unidos o "pt-BR" para portugués de Brasil.

TextTrack.mode (en-US)

Una cadena que especifica el modo actual de la pista, que debe ser uno de los valores permitidos. Cambiar el valor de esta propiedad cambia el modo actual de la pista para que coincida. El valor predeterminado es disabled, a menos que el atributo booleano default del elemento <track> esté establecido en true, en cuyo caso el modo predeterminado es showing.

Métodos de instancia

Esta interfaz también hereda métodos de EventTarget.

Nota: La interfaz TextTrackCue (en-US) es una clase abstracta que se utiliza como padre para otras interfaces de señales como VTTCue (en-US). Por lo tanto, al agregar o eliminar una señal, estará pasando uno de los tipos de señales que heredan de TextTrackCue.

TextTrack.addCue() (en-US)

Agrega una señal (especificada como un objeto TextTrackCue (en-US)) a la lista de señales de la pista.

TextTrack.removeCue() (en-US)

Elimina una señal (especificada como un objeto TextTrackCue (en-US)) de la lista de señales de la pista.

Eventos

cuechange

Se activa cuando se ingresan y se salen de las señales. Una señal de texto dada aparece cuando se ingresa la señal y desaparece cuando se sale de la señal. También disponible a través de la propiedad oncuechange.

Ejemplo

El siguiente ejemplo agrega un nuevo TextTrack a un video, luego lo configura para que se muestre usando TextTrack.mode (en-US).

js

let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";

Especificaciones

Specification
HTML Standard
# texttrack

Compatibilidad con navegadores

BCD tables only load in the browser

Véase también