VJS. Pistas de subtítulos

Índice API

EXTENDE : vjs.TextTrack
DEFINIDO EN : src/js/tracks.js#L679

El componente de pista para gestionar la ocultación y visualización de subtítulos

ÍNDICE

MÉTODOS

activate ()

Activa el seguimiento de tacos. Las pistas que se muestran U ocultas están activas.

heredado de : src/js/tracks.js#L385

ActiveCues ()

Obtenga las señales activas de la pista

DEVUELVE:
  • Matriz

heredado de : src/js/tracks.js#L264

addChild (child, [opciones])

Añade un componente hijo dentro de este componente

miComponente.el();
// -> < div class='mi-componente'>< /div>
miComponente.niños();
// [matriz vacía]

var myButton = myComponent.addChild('MyButton');
// -> < div class='mi-componente'>< div class="mi-boton"> miBoton< división>< /div>
// -> miBotón === miComponente.niños()[0];

Pasar opciones para constructores secundarios y opciones para hijos del niño

var miBotón = miComponente.addChild('MiBotón', {
  texto: 'Presionarme',
  niños: {
    buttonChildEjemplo: {
      buttonChildOption: verdadero
    }
  }
});
PARÁMETROS:
  • cadena secundario|VJS.Component Nombre de clase o instancia de un hijo que se va a agregar
  • options Object (OPCIONAL) Opciones, incluidas las opciones que se pasarán a los hijos del hijo.
DEVUELVE:
  • vjs.component El componente hijo (creado por este proceso si se ha utilizado una cadena)

heredado de : src/js/component.js#L343

Agregar clase (clase para agregar)

Agregar un nombre de clase CSS al elemento del componente

PARÁMETROS:
  • ClassToAdd String Classname para agregar
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L628

Ajustar tamaño de fuente ()

Cambia el tamaño de fuente de la pista de texto para agrandarla al reproducirla en modo de pantalla completa y restaurarla a su tamaño normal cuando no esté en modo de pantalla completa.

heredado de : src/js/tracks.js#L309

Crear clase CSS ()

Permite que los subcomponentes apilen nombres de clase CSS

DEVUELVE:
  • String El nombre de la clase construida

heredado de : src/js/component.js#L471

niños ()

Obtenga una matriz de todos los componentes secundarios

var niños = miComponente.niños();
DEVUELVE:
  • Array Los niños

heredado de : src/js/component.js#L277

contenido en el ()

Devuelve el elemento DOM del componente para incrustar contenido. Será el_ o un nuevo elemento definido en CreateEl.

DEVUELVE:
  • Elemento

heredado de : src/js/component.js#L220

Crear el ()

Crear div básico para mantener el texto de referencia

DEVUELVE:
  • Elemento

heredado de : src/js/tracks.js#L325

señales ()

Obtén las señales de pista

DEVUELVE:
  • Matriz

heredado de : src/js/tracks.js#L249

desactivar ()

Desactiva el seguimiento de tacos.

heredado de : src/js/tracks.js#L408

dflt ()

Obtenga el valor predeterminado de la pista. ('predeterminado' es una palabra clave reservada)

DEVUELVE:
  • booleano

heredado de : src/js/tracks.js#L190

dimensiones (ancho, alto)

Establecer la anchura y la altura al mismo tiempo

PARÁMETROS:
  • ancho Número|Cadena
  • altura Número|Cadena
DEVUELVE:
  • vjs.component El componente

heredado de : src/js/component.js#L737

disable ()

Deshabilitar: Modo desactivado/desactivación (0) Indica que la pista de texto no está activa. Además de exponer la pista en el DOM, el agente de usuario ignora la pista de texto. No hay señales activas, no se activan eventos y el agente de usuario no intentará obtener las señales de la pista.

heredado de : src/js/tracks.js#L371

disponer ()

Elimine el componente y todos los componentes secundarios

heredado de : src/js/component.js#L74

el ()

Obtener el elemento DOM del componente

var domEl = miComponente.el();
DEVUELVE:
  • Elemento

heredado de : src/js/component.js#L201

getChild (nombre)

Devuelve un componente secundario con el nombre proporcionado

PARÁMETROS:
  • nombre
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L311

getChildById (id)

Devuelve un componente secundario con el identificador proporcionado

PARÁMETROS:
  • id
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L294

height ([num], [Skiplisteners])

Obtener o establecer la altura del componente (valores CSS)

La configuración de los valores de dimensión de las etiquetas de vídeo solo funciona con valores en píxeles. Los valores porcentuales no funcionarán. Se pueden utilizar algunos porcentaje, pero width () /height () devolverá el número +%, no el ancho/alto calculados reales.

PARÁMETROS:
  • num Número|Cadena (OPCIONAL) Altura del nuevo componente
  • skipListeners Booleano (OPCIONAL) Saltar el activador del evento de cambio de tamaño
DEVUELVE:
  • vjs.component Este componente, al configurar la altura
  • Número|String La altura, al obtener

heredado de : src/js/component.js#L726

hide ()

Ocultar: Modo oculto (1) Indica que la pista de texto está activa, pero que el agente de usuario no muestra activamente las señales. Si aún no se ha intentado obtener las señales de la pista, el agente de usuario lo realizará momentáneamente. El agente de usuario mantiene una lista de qué señales están activas y los eventos se activan en consecuencia.

heredado de : src/js/tracks.js#L356

id ()

Obtener el ID del componente

var id = miComponente.id();
DEVUELVE:
  • cuerda

heredado de : src/js/component.js#L239

init (reproductor, opciones)

PARÁMETROS:
  • jugador
  • opciones

heredado de : src/js/tracks.js#L128

Init Niños ()

Agregar e inicializar componentes secundarios predeterminados desde las opciones

// cuando se crea una instancia de MyComponent, todos los hijos en opciones
// se agregará a la instancia por sus cadenas de nombre y opciones
MiComponente.prototipo.opciones_.niños = {
  myChildComponent: {
    myChildOption: verdadero
  }
}

heredado de : src/js/component.js#L439

kind ()

Obtenga el valor del tipo de pista

DEVUELVE:
  • cuerda

heredado de : src/js/tracks.js#L161

etiqueta ()

Obtener el valor de etiqueta de pista

DEVUELVE:
  • cuerda

heredado de : src/js/tracks.js#L234

idioma ()

Obtenga el valor del idioma de la pista

DEVUELVE:
  • cuerda

heredado de : src/js/tracks.js#L219

modo ()

Obtén el modo pista

DEVUELVE:
  • Número

heredado de : src/js/tracks.js#L301

nombre ()

Obtén el nombre del componente. El nombre se utiliza a menudo para hacer referencia al componente.

var nombre = miComponente.nombre();
DEVUELVE:
  • cuerda

heredado de : src/js/component.js#L258

off ([type], [fn])

Eliminar un detector de eventos del elemento del componente

myComponent.off("nombreEvento", myFunc);
PARÁMETROS:
  • tipo Cadena (OPCIONAL) Tipo de evento. Sin tipo, eliminará a todos los oyentes.
  • fn Función (OPCIONAL) Oyente de eventos. Sin fn, eliminará todos los oyentes de un tipo.
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L510

on (tipo, fn)

Agregar un detector de eventos al elemento de este componente

var myFunc = function(){
  var myPlayer = this;
  // Hacer algo cuando se dispara el evento
};

myPlayer.on("nombreEvento", myFunc);

El contexto será el componente.

PARÁMETROS:
  • type String El tipo de evento, por ejemplo, 'clic'
  • fn Function El detector de eventos
DEVUELVE:
  • vjs.componente auto

heredado de : src/js/component.js#L496

one (tipo, fn)

Añadir un detector de eventos para activarlo solo una vez y luego eliminarlo

PARÁMETROS:
  • type String Tipo de evento
  • fn Función de escucha de eventos
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L522

opciones (obj)

Fusión profunda de objetos de opciones

Siempre que una propiedad sea un objeto en ambos objetos options, las dos propiedades se fusionarán utilizando vjs.obj.DeepMerge.

Se utiliza para combinar opciones de componentes secundarios. Queremos que sea fácil anular las opciones individuales de un componente secundario sin tener que volver a escribir todas las demás opciones predeterminadas.

Padre.prototipo.opciones_ = {
  niños: {
    'childOne': { 'foo': 'bar', 'asdf': 'fdsa' },
    'niñoDos': {},
    'niñoTres': {}
  }
}
nuevasOpciones = {
  niños: {
    'niñoUno': { 'foo': 'baz', 'abc': '123' }
    'niñoDos': nulo,
    'niñoCuatro': {}
  }
}

this.options(nuevasOpciones);

RESULTADO

{
  niños: {
    'niñoUno': { 'foo': 'baz', 'asdf': 'fdsa', 'abc': '123' },
    'childTwo': nulo, // Deshabilitado. No se inicializará.
    'niñoTres': {},
    'niñoCuatro': {}
  }
}
PARÁMETROS:
  • obj Objeto Objeto de nuevos valores de opción
DEVUELVE:
  • Objeto NUEVO objeto de esto.opciones_ y obj fusionados

heredado de : src/js/component.js#L169

jugador ()

Devolver el reproductor del componente

DEVUELVE:
  • VJS. Reproductor

heredado de : src/js/component.js#L116

listo (fn)

Vincular un agente de escucha al estado listo del componente

A diferencia de los oyentes de eventos, ya que si el evento listo ya ha ocurrido, activará la función inmediatamente.

PARÁMETROS:
  • fn Función Oyente listo
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L581

Estado listo ()

Obtenga la pista ReadyState

DEVUELVE:
  • Número

heredado de : src/js/tracks.js#L283

RemoveChild (componente)

Eliminar un componente hijo de la lista de hijos de este componente y el elemento del componente hijo del elemento de este componente

PARÁMETROS:
  • componente vjs.componente componente que se va a quitar

heredado de : src/js/component.js#L401

Quitar clase (clase para quitar)

Eliminar un nombre de clase CSS del elemento del componente

PARÁMETROS:
  • ClassToRemove String Classname para eliminar
DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L639

show ()

Mostrar: Mode Showing (2) Indica que la pista de texto está activa. Si aún no se ha intentado obtener las señales de la pista, el agente de usuario lo realizará momentáneamente. El agente de usuario mantiene una lista de qué señales están activas y los eventos se activan en consecuencia. Además, para las pistas de texto cuyo tipo son subtítulos o subtítulos, las señales se muestran sobre el vídeo según corresponda; para las pistas de texto cuyo tipo son descripciones, el agente de usuario pone las señales a disposición del usuario de forma no visual; y para las pistas de texto cuyo tipo son capítulos, el agente de usuario es poner a disposición del usuario un mecanismo mediante el cual el usuario puede navegar a cualquier punto del recurso multimedia seleccionando una señal. El estado de visualización por defecto se utiliza junto con el atributo predeterminado de los elementos de pista para indicar que la pista de texto estaba habilitada debido a ese atributo. Esto permite que el agente de usuario anule el estado si se descubre una pista posterior que es más adecuada según las preferencias del usuario.

heredado de : src/js/tracks.js#L341

src ()

Obtenga el valor src track

DEVUELVE:
  • cuerda

heredado de : src/js/tracks.js#L175

title ()

Obtener el valor del título de la pista

DEVUELVE:
  • cuerda

heredado de : src/js/tracks.js#L204

trigger (tipo, evento)

Activar un evento en un elemento

myComponent.trigger('nombreEvento');
PARÁMETROS:
  • type String El tipo de evento que se va a activar, por ejemplo, «clic»
  • event Event|Objeto El objeto de evento que se va a pasar al agente de escucha
DEVUELVE:
  • vjs.componente auto

heredado de : src/js/component.js#L536

Listo para activadores ()

Activa a los oyentes listos

DEVUELVE:
  • Componente VJS

heredado de : src/js/component.js#L600

width ([num], Skiplisteners)

Establecer u obtener el ancho del componente (valores CSS)

La configuración de los valores de dimensión de las etiquetas de vídeo solo funciona con valores en píxeles. Los valores porcentuales no funcionarán. Se pueden utilizar algunos porcentaje, pero width () /height () devolverá el número +%, no el ancho/alto calculados reales.

PARÁMETROS:
  • num Número|Cadena (OPCIONAL) Número de ancho opcional
  • skipListeners Boolean Saltar el activador del evento 'redimensionar'
DEVUELVE:
  • vjs.component Este componente, al configurar la anchura
  • Número|String El ancho, al obtener

heredado de : src/js/component.js#L709

EVENTOS

cambiar tamaño EVENT

Disparado cuando cambian la anchura y/o la altura del componente

heredado de : src/js/component.js#L816