API de reproductor de Brightcove

Índice API

VJS. Reproductor

EXTENDE : vjs.Componente
DEFINIDO EN : src/js/player.js#L21

Una instancia del vjs.Player La clase se crea cuando se usa cualquiera de los métodos de configuración de Video.js para inicializar un video.

<id de video = "myPlayerID"
  ...>
</video>
...
<script type="text/javascript">
  var myPlayer = videojs('myPlayerID');
</script>

En el ejemplo siguiente, varias de las propiedades indican a la biblioteca Video.js que cree una instancia de reproductor cuando la biblioteca esté lista.

<video
  cuenta-datos="3423279428001"
  reproductor de datos="89d39071-6b96-412c-b759-2aff4f7811b3"
  data-embed = "predeterminado"
  datos-video-id="3971877621001"
  controles de clase = "video-js">< /video>
El uso de cualquiera de las siguientes propiedades en el < video> La etiqueta hará que se cree una instancia de jugador:
  • cuenta de datos
  • reproductor de datos
  • data-video-id
  • configuración de datos

Métodos

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.
Devoluciones:
  • vjs.component El componente hijo (creado por este proceso si se ha utilizado una cadena)

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

Agregar clase (clase para agregar)

Agregar un nombre de clase CSS al elemento del componente

Parámetros:
  • ClassToAdd String Classname para agregar
Devoluciones:
  • Componente VJS

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

Añadir pista de texto a control (pista para agregar)

Añadir una pista de texto al objeto reproductor

Parámetros:
  • TrackToAdd objeto JSON Track to add

Seguimiento de subtítulos de ejemplo:

var enTrack = myPlayer.addRemoteTextTrack({
 tipo: 'títulos',
 idioma: 'en',
 etiqueta: 'Inglés',
 src: 'http://solutions.brightcove.com/bcls/captions/adding_captions_to_videos.vtt'
});
Devoluciones:
  • vjs.text Lista De Pistas

reproducción automática (valor)

Obtén o establece el atributo de reproducción automática.

Parámetros:
  • valor
Devoluciones:
  • String El valor del atributo de reproducción automática al obtener
  • vjs.player Devuelve el reproductor al configurar

definido en : src/js/player.js#L1275

tampón ()

Obtener un objeto TimeRange con las horas del vídeo que se ha descargado

Si solo quieres el porcentaje del vídeo que se ha descargado, usa BufferedPercent.

//Número de intervalos de tiempo diferentes que se han almacenado en búfer. Usualmente 1.
numberOfRanges = bufferedTimeRange.longitud,

// Tiempo en segundos cuando comienza el primer rango. Normalmente 0.
firstRangeStart = bufferedTimeRange.start(0),

// Tiempo en segundos cuando finaliza el primer rango
firstRangeEnd = bufferedTimeRange.end(0),

// Duración en segundos del primer intervalo de tiempo
firstRangeLength = firstRangeEnd - firstRangeStart;
Devoluciones:
  • Objeto Objeto timeRange simulado (siguiendo las especificaciones HTML)

definido en : src/js/player.js#L782

bufferEnd ()

Obtener la hora de finalización del último intervalo de tiempo almacenado en búfer

Esto se utiliza en la barra de progreso para encapsular todos los intervalos de tiempo.

Devoluciones:
  • Número El final del último intervalo de tiempo almacenado en búfer

definido en : src/js/player.js#L833

Porcentaje de búfer ()

Obtén el porcentaje (como decimal) del vídeo que se ha descargado

var cuánto se ha descargado = myPlayer.bufferedPercent();

0 significa ninguno, 1 significa todo. (Este método no está en la especificación HTML5, pero es muy conveniente)

Devoluciones:
  • Número Un decimal entre 0 y 1 que representa el porcentaje

definido en : src/js/player.js#L802

Crear clase CSS ()

Permite que los subcomponentes apilen nombres de clase CSS

Devoluciones:
  • String El nombre de la clase construida

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

Cancelar pantalla completa ()

Nombre anterior para ExitFullScreen obsoleto true

definido en : src/js/player.js#L1038

Catalog.getVideo (VideoID, devolución de llamada)

Realiza una solicitud de catálogo para el vídeo con el identificador especificado e invoca una devolución de llamada cuando se completa la solicitud

Parámetros:
  • Identificador de cadena de VideoID de un vídeo de Video Cloud
  • llamar de vuelta función Función de devolución de llamada para usar en devolución de video

Para obtener más información, consulte el Catálogo de jugadores documento.

catalog.load (vídeo)

Carga un objeto de vídeo en el reproductor

Parámetros:
  • vídeo Objeto Objeto vídeo Video Cloud

Para obtener más información, consulte el Catálogo de jugadores documento.

niños ()

Obtenga una matriz de todos los componentes secundarios

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

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

ClearInterval (interválido)

Borra un intervalo y elimina el listener de eliminación asociado

Parámetros:
  • Número interválido El identificador del intervalo que se va a borrar
Devoluciones:
  • Número Devuelve el identificador de intervalo

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

Borrar tiempo de espera (ID de tiempo de espera)

Borra un tiempo de espera y elimina el listener de eliminación asociado

Parámetros:
  • Número de TimeoutID El identificador del tiempo de espera que se va a borrar
Devoluciones:
  • Número Devuelve el identificador de tiempo de espera

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

contenido en el ()

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

Devoluciones:
  • Elemento

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

controles (controles)

Obtén o establece si se muestran o no los controles.

Parámetros:
  • controles Boolean Establecer controles para mostrar o no
Devoluciones:
  • Se muestran los controles booleanos

definido en : src/js/player.js#L1355

CreaEl ([nombre de etiqueta], [atributos])

Cree el elemento DOM del componente

Parámetros:
  • tagName Cadena (OPCIONAL) Tipo de nodo del elemento. por ejemplo, 'div'
  • atributos Objeto (OPCIONAL) Un objeto de atributos de elemento que debe establecerse en el elemento
Devoluciones:
  • Elemento

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

SRC actual ()

Devuelve la URL completa del valor de origen actual, por ejemplo, http://mysite.com/video.mp4 se puede utilizar junto con CurrentType para ayudar a reconstruir el objeto de origen actual

Devoluciones:
  • String El origen actual

definido en : src/js/player.js#L1242

CurrentTime ([segundos])

Obtener o configurar la hora actual (en segundos)

// conseguir
var whereYouAt = myPlayer.currentTime();

// colocar
miJugador.horaActual(120); // 2 minutos en el video
Parámetros:
  • segundos Número|Cadena (OPCIONAL) El tiempo para buscar
Devoluciones:
  • Número El tiempo en segundos, cuando no se configura
  • VJS.player self, cuando se establece la hora actual

definido en : src/js/player.js#L702

currentType ()

Obtener el tipo de fuente actual, por ejemplo, vídeo/mp4 Esto puede permitirle reconstruir el objeto fuente actual para que pueda cargar la misma fuente y tecnología más adelante.

Devoluciones:
  • String El tipo MIME de origen

definido en : src/js/player.js#L1252

dimensiones (ancho, alto)

Establecer la anchura y la altura al mismo tiempo

Parámetros:
  • ancho Número|Cadena
  • altura Número|Cadena
Devoluciones:
  • vjs.component El componente

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

disponer ()

Destruye el reproductor de vídeo y realiza la limpieza necesaria

miJugador.dispose();

Esto resulta especialmente útil si agrega y elimina vídeos de forma dinámica a/desde el DOM.

definido en : src/js/player.js#L164

duración (segundos)

Obtén la duración del vídeo en segundos

var lengthOfVideo = myPlayer.duration();

NOTA: El vídeo debe haber comenzado a cargarse antes de que se conozca la duración y, en el caso de Flash, puede que no se sepa hasta que el vídeo comience a reproducirse.

Parámetros:
  • segundos
Devoluciones:
  • Número La duración del vídeo en segundos

definido en : src/js/player.js#L730

el ()

Obtener el elemento DOM del componente

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

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

Activar actividad de Touch ()

Informar de la actividad táctil del usuario cuando se producen eventos táctiles

La actividad del usuario se utiliza para determinar cuándo deben mostrarse u ocultar los controles. Es relativamente sencillo cuando se trata de eventos de ratón, porque cualquier evento de ratón debería mostrar los controles. Así que capturamos eventos de ratón que se acumulan al jugador e informamos de la actividad cuando eso ocurre.

Con los eventos táctiles no es tan fácil. No podemos confiar en los eventos táctiles a nivel del reproductor, porque un toque (touchstart + touchend) en el vídeo en sí en los dispositivos móviles tiene por objeto desactivar (y activar) los controles. La actividad del usuario se comprueba de forma asíncrona, de modo que lo que podría suceder es que un evento de toque en el vídeo desactive los controles y, a continuación, el evento touchend se despliega hacia el reproductor, que si informaba de la actividad del usuario, volvería a activar los controles. (Tampoco queremos bloquear completamente los eventos táctiles para evitar que se burbujeen)

Tampoco se supone que un movimiento táctil, toque y mantenga pulsado y cualquier otra cosa que no sea un toque debe volver a encender los controles en un dispositivo móvil.

Aquí configuramos el comportamiento de los componentes predeterminado para informar de la actividad del usuario cada vez que ocurren eventos táctiles, y esto puede desactivarlo los componentes que desean que los eventos táctiles actúen de forma diferente.

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

final ()

Devuelve si el jugador se encuentra o no en estado "finalizado»

Devoluciones:
  • Boolean True si el jugador está en estado final, falso si no

definido en : src/js/player.js#L1476

error (err)

Establecer u obtener el MediaError actual

Parámetros:
  • err * MediaError o Cadena/Número que se convertirá en un MediaError
Devoluciones:
  • vjs.mediaError|nulo al obtener
  • VJS.Player al configurar

definido en : src/js/player.js#L1440

salir de pantalla completa()

Devolver el vídeo a su tamaño normal después de haber estado en modo de pantalla completa

miJugador.exitFullscreen();
Devoluciones:
  • VJS.player auto

definido en : src/js/player.js#L1017

getChild (nombre)

Devuelve un componente secundario con el nombre proporcionado

Parámetros:
  • nombre
Devoluciones:
  • Componente VJS

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

getChildById (id)

Devuelve un componente secundario con el identificador proporcionado

Parámetros:
  • id
Devoluciones:
  • Componente VJS

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

HasClass (clase para comprobar)

Comprobar si el elemento de un componente tiene un nombre de clase CSS

Parámetros:
  • ClassToCheck String Classname para comprobar
Devoluciones:
  • Componente VJS

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

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
Devoluciones:
  • vjs.component Este componente, al configurar la altura
  • Número|String La altura, al obtener

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

hide ()

Ocultar el elemento componente si se muestra actualmente

Devoluciones:
  • Componente VJS

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

id ()

Obtener el ID del componente

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

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

init (etiqueta, [opciones], [listo])

función constructora del jugador

Parámetros:
  • tag Element La etiqueta de vídeo original utilizada para configurar las opciones
  • opciones Objeto (OPCIONAL) Opciones del jugador
  • listo Función (OPCIONAL) Función de devolución de llamada lista

definido en : src/js/player.js#L32

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
  }
}

// O al crear el componente
var myComp = new MyComponent(jugador, {
  niños: {
    myChildComponent: {
      myChildOption: verdadero
    }
  }
});

La opción de niños también puede ser una matriz de nombres de niños u objetos de opciones de niños (que también incluyen una clave de 'nombre').

var myComp = new MyComponent(jugador, {
  niños: [
    'botón',
    {
      nombre: 'botón',
      algunaOtraOpción: verdadero
    }
  ]
});

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

ISFs a pantalla completa (ISF)

Nombre anterior para isFullScreen () Verdadero obsoleto

Parámetros:
  • ISF

definido en : src/js/player.js#L940

pantalla completa ([ISF])

Comprueba si el reproductor está en modo de pantalla completa

// conseguir
var fullscreenOrNot = myPlayer.isFullscreen();

// colocar
myPlayer.isFullscreen(verdadero); // decirle al jugador que está en pantalla completa

NOTA: A partir de la última especificación HTML5, isFullScreen ya no es una propiedad oficial y, en cambio, se utiliza document.fullScreenElement. Pero isFullScreen sigue siendo una propiedad valiosa para el funcionamiento interno de los jugadores.

Parámetros:
  • isFS Boolean (OPCIONAL) Actualizar el estado de pantalla completa del reproductor
Devoluciones:
  • Boolean true si es a pantalla completa, false si no
  • VJS.player self, al configurar

definido en : src/js/player.js#L928

idioma (código de idioma)

El código de idioma del jugador

Parámetros:
  • LanguageCode String La cadena de configuración regional
Devoluciones:
  • String La cadena de configuración regional al obtener
  • VJS.player self, al configurar

definido en : src/js/player.js#L124

load ()

Comience a cargar los datos src

Devoluciones:
  • VJS.Player Devuelve el jugador

definido en : src/js/player.js#L1232

loop (valor)

Obtener o configurar el atributo loop en el elemento vídeo

Parámetros:
  • valor
Devoluciones:
  • String El valor del atributo de bucle al obtener
  • vjs.player Devuelve el reproductor al configurar

definido en : src/js/player.js#L1289

silenciado ([silenciado])

Obtener el estado silenciado actual o activar o desactivar el silencio

// conseguir
var isVolumeMuted = myPlayer.muted();

// colocar
miJugador.silenciado(verdadero); // silenciar el volumen
Parámetros:
  • silenciado Booleano (OPCIONAL) Verdadero para silenciar, falso para no silenciar
Devoluciones:
  • Boolean True si el silencio está activado, falso si no, al obtener
  • VJS.player self, al configurar el silencio

definido en : src/js/player.js#L890

nombre ()

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

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

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

off ([primero], [segundo], [tercero])

Eliminar un detector de eventos del elemento del componente

myComponent.off('tipoEvento', myFunc);

Si se excluye myFunc, se eliminarán TODOS los oyentes del tipo de evento. Si se excluye EventType, TODOS los oyentes se eliminarán del componente.

Alternativamente, puede utilizar off para eliminar los oyentes que se agregaron a otros elementos o componentes mediante MyComponent.On (OtherComponent.... En este caso, tanto el tipo de evento como la función de escucha son NECESARIOS.

myComponent.off(otherElement, 'eventType', myFunc);
myComponent.off(otherComponent, 'eventType', myFunc);
Parámetros:
  • first String|vjs.Component (OPCIONAL) El tipo de evento u otro componente
  • segunda Función|Cadena (OPCIONAL) La función de escucha o el tipo de evento
  • tercera función (OPCIONAL) El oyente de otro componente
Devoluciones:
  • Componente VJS

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

on (primero, segundo, tercero)

Agregar un detector de eventos al elemento de este componente

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

myComponent.on("tipoEvento", myFunc);

El contexto de myFunc será myComponent a menos que esté vinculado previamente.

Alternativamente, puede agregar un agente de escucha a otro elemento o componente.

myComponent.on(otherElement, "eventName", myFunc);
myComponent.on(otherComponent, "eventName", myFunc);

La ventaja de utilizar esto sobre vjs.on (OtherElement, "EventName», myFunc) y OtherComponent.on ("EventName», myFunc) es que así los oyentes se limpiarán automáticamente cuando se elimine cualquiera de los componentes. También vinculará myComponent como contexto de myFunc.

NOTA: Al usar esto en elementos de la página distintos de la ventana y del documento (ambos permanentes), si elimina el elemento del DOM, debe llamar a vjs.trigger (el, "eliminar») para limpiar las referencias a él y permitir que el navegador se basura recogerlo.

Parámetros:
  • first string|VJS.Component El tipo de evento u otro componente
  • second Function|String El controlador de eventos o tipo de evento
  • third Función El controlador de eventos
Devoluciones:
  • vjs.componente auto

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

uno (primero, segundo, [tercero])

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

myComponent.one("nombreEvento", myFunc);

Alternativamente, puede agregar un agente de escucha a otro elemento o componente que se activará una sola vez.

myComponent.one(otherElement, "eventName", myFunc);
myComponent.one(otherComponent, "eventName", myFunc);
Parámetros:
  • first string|VJS.Component El tipo de evento u otro componente
  • second Function|String La función de escucha o tipo de evento
  • tercera función (OPCIONAL) La función de escucha para otro componente
Devoluciones:
  • Componente VJS

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

opciones ()

Recupera datos de la etiqueta incrustada y la inicialización del reproductor

Devoluciones:
  • objeto JavaScript

Ejemplo de datos devueltos por opciones () método

registro de la consola de opciones

Nota: Si el reproductor se completó con fuentes solo a través del catálogo, el fuentes la matriz no tendrá nada en ella

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
Devoluciones:
  • Objeto NUEVO objeto de esto.opciones_ y obj fusionados

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

pausa ()

Pausa la reproducción de vídeo

miJugador.pausa();
Devoluciones:
  • VJS.player auto

definido en : src/js/player.js#L671

pausado ()

Comprueba si el reproductor está en pausa

var isPaused = myPlayer.paused();
var estáJugando = !miJugador.pausado();
Devoluciones:
  • Boolean false si el medio se está reproduciendo actualmente o true de otro modo

definido en : src/js/player.js#L684

jugar ()

iniciar la reproducción multimedia

miJugador.play();
Devoluciones:
  • VJS.player auto

definido en : src/js/player.js#L659

Tasa de reproducción (tasa)

Obtiene o establece la velocidad de reproducción actual

Parámetros:
  • rate Número Nueva velocidad de reproducción que se va a establecer
Devoluciones:
  • Número Devuelve la nueva velocidad de reproducción al configurar
  • Número Devuelve la velocidad de reproducción actual al obtener

Advertencias

  • Solo se admite con vídeo HTML y, a continuación, solo en plataformas que cuentan con compatibilidad con estándares para diferentes velocidades de reproducción
  • Se basa en las capacidades del navegador y, por lo tanto, no funcionará en todas partes (debería funcionar bien en iPad, Chrome y Firefox)

definido en : src/js/player.js#L1618

jugador ()

Devolver el reproductor del componente

Devoluciones:
  • VJS. Reproductor

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

póster ([src])

obtener o configurar la URL de origen de la imagen del póster

EJEMPLO:
// conseguir
var poster actual = myPlayer.poster();

// configuración
myPlayer.poster('http://example.com/myImage.jpg');
Parámetros:
  • src String (OPCIONAL) URL de origen de la imagen del póster
Devoluciones:
  • URL del póster de cadena al obtener
  • VJS.player self al configurar

definido en : src/js/player.js#L1320

precarga (valor)

Obtener o configurar el atributo de precarga

Parámetros:
  • valor
Devoluciones:
  • String El valor del atributo de precarga al obtener
  • vjs.player Devuelve el reproductor al configurar

definido en : src/js/player.js#L1261

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
Devoluciones:
  • Componente VJS

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

tiempo restante()

Calcula cuánto tiempo queda

var timeLeft = myPlayer.remainingTime();

No es una función de elemento de vídeo nativo, pero útil

Devoluciones:
  • Número El tiempo restante en segundos

definido en : src/js/player.js#L754

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#L420

Quitar clase (clase para quitar)

Eliminar un nombre de clase CSS del elemento del componente

Parámetros:
  • ClassToRemove String Classname para eliminar
Devoluciones:
  • Componente VJS

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

Solicitar pantalla completa ()

Nombre anterior para requestFullScreen obsoleto true

definido en : src/js/player.js#L1004

requestFullscreen ()

Aumenta el tamaño del vídeo a pantalla completa

myPlayer.requestFullscreen();

En algunos navegadores, la pantalla completa no es compatible de forma nativa, por lo que entra en "modo de ventana completa», donde el video llena la ventana del navegador. En los navegadores y dispositivos que admiten pantalla completa nativa, a veces se muestran los controles predeterminados del navegador, y no el aspecto personalizado Video.js. Esto incluye la mayoría de los dispositivos móviles (iOS, Android) y versiones anteriores de Safari.

Devoluciones:
  • VJS.player auto

definido en : src/js/player.js#L959

buscando ()

Devuelve si el jugador se encuentra o no en estado de "búsqueda»

Devoluciones:
  • Boolean True si el jugador está en estado de búsqueda, falso si no

definido en : src/js/player.js#L1482

setInterval (fn, intervalo)

Crea un intervalo y configura la eliminación automáticamente

Parámetros:
  • fn Function La función que se ejecuta cada N segundos
  • intervalo Número de ms que se deben retrasar antes de ejecutar la función especificada
Devoluciones:
  • Número Devuelve el identificador de intervalo

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

setTimeout (fn, timeout)

Crea tiempo de espera y configura la eliminación automáticamente

Parámetros:
  • fn Function La función que se ejecutará después del tiempo de espera
  • tiempo de espera Número de ms que se deben retrasar antes de ejecutar la función especificada
Devoluciones:
  • Número Devuelve el identificador de tiempo de espera

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

show ()

Mostrar el elemento componente si está oculto

Devoluciones:
  • Componente VJS

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

src ([fuente], tipo)

La función fuente actualiza la fuente de vídeo

Hay tres tipos de variables que se pueden pasar como argumento.

Cadena URL: URL del archivo de vídeo. Utilice este método si está seguro de que la tecnología de reproducción actual (HTML5/Flash) puede admitir la fuente que proporciona. Actualmente, solo se pueden utilizar archivos MP4 tanto en HTML5 como en Flash.

myPlayer.src("http://www.example.com/path/to/video.mp4");

Objeto de origen (o elemento): Objeto javascript que contiene información sobre el archivo de origen. Utilice este método si desea que el reproductor determine si puede admitir el archivo utilizando la información de tipo.

myPlayer.src({ tipo: "video/mp4", src: "http://www.example.com/path/to/video.mp4" });

Matriz de objetos de origen: Para proporcionar varias versiones del origen para que se pueda reproducir utilizando HTML5 en todos los navegadores, puede utilizar una matriz de objetos de origen. Video.js detectará qué versión es compatible y cargará ese archivo.

miJugador.src([
  { tipo: "video/mp4", src: "http://www.example.com/path/to/video.mp4" },
  { tipo: "video/webm", src: "http://www.example.com/path/to/video.webm" },
  { tipo: "video/ogg", src: "http://www.example.com/path/to/video.ogv" }
]);
Parámetros:
  • cadena de orígen|Objeto|Array URL de origen, objeto o matriz de fuentes
  • type String El formato del vídeo; puede incluir
    • vídeo/mp4
    • vídeo/webm
    • vídeo/ogg
    • Aplicación/X-MPEgurl (para HLS)
Devoluciones:
  • String La fuente de vídeo actual al obtener
  • Cadena El reproductor al configurar

definido en : src/js/player.js#L1147

trigger (evento)

Activar un evento en un elemento

myComponent.trigger('nombreEvento');
myComponent.trigger({'type':'eventName'});
Parámetros:
  • event Event|Objeto|String Una cadena (el tipo) o un objeto de evento con un atributo type
Devoluciones:
  • vjs.componente auto

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

Listo para activadores ()

Activa a los oyentes listos

Devoluciones:
  • Componente VJS

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

volumen (porcentasDecimal)

Obtener o configurar el volumen actual de los medios

// conseguir
var comoLoudIsIt = myPlayer.volume();

// colocar
miReproductor.volumen(0.5); // Poner el volumen a la mitad

0 está apagado (silenciado), 1,0 está todo el camino hacia arriba, 0,5 está a mitad de camino.

Parámetros:
  • PercentasNúmero decimal El nuevo volumen como porcentaje decimal
Devoluciones:
  • Número El volumen actual, al obtener
  • VJS.player self, al configurar

definido en : src/js/player.js#L860

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'
Devoluciones:
  • vjs.component Este componente, al configurar la anchura
  • Número|String El ancho, al obtener

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

Eventos

durationchange EVENTO

Se activa cuando se conoce o cambia por primera vez la duración del recurso multimedia

definido en : src/js/player.js#L554

EVENTO finalizado

Se activa cuando se alcanza el final del recurso multimedia (CurrentTime == duración)

definido en : src/js/player.js#L541

FIRSTPLAY EVENTO

Se disparó la primera vez que se reproduce un vídeo

No forma parte de las especificaciones de HLS, y no estamos seguros de si esta es la mejor implementación hasta la fecha, así que úsalo con moderación. Si no tienes motivos para impedir la reproducción, usa MyPlayer.ONE ("play»); en su lugar.

definido en : src/js/player.js#L498

evento de cambio de pantalla completa

Se dispara cuando el reproductor entra o sale del modo de pantalla completa

definido en : src/js/player.js#L583

eventos cargados todos los datos

Se activa cuando el reproductor ha terminado de descargar los datos de origen

definido en : src/js/player.js#L445

EVENTO de datos cargados

Se activa cuando el reproductor ha descargado datos en la posición de reproducción actual

definido en : src/js/player.js#L439

EVENTO de metadatos cargados

Se dispara cuando el jugador tiene información inicial sobre la duración y la dimensión

definido en : src/js/player.js#L433

EVENTO loadstart

Se activa cuando el agente de usuario comienza a buscar datos multimedia

definido en : src/js/player.js#L389

pausa EVENTO

Disparado cada vez que los medios han estado en pausa

definido en : src/js/player.js#L512

jugar EVENT

Se activa cada vez que el medio comienza o reanuda la reproducción

definido en : src/js/player.js#L451

progreso EVENTO

Se activó mientras el agente de usuario descarga datos multimedia

definido en : src/js/player.js#L530

cambiar tamaño EVENT

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

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

EVENTO buscado

Disparado cuando el jugador ha terminado de saltar a una nueva hora

definido en : src/js/player.js#L485

buscando EVENTO

Disparado cada vez que el jugador salta a una nueva hora

definido en : src/js/player.js#L477

evento timeupdate

Se activa cuando la posición de reproducción actual ha cambiado

Durante la reproducción, se activa cada 15 a 250 milisegundos, dependiendo de la tecnología de reproducción que se utilice.

definido en : src/js/player.js#L524

evento de cambio de volumen

Se activa cuando cambia el volumen

definido en : src/js/player.js#L577

EVENT en espera

Disparado cuando los medios empiezan a esperar

definido en : src/js/player.js#L460