TextTrack
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.
io error: No such file or directory (os error 2) (/home/runner/work/yari/yari/mdn/translated-content/files/es/web/api/webvtt_api/index.md)
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.
Propiedades de instancia
Esta interfaz también hereda propiedades de EventTarget
.
TextTrack.activeCues
Read only-
Un objeto
TextTrackCueList
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
Read only-
Un
TextTrackCueList
que contiene todas las señales de la pista. TextTrack.id
Read only-
Una cadena que identifica la pista, si la tiene. Si no tiene un ID, entonces este valor es una cadena vacía (
""
). SiTextTrack
está asociado con un elemento<track>
, entonces el ID de la pista coincide con el ID del elemento. TextTrack.inBandMetadataTrackDispatchType
Read only-
Devuelve una cadena que indica el tipo de envío de la pista de metadatos en banda de la pista.
TextTrack.kind
Read only-
Devuelve una cadena que indica qué tipo de pista de texto describe
TextTrack
. Debe ser uno de los valores permitidos. TextTrack.label
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
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
-
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 booleanodefault
del elemento<track>
esté establecido entrue
, en cuyo caso el modo predeterminado esshowing
.
Métodos de instancia
Esta interfaz también hereda métodos de EventTarget
.
Nota:
La interfaz TextTrackCue
es una clase abstracta que se utiliza como padre para otras interfaces de señales como VTTCue
. 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()
-
Agrega una señal (especificada como un objeto
TextTrackCue
) a la lista de señales de la pista. TextTrack.removeCue()
-
Elimina una señal (especificada como un objeto
TextTrackCue
) 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
.
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