Jugador(etiqueta, opcionesoptar , Listooptar)

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

Después de crear una instancia, se puede acceder a ella globalmente de dos formas:

  1. Llamando a videojs ('example_video_1');
  2. Utilizándolo directamente a través de videojs.players.example_video_1;

nuevo Jugador(etiqueta, opcionesoptar , Listooptar)
jugador.js , línea 292

Cree una instancia de esta clase.

Parámetros:
Nombre Tipo Atributos Descripción
etiqueta Elemento

El elemento DOM de vídeo original utilizado para configurar las opciones.
opciones Objeto <optional>

Nombres y valores de objeto de opciones.
listo Componente~Devolución de llamada lista <optional>

Función de devolución de llamada lista.

Extiende

Miembros

reproductores estáticos :Objeto
jugador.js , línea 5243

Enumeración global de jugadores.

Las claves son los ID de los jugadores y los valores son los Jugador instancia o nulo para jugadores eliminados.

origen cruzado
jugador.js , línea 5233

Obtener o configurar el JugadorOpción de origen cruzado. Para el reproductor HTML5, esto establece el cruzOrigen propiedad en el < video> etiqueta para controlar el comportamiento de CORS.

Ver:

Métodos

getTagSettings estáticos (etiqueta) → {Objeto}
jugador.js , línea 5020

Obtiene la configuración de etiquetas

Parámetros:
Nombre Tipo Descripción
etiqueta Elemento

La etiqueta de jugador
Devoluciones:
Objeto -

Objeto que contiene toda la configuración de una etiqueta de jugador

$ (selector, opción de contexto) → {Elemento|null}
componente.js , línea 778

Busque un único elemento DOM que coincida con un selector. Puede estar dentro del componente contenTel () u otro contexto personalizado.

Parámetros:
Nombre Tipo Atributos Predeterminado Descripción
selector cuerda

Selector CSS válido, que se pasará a QuerySelector.
contexto Element | cadena <optional>
 Este.contentel ()

Elemento DOM dentro del que realizar consultas. También puede ser una cadena selectora en cuyo caso el primer elemento coincidente se utilizará como contexto. Si falta this.contentel () se utiliza. Si this.contentel () no devuelve nada, vuelve al documento.
Devoluciones:
Elemento | null -

el elemento dom que se encontró, o nulo

Anulaciones:
Ver:

$$ (selector, opción de contexto) → {NodeList}
componente.js , línea 800

Busca todos los elementos DOM que coinciden con un selector. Puede estar dentro del componente contenTel () u otro contexto personalizado.

Parámetros:
Nombre Tipo Atributos Predeterminado Descripción
selector cuerda

Selector CSS válido, que se pasará a QuerySelectorAll.
contexto Element | cadena <optional>
 Este.contentel ()

Elemento DOM dentro del que realizar consultas. También puede ser una cadena selectora en cuyo caso el primer elemento coincidente se utilizará como contexto. Si falta this.contentel () se utiliza. Si this.contentel () no devuelve nada, vuelve al documento.
Devoluciones:
Lista de nodos -

una lista de elementos dom que se encontraron

Anulaciones:
Ver:

addChild (hijo, opciones optar , índice optar ) → { Componente }
componente.js , línea 469

Agregue un componente hijo dentro del componente actual.

Parámetros:
Nombre Tipo Atributos Predeterminado Descripción
niño string | Componente

El nombre o la instancia de un hijo que se va a agregar.
opciones Objeto <optional>
 {}

El almacén de clave/valor de opciones que se pasarán a los hijos del niño.
índice número <optional>
 this.children_.length

Índice al que intentar agregar un hijo.
Devoluciones:
Componente-

El componente que se agrega como hijo. Cuando se usa una cuerda, Componente será creado por este proceso.

Anulaciones:

Agregar clase(clase para agregar)
componente.js , línea 824

Agregue un nombre de clase CSS al elemento del componente.

Parámetros:
Nombre Tipo Descripción
Clase para agregar cuerda

Nombre de clase CSS para agregar
Anulaciones:

addRemoteTextTrack (opciones, manualCleanup opt ) → {HtmlTrackElement}
jugador.js , línea 4542

Cree un TextTrack remoto y un HTMLTrackElement. Cuando manualCleanup se establece en falso, la pista se eliminará automáticamente en los cambios de fuente.

Parámetros:
Nombre Tipo Atributos Predeterminado Descripción
opciones Objeto

Opciones para pasar a HTMLTrackElement durante la creación. Consulte HTMLTrackElement para obtener información sobre las propiedades de objeto que debe utilizar.

Limpieza manual booleano <optional>
 verdadero

si se establece en falso, TextTrack se eliminará en un cambio de fuente
Devoluciones:
HtmlTrackElement -

el HTMLTrackElement que se creó y agregó a HtmlTrackElementList y al TextTrackList remoto

En desuso:
  • El valor predeterminado del parámetro «ManualCleanup» será «false» de forma predeterminada en las próximas versiones de Video.js

addTextTrack ( opción de tipo, opción de etiqueta, opción de idioma) → { TextTrack | indefinido}
jugador.js , línea 4516

Un método de ayuda para agregar un TextTrack a nuestra TextTrackList.

Además de la configuración del W3C, permitimos añadir información adicional a través de opciones.

Parámetros:
Nombre Tipo Atributos Descripción
amable cuerda <optional>

el tipo de TextTrack que estás agregando
etiqueta cuerda <optional>

la etiqueta para dar la etiqueta TextTrack
idioma cuerda <optional>

el idioma que se va a configurar en TextTrack
Devoluciones:
TextTrack | indefinido -

TextTrack que se ha agregado o no definido si no hay tecnología

Ver:

aspectRatio (ratio opt ) → {cadena|indefinido}
jugador.js , línea 1017

Un getter / setter para el Jugadorrelación de aspecto.

Parámetros:
Nombre Tipo Atributos Descripción
proporción cuerda <optional>

El valor para establecer el Jugadorrelación de aspecto de.
Devoluciones:
string | undefined -
  • La relación de aspecto actual del reproductor al obtener. - indefinido al configurar

audioOnlyMode (valor opt ) → {Promise|boolean}
jugador.js , línea 4370

Obtenga el estado actual de audioOnlyMode o establezca audioOnlyMode en verdadero o falso.

Establecer esto en verdadero ocultará todos los componentes del reproductor excepto la barra de control, así como los componentes de la barra de control necesarios solo para video.

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano <optional>

El valor para establecer audioOnlyMode.
Devoluciones:
Promesa | booleano -

Se devuelve una promesa al establecer el estado y un valor booleano al obtener el estado actual

audioPosterMode (valor opt ) → {Promise|boolean}
jugador.js , línea 4447

Obtenga el estado actual de audioPosterMode o establezca audioPosterMode en verdadero o falso

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano <optional>

El valor para establecer audioPosterMode.
Devoluciones:
Promesa | booleano -

Se devuelve una promesa al establecer el estado y un valor booleano al obtener el estado actual

Pistas de audio () → { Lista de pistas de audio }
jugador.js , línea 5164

Obtener la lista de seguimiento de audio

Devoluciones:
AudioTrackList -

la lista de pistas de audio actual

reproducción automática ( opción de valor) → {booleano|cadena}
jugador.js , línea 3721

Obtén o configura la opción de reproducción automática. Cuando este es un booleano, modificará el atributo en la tecnología. Cuando se trata de una cadena, el atributo de la tecnología se eliminará y Jugador manejará la reproducción automática en loadstarts.

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano | cuerda <optional>
  • verdadero: reproducción automática usando el comportamiento del navegador - falso: no reproducir automáticamente - 'reproducir': llamar a play() en cada inicio de carga - 'silenciado': llamar a silenciar() y luego reproducir() en cada inicio de carga - 'cualquiera': llamar a reproducir() en cada inicio de carga. si eso falla, llama a muted() y luego a play(). - *: los valores que no sean los enumerados aquí se configurarán como verdaderos.
Devoluciones:
booleano | cuerda -

El valor actual de la reproducción automática al obtener

blur()
component.js, línea 1164

Eliminar el enfoque de este componente

Anulaciones:

puntos de interrupción ( opción de puntos de interrupción) → {Objeto}
jugador.js , línea 4800

Obtenga o establezca puntos de interrupción en el jugador.

Llamar a este método con un objeto o cierto eliminará los puntos de interrupción personalizados anteriores y comenzará de nuevo desde los valores predeterminados.

Parámetros:
Nombre Tipo Atributos Descripción
puntos de interrupción Objeto | booleano <optional>

Si se proporciona un objeto, se puede utilizar para proporcionar puntos de interrupción personalizados. Si cierto se proporciona, establecerá puntos de interrupción predeterminados. Si no se proporciona este argumento, simplemente devolverá los puntos de interrupción actuales.

Propiedades
Nombre Tipo Atributos Descripción
diminuto número <optional>

El ancho máximo para la clase "vjs-layout-tiny".
pequeño número <optional>

El ancho máximo para la clase "vjs-layout-x-small".
pequeña número <optional>

El ancho máximo para la clase "vjs-layout-small".
medio número <optional>

El ancho máximo para la clase "vjs-layout-medium".
grande número <optional>

El ancho máximo para la clase "vjs-layout-large".
xlarge número <optional>

El ancho máximo para la clase "vjs-layout-x-large".
enorme número <optional>

El ancho máximo para la clase "vjs-layout-huge".
Devoluciones:
Objeto -

Un objeto que asigna los nombres de los puntos de interrupción a los valores de ancho máximo.

almacenado en búfer () → {Rango de tiempo}
jugador.js , línea 2651

Obtenga un objeto TimeRange con una matriz de las horas del vídeo que se ha descargado. Si solo quieres el porcentaje del vídeo que se ha descargado, usa BufferedPercent.

Devoluciones:
Rango de tiempo -

Un objeto TimeRange simulado (siguiendo las especificaciones HTML)

Ver:

bufferedEnd () → {número}
jugador.js , línea 2680

Obtener la hora de finalización del último intervalo de tiempo almacenado en búfer 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

porcentaje de búfer () → {número}
jugador.js , línea 2669

Obtén el porcentaje (como decimal) del vídeo que se ha descargado. Este método no forma parte de la API de vídeo HTML nativa.

Devoluciones:
número -

Un decimal entre 0 y 1 que representa el porcentaje que se almacena en búfer 0 es 0% y 1 es 100%

resumen buildCSSClass () → {cadena}
componente.js , línea 695

Crea el nombre de clase DOM predeterminado. Debe ser anulado por subcomponentes.

Devoluciones:
cadena -

El nombre de clase DOM de este objeto.

Anulaciones:

cancelAnimationFrame (id) → {número}
componente.js , línea 1598

Cancela una devolución de llamada en cola que se ha pasado al componente #requestAnimationFrame (raF).

Si pone en cola una devolución de llamada RAF mediante el componente #requestAnimationFrame, utilice esta función en lugar de Window.cancelAnimationFrame. Si no lo hace, su oyente de desecho no se limpiará hasta el Componente #dispose.

Parámetros:
Nombre Tipo Descripción
id número

El ID de raF que se va a borrar. El valor devuelto del componente #requestAnimationFrame.
Devoluciones:
número -

Devuelve el ID de raF que se ha borrado.

Anulaciones:
Ver:

CanceNamedAnimationFrame(nombre)
componente.js , línea 1573

Cancela un marco de animación con nombre actual si existe.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del RequestAnimationFrame que se va a cancelar.
Anulaciones:

canPlayType (tipo) → {cadena}
jugador.js , línea 3271

Comprueba si el jugador puede jugar un tipo mime determinado

Parámetros:
Nombre Tipo Descripción
tipo cuerda

El tipo mime que se va a comprobar
Devoluciones:
cadena -

'probablemente', 'tal vez' o '' (cadena vacía)

Ver:

niños () → {matriz}
componente.js , línea 386

Obtenga una matriz de todos los componentes secundarios

Devoluciones:
Matriz -

Los niños

Anulaciones:

clearInterval (intervalId) → {número}
componente.js , línea 1477

Borra un intervalo que se crea a través de Window.setInterval o Component #setInterval. Si establece un intervalo mediante el Componente #setInterval, utilice esta función en lugar de Window.clearInterval. Si no lo hace, su oyente no se limpiará hasta el Componente #dispose.

Parámetros:
Nombre Tipo Descripción
Interválido número

ID del intervalo que se va a borrar. El valor devuelto de Component #setInterval o Window.setInterval.

Devoluciones:
número -

Devuelve el identificador de intervalo que se ha borrado.

Anulaciones:
Ver:

clearTimeout (id de tiempo de espera) → {número}
componente.js , línea 1421

Borra un tiempo de espera que se crea a través de Window.setTimeout o Component #setTimeout. Si establece un tiempo de espera mediante el Componente #setTimeout, utilice esta función en lugar de Window.Cleartimout. Si no lo hace, su oyente no se limpiará hasta el Componente #dispose.

Parámetros:
Nombre Tipo Descripción
ID de tiempo de espera número

Identificación del tiempo de espera que se va a borrar. El valor devuelto de Component #setTimeout o Window.setTimeout.

Devoluciones:
número -

Devuelve el identificador de tiempo de espera que se ha borrado.

Anulaciones:
Ver:

contentEl () → {Elemento}
componente.js , línea 355

Devuelve el elemento DOM del componente. Aquí es donde se insertan los niños. Normalmente, será el mismo que el elemento devuelto en el Componente #el.

Devoluciones:
Elemento -

El elemento de contenido de este componente.

Anulaciones:

controles (bool opt ) → {boolean}
jugador.js , línea 3882

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

Parámetros:
Nombre Tipo Atributos Descripción
bool booleano <optional>
  • true para activar los controles - false para desactivar los controles
Fuegos:
Devoluciones:
booleano -

El valor actual de los controles al obtener

crearEl () → {Elemento}
jugador.js , línea 679

Crea el Jugadorelemento DOM de.

Devoluciones:
Elemento -

El elemento DOM que se crea.

Anulaciones:

createModal (contenido, opciones optar ) → { ModalDialog }
jugador.js , línea 4698

Crea un cuadro de diálogo modal simple (una instancia del ModalDialog componente) que inmediatamente superpone al reproductor con contenido arbitrario y se elimina cuando se cierra.

Parámetros:
Nombre Tipo Atributos Descripción
contenido string | function | Elemento | Matriz | null

Igual que ModalDialog # contenidoParámetro del mismo nombre. El uso más sencillo consiste en proporcionar una cadena o un elemento DOM.
opciones Objeto <optional>

Opciones adicionales que se pasarán al ModalDialog.
Devoluciones:
ModalDialog -

el diálogo modalDialog que se creó

crossOrigin ( opción de valor) → {cadena|indefinido}
jugador.js , línea 849

Obtener o configurar el JugadorOpción crossOrigin. Para el reproductor HTML5, esto establece el cruzOrigen propiedad en el < video> etiqueta para controlar el comportamiento de CORS.

Parámetros:
Nombre Tipo Atributos Descripción
valor cuerda <optional>

El valor para establecer el Jugadores crossOrigin to. Si se da un argumento, debe ser uno de anónimo o credenciales de uso.
Devoluciones:
string | undefined -
  • El valor crossOrigin actual del reproductor al obtener. - indefinido al configurar
Ver:

punto de interrupción actual () → {cadena}
jugador.js , línea 4870

Obtenga el nombre del punto de interrupción actual, si lo hubiera.

Devoluciones:
cadena -

Si actualmente hay un punto de interrupción establecido, devuelve la clave del objeto de puntos de interrupción que coincide con él. De lo contrario, devuelve una cadena vacía.

currentBreakpointClass () → {cadena}
player.js , línea 4882

Obtenga el nombre de la clase de punto de interrupción actual.

Devoluciones:
cadena -

El nombre de la clase coincidente (p. Ej. "vjs-layout-tiny" o "vjs-layout-large" ) para el punto de interrupción actual. Cadena vacía si no hay un punto de interrupción actual.

dimensión actual (ancho o alto) → {número}
componente.js , línea 1077

Obtenga la anchura calculada o la altura del elemento del componente.

Utiliza Window.getComputedStyle.

Parámetros:
Nombre Tipo Descripción
Anchura o altura cuerda

Una cadena que contiene 'ancho' o 'alto'. Cualquiera que quieras conseguir.
Devoluciones:
número -

La dimensión que se solicita o 0 si no se ha establecido nada para esa dimensión.

Anulaciones:

currentDimensions () → { Componente ~ DimensionObject }
componente.js , línea 1123

Obtenga un objeto que contenga valores de anchura y altura calculados del elemento del componente.

Utiliza Window.getComputedStyle.

Devoluciones:
Componente~DimensionObject-

Las dimensiones calculadas del elemento del componente.

Anulaciones:

altura actual () → {número}
componente.js , línea 1150

Obtenga la altura calculada del elemento del componente.

Utiliza Window.getComputedStyle.

Devoluciones:
número -

Altura calculada del elemento del componente.

Anulaciones:

FuenteActual () → { Tecnología~ObjetoFuente }
jugador.js , línea 3659

Devuelve el objeto fuente actual.

Devoluciones:
Tech~SourceObject-

El objeto de origen actual

FuentesActuales () → {Array.< Tech~SourceObject> }
jugador.js , línea 3641

Devuelve todos los objetos de origen actuales.

Devoluciones:
Formación.<Tech ~ SourceObject> -

Los objetos de origen actuales

currentSrc () → {cadena}
jugador.js , línea 3670

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

Devoluciones:
cadena -

La fuente actual

horaActual (segundos opt ) → {número}
jugador.js , línea 2529

Obtener o configurar la hora actual (en segundos)

Parámetros:
Nombre Tipo Atributos Descripción
segundos number | string <optional>

El momento de intentarlo en segundos
Devoluciones:
número -
  • la hora actual en segundos al obtener

currentType () → {cadena}
jugador.js , línea 3682

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:
cadena -

El tipo MIME de origen

anchoActual () → {número}
componente.js , línea 1138

Obtenga el ancho calculado del elemento del componente.

Utiliza Window.getComputedStyle.

Devoluciones:
número -

Ancho calculado del elemento del componente.

Anulaciones:

depurar(activado)
player.js , línea 5097

Configure el modo de depuración para habilitar / deshabilitar registros en el nivel de información.

Parámetros:
Nombre Tipo Descripción
habilitado booleano
Fuegos:
  • Evento número de jugador: depuración
  • Jugador # evento: debugoff

silenciado por defecto ( opción silenciada por defecto) → {boolean| jugador }
jugador.js , línea 2770

Obtenga el estado defaultMuted actual o active o desactive defaultMuted. defaultMuted indica el estado de silenciado en la reproducción inicial.

var myPlayer = videojs('algún ID de jugador');

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

  // obtener, debe ser falso
  console.log(myPlayer.defaultMuted());
  // establecido en verdadero
  miJugador.predeterminadoSilenciado(verdadero);
  // obtener debe ser verdadero
  console.log(myPlayer.defaultMuted());
Parámetros:
Nombre Tipo Atributos Descripción
Silenciado predeterminado booleano <optional>
  • verdadero para silenciar - falso para no silenciar
Devoluciones:
booleano | Jugador -
  • verdadero si defaultMuted está activado y obteniendo - falso si defaultMuted está desactivado y obteniendo - Una referencia al jugador actual al configurar

defaultPlaybackRate ( opción de tasa) → {número| jugador }
jugador.js , línea 4287

Obtiene o establece la velocidad de reproducción predeterminada actual. Una tasa de reproducción predeterminada de 1.0 representa la velocidad normal y 0.5 indicaría la reproducción a la mitad de la velocidad, por ejemplo. defaultPlaybackRate solo representará la tasa de reproducción inicial de un video, no la tasa de reproducción actual.

Parámetros:
Nombre Tipo Atributos Descripción
tarifa número <optional>

Nueva velocidad de reproducción predeterminada para establecer.
Devoluciones:
número | Jugador -
  • La velocidad de reproducción predeterminada al obtener o 1.0: el reproductor al configurar
Ver:
  • https://html.spec.whatwg.org/multipage/embedded-content.html#dom-media-defaultplaybackrate

dimensión (dimensión, valor opt ) → {número}
jugador.js , línea 906

Un captador para la anchura y la altura del jugador.

Parámetros:
Nombre Tipo Atributos Descripción
dimensión cuerda

Esta cadena puede ser: - 'ancho' - 'alto'
valor número <optional>

Valor de la dimensión especificada en el primer argumento.
Devoluciones:
número -

El valor de los argumentos de dimensión al obtener (ancho / alto).

Anulaciones:

dimensiones(ancho, alto)
componente.js , línea 980

Establezca tanto el ancho como el alto del Componente elemento al mismo tiempo.

Parámetros:
Nombre Tipo Descripción
anchura number | string

Ancho para establecer el elemento componentes.
altura number | string

Altura en la que se establece el elemento componentes.
Anulaciones:

disablePictureInPicture(valor)
jugador.js , línea 3074

Desactive el modo Imagen en imagen.

Parámetros:
Nombre Tipo Descripción
valor booleano
  • true deshabilitará el modo Picture-in-Picture - false habilitará el modo Picture-in-Picture

disponer()
jugador.js , línea 608

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

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

Fuegos:
Anulaciones:

documentFullscreenChange_()
jugador.js , línea 2111

cuando el evento fschange del documento se activa, llama a esto

duración (segundos opt ) → {número}
jugador.js , línea 2580

Normalmente obtiene la duración del vídeo en segundos; en todos los casos de uso menos raros, un argumento NO se pasará al método.

NOTA: El video debe haber comenzado a cargarse antes de que se pueda conocer la duración y, según el comportamiento de la precarga, es posible que no se sepa hasta que el video comience a reproducirse.

Parámetros:
Nombre Tipo Atributos Descripción
segundos número <optional>

La duración del vídeo que se va a configurar en segundos
Fuegos:
Devoluciones:
número -
  • La duración del vídeo en segundos cuando se obtiene

el () → {Elemento}
componente.js , línea 248

Obtener el elemento DOM del componente

Devoluciones:
Elemento -

El elemento DOM de este componente.

Anulaciones:

Activar actividad de Touch()
componente.js , línea 1320

Esta función informa de la actividad del usuario cada vez que se producen eventos táctiles. Esto puede desactivarse por cualquier subcomponente que quiera que los eventos táctiles actúen de otra manera.

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 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 como touchstart y tocar alternar los controles del reproductor. Así que los eventos táctiles tampoco nos pueden ayudar a nivel de jugador.

La actividad del usuario se comprueba de forma asíncrona. Así que lo que podría suceder es que un evento de toque en el vídeo desactiva los controles. Entonces el tocar evento burbujea hasta el jugador. Lo que, si informaba de la actividad del usuario, volvería a activar los controles. Tampoco queremos bloquear por completo los eventos táctiles para evitar que se burbujeen. Además un tocar evento y cualquier otra cosa que no sea un toque, no debe volver a activar los controles.

Escucha eventos:
  • Componente #event:touchstart
  • Componente #evento:touch move
  • Componente #evento:touchend
  • Componente #evento:touchcancelación
Anulaciones:

terminó () → {Booleano}
jugador.js , línea 5307

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

Devoluciones:
booleano -

True si el jugador está en estado final, falso si no.

enterFullWindow()
jugador.js , línea 3000

Cuando no se admite pantalla completa, podemos extender el contenedor de vídeo a lo más ancho que nos permita el navegador.

Fuegos:

error (err opt ) → { MediaError |null}
jugador.js , línea 3991

Establecer u obtener el MediaError actual

Parámetros:
Nombre Tipo Atributos Descripción
errar mediaError | cadena | número <optional>

MediaError o cadena/número que se convertirá en un MediaError
Fuegos:
Devoluciones:
MediaError | null -

MediaError actual al obtener (o nulo)

salir de pantalla completa()
jugador.js , línea 2940

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

Fuegos:

exitFullWindow()
jugador.js , línea 3047

Salir de la ventana completa

Fuegos:

exitPictureInPicture () → {Promesa}
jugador.js , línea 3137

Salga del modo Picture-in-Picture.

Fuegos:
Devoluciones:
Promesa -

Una promesa.

Ver:

llenar ( opción bool) → {booleano|indefinido}
jugador.js , línea 982

Un getter / setter / toggler para vjs-fill nombre de la clase sobre el Jugador.

Al activarlo, se desactivará el modo de fluido.

Parámetros:
Nombre Tipo Atributos Descripción
bool booleano <optional>
  • Un valor de true agrega la clase. - Un valor de false elimina la clase. - Ningún valor será captador.
Devoluciones:
boolean | undefined -
  • El valor del líquido al conseguir. - indefinido al configurar.

flexNotSupported_ () → {booleano}
jugador.js , línea 5077

Determine si flexbox es compatible o no

Devoluciones:
booleano -
  • verdadero si se admite flexbox - falso si no se admite flexbox

fluido (bool opt ) → {booleano|indefinido}
jugador.js , línea 945

Un captador, configurador/activador para el ClassName vjs-fluid en el reproductor.

Activar esto desactivará el modo de llenado.

Parámetros:
Nombre Tipo Atributos Descripción
bool booleano <optional>
  • Un valor de true agrega la clase. - Un valor de false elimina la clase. - Ningún valor será captador.
Devoluciones:
boolean | undefined -
  • El valor del líquido al conseguir. - indefinido al configurar.

focus()
componente.js , línea 1157

Establezca el foco en este componente

Anulaciones:

fullWindowOnEscKey(evento)
jugador.js , línea 3030

Compruebe si hay llamada para salir de la ventana completa o a pantalla completa en la tecla ESC

Parámetros:
Nombre Tipo Descripción
evento cuerda

Evento para comprobar si hay pulsación de tecla

getAttribute (atributo) → {cadena|null}
componente.js , línea 904

Obtenga el valor de un atributo en el elemento del componente.

Parámetros:
Nombre Tipo Descripción
atributo cuerda

Nombre del atributo del que se obtiene el valor.
Devoluciones:
string | null -
  • El valor del atributo solicitado. - Puede ser una cadena vacía en algunos navegadores si el atributo no existe o no tiene valor - La mayoría de los navegadores devolverán nulo si el atributo no existe o no tiene valor.
Anulaciones:
Ver:

getCache () → {Objeto}
jugador.js , línea 2239

Obtén objeto para valores almacenados en caché.

Devoluciones:
Objeto -

obtener la caché de objetos actual

getChild (nombre) → { Componente |indefinido}
componente.js , línea 412

Devuelve el componente secundario con el nombre de pila.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del componente hijo que se va a obtener.
Devoluciones:
Componente | indefinido -

El componente hijo con el nombre de pila o sin definir.

Anulaciones:

getChildById (id) → { Componente |indefinido}
componente.js , línea 399

Devuelve el componente hijo con el identificador dado.

Parámetros:
Nombre Tipo Descripción
id cuerda

ID del componente secundario que se va a obtener.
Devoluciones:
Componente | indefinido -

El componente hijo con el identificador dado o sin definir.

Anulaciones:

getDescendant (…nombres) → { Componente |indefinido}
componente.js , línea 434

Devuelve el componente descendiente siguiendo los nombres de descendientes givent. Por ejemplo, ['foo', 'bar', 'baz'] intentaría obtener 'foo' en el componente actual, 'bar' en el componente 'foo' y 'baz' en el componente 'bar' y devolvería indefinido si cualquiera de esos no existe.

Parámetros:
Nombre Tipo Atributos Descripción
nombres ... matriz.<cadena> | cuerda <repeatable>

Nombre del componente hijo que se va a obtener.
Devoluciones:
Componente | indefinido -

El componente descendiente que sigue los nombres de descendientes dados o no definido.

Anulaciones:

getMedia () → { Reproductor~MediaObject }
jugador.js , línea 4983

Obtén un clon de la actual Reproductor ~ MediaObject para este jugador.

Si el loadMedia no se ha utilizado, intentará devolver un Reproductor ~ MediaObject basado en el estado actual del jugador.

Devoluciones:
Jugador~Objeto multimedia

getVideoPlaybackQuality () → {Objeto|indefinido}
jugador.js , línea 4583

Obtiene métricas de calidad de reproducción multimedia disponibles según lo especificado en la API de calidad de reproducción multimedia del W3C.

Devoluciones:
Objeto | indefinido -

Objeto con métricas de calidad de reproducción multimedia compatibles o indefinidas si no hay tecnología o si la tecnología no la admite.

Ver:

manejar Hotkeys(evento)
jugador.js , línea 3222

Se llama cuando este jugador recibe un evento de tecla de acceso rápido. Las teclas de acceso rápido admitidas para todo el reproductor son:

f - alternar pantalla completa m - alternar silencio k o espacio - alternar reproducción / pausa

Parámetros:
Nombre Tipo Descripción
evento Objeto del evento~Evento

los keydown evento que hizo que se llamara a esta función.

HandleKeyDown(evento)
jugador.js , línea 3160

Se llama cuando este reproductor tiene el foco y se presiona una tecla, o cuando cualquier componente de este reproductor recibe una pulsación de tecla que no maneja. Esto permite teclas de acceso rápido para todo el reproductor (ya sea como se define a continuación, u opcionalmente por una función externa).

Parámetros:
Nombre Tipo Descripción
evento Objeto del evento~Evento

los keydown evento que hizo que se llamara a esta función.
Escucha eventos:
  • evento:keydown
Anulaciones:

HandleKeypress(evento)
componente.js , línea 1196

Muchos componentes solían tener un handleKeyPress método, que fue mal nombrado porque escuchó un keydown evento. El nombre de este método ahora delega en HandleKeyDown. Esto significa que cualquier persona que llame a HandleKeyPress no verá que las llamadas a sus métodos dejen de funcionar.

Parámetros:
Nombre Tipo Descripción
evento Objeto del evento~Evento

El evento que provocó la llamada a esta función.
Anulaciones:

cambio de idioma del mango abstracto()
componente.js , línea 346

Gestiona el cambio de idioma del reproductor en los componentes. Debe ser anulado por subcomponentes.

Anulaciones:

handleSrc_ (fuente opt , isRetry) → {cadena|indefinido}
jugador.js , línea 3391

Ejecuta la configuración de la fuente y la obtención de lógica

Parámetros:
Nombre Tipo Atributos Descripción
fuente Tech~SourceObject | Array.<tech~SourceObject> | cadena <optional>

SourceObject, una matriz de SourceObjects o una cadena que hace referencia a una URL a un origen multimedia. Se recomienda encarecidamente que se utilice un objeto o una matriz de objetos aquí, para que los algoritmos de selección de fuente puedan tener en cuenta el tipo .

Si no se proporciona, este método actúa como captador.
isRetry booleano

Indica si esto se llama internamente como resultado de un reintento
Devoluciones:
string | undefined -

Si el fuente Falta un argumento, devuelve la URL de origen actual. De lo contrario, no devuelve nada o indefinido.

hasClass (classToCheck) → {booleano}
componente.js , línea 814

Compruebe si el elemento de un componente tiene un nombre de clase CSS.

Parámetros:
Nombre Tipo Descripción
Clase a comprobar cuerda

Nombre de clase CSS para comprobar.
Devoluciones:
booleano -
  • True si el componente tiene la clase. - Falso si el Componente no tiene la clase`
Anulaciones:

hasPlugin (nombre) → {booleano}
jugador.js , línea 5416

Informa si un jugador tiene o no un complemento disponible.

Esto no informa si el complemento se ha inicializado alguna vez en este reproductor. Para eso, usingPlugin.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre de un complemento.
Devoluciones:
booleano -

Si este reproductor tiene o no disponible el complemento solicitado.

hasStarted (solicitud) → {booleano}
jugador.js , línea 1665

Añadir/quitar la clase vjs-has-started

Parámetros:
Nombre Tipo Descripción
solicitud booleano
  • verdadero: agrega la clase - falso: elimina la clase
Fuegos:
Devoluciones:
booleano -

el valor booleano de hasStarted_

altura (valor opt ) → {número}
jugador.js , línea 888

Un captador para la altura del jugador. Devuelve el valor configurado del jugador. Para obtener la altura actual, use altura actual().

Parámetros:
Nombre Tipo Atributos Descripción
valor número <optional>

El valor para establecer el Jugadorde altura a.
Devoluciones:
número -

La altura actual del Jugador al conseguir.

Anulaciones:

hide()
componente.js , línea 865

Oculte el elemento de Componentsi se muestra actualmente añadiéndole el nombre de clase «vjs-hidden'.

Anulaciones:

id () → {cadena}
component.js, línea 365

Obtener el ID de este componente

Devoluciones:
cadena -

El id de este componente

Anulaciones:

Init Niños()
componente.js , línea 592

Agregue e inicialice los componentes secundariospredeterminados en función de las opciones.

Anulaciones:

isAudio (booleano) → {booleano}
jugador.js , línea 4308

Obtiene o establece el indicador de audio

Parámetros:
Nombre Tipo Descripción
bool booleano
  • señales verdaderas de que se trata de un reproductor de audio - señales falsas de que no se trata de un reproductor de audio
Devoluciones:
booleano -

El valor actual de isAudio al obtener

isDisposed () → {booleano}
componente.js , línea 208

Determine si este componente se ha eliminado o no.

Devoluciones:
booleano -

Si el componente se ha eliminado, será cierto. De lo contrario, falso.

Anulaciones:

isFullscreen (isFS opt ) → {booleano}
jugador.js , línea 2825

Comprueba si el reproductor está en modo de pantalla completa o dígale al reproductor que está o no en modo de 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:
Nombre Tipo Atributos Descripción
ISF booleano <optional>

Establecer el estado actual de pantalla completa de los jugadores
Devoluciones:
booleano -
  • verdadero si la pantalla completa está activada y en curso - falso si la pantalla completa está desactivada y en curso

isInPictureInPicture (isPiP opt ) → {booleano}
jugador.js , línea 3094

Compruebe si el reproductor está en modo Imagen en imagen o dígale que está o no en modo Imagen en imagen.

Parámetros:
Nombre Tipo Atributos Descripción
isPiP booleano <optional>

Establecer el estado actual de imagen en imagen de los jugadores
Devoluciones:
booleano -
  • verdadero si Picture-in-Picture está encendido y encendido - false si Picture-in-Picture está apagado y encendido

idioma (código opt ) → {cadena}
jugador.js , línea 4624

El código de idioma del jugador.

Cambiar el idioma activará el cambio de idioma que los componentes pueden usar para actualizar el texto de control. ClickableComponent actualizará su texto de control de forma predeterminada en cambio de idioma.

Parámetros:
Nombre Tipo Atributos Descripción
código cuerda <optional>

el código de idioma para configurar el reproductor
Fuegos:
Devoluciones:
cadena -

El código de idioma actual al obtener

idiomas () → {Array}
jugador.js , línea 4653

Obtenga el diccionario de idiomas del reproductor Combinar cada vez, porque un plugin recién agregado podría llamar a Videojs.addLanguage () en cualquier momento Los idiomas especificados directamente en las opciones del reproductor tienen prioridad

Devoluciones:
Matriz -

Una variedad de idiomas compatibles

load()
jugador.js , línea 3557

Comience a cargar los datos src.

loadMedia(medio, listo)
jugador.js , línea 4940

Complete el reproductor con un MediaObject.

Parámetros:
Nombre Tipo Descripción
medios de comunicación Jugador~Objeto multimedia

Un objeto mediático.
listo función

Una devolución de llamada que se llamará cuando el jugador esté listo.

localizar (cadena, tokens opt , defaultValue opt ) → {cadena}
componente.js , línea 309

Localiza una cadena dada la cadena en inglés.

Si se proporcionan tokens, intentará ejecutar un simple reemplazo de tokens en la cadena proporcionada. Los tokens que busca se parecen a {1} con el índice indexado en 1 en la matriz de tokens.

Si un valor por defecto se proporciona, lo usará sobre cuerda , si no se encuentra un valor en los archivos de idioma proporcionados. Esto es útil si desea tener una clave descriptiva para el reemplazo de tokens pero tener una cadena localizada sucinta y no requiere que se incluya en.json.

Actualmente, se utiliza para la sincronización de la barra de progreso.

{
  "tiempo de la barra de progreso: hora actual = {1} duración = {2}": "{1} de {2}"
}

Luego se usa así:

this.localize('tiempo de la barra de progreso: horaActual={1} duración{2}',
              [este.jugador_.tiempoActual(), este.jugador_.duración()],
              '{1 de 2}');

Lo que produce algo así como: 01:23 de 24:56.

Parámetros:
Nombre Tipo Atributos Descripción
cuerda cuerda

La cadena que se va a localizar y la clave para buscar en los archivos de idioma.
fichas Matriz.<cadena> <optional>

Si el artículo actual tiene reemplazos de tokens, proporcione los tokens aquí.
Valor predeterminado cuerda <optional>

El valor predeterminado es string. Puede ser un valor predeterminado que se debe utilizar para la sustitución de tokens si es necesario que la clave de búsqueda sea independiente.
Devoluciones:
cadena -

La cadena localizada o, si no existe ninguna localización, la cadena inglesa.

Anulaciones:

bucle ( opción de valor) → {booleano}
jugador.js , línea 3791

Obtén o establece el atributo loop en el elemento vídeo.

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano <optional>
  • verdadero significa que debemos repetir el video - falso significa que no debemos repetir el video
Devoluciones:
booleano -

El valor actual del bucle al obtener

manualAutoplay_()
jugador.js , línea 1448

Maneje los valores de cadena de reproducción automática, en lugar de los valores booleanos típicos que deberían ser manejados por el técnico. Tenga en cuenta que esto no forma parte de ninguna especificación. Los valores válidos y lo que hacen se pueden encontrar en el getter de reproducción automática en Player # autoplay ()

silenciado ( opción silenciada) → {booleano}
jugador.js , línea 2736

Obtener el estado silenciado actual o activar o desactivar el silencio

Parámetros:
Nombre Tipo Atributos Descripción
silenciado booleano <optional>
  • verdadero para silenciar - falso para no silenciar
Devoluciones:
booleano -
  • verdadero si el silencio está activado y en funcionamiento - falso si el silencio está desactivado y en funcionamiento

nombre () → {cadena}
componente.js , línea 376

Obtenga el nombre del componente. El nombre se utiliza para hacer referencia al componente y se establece durante el registro.

Devoluciones:
cadena -

Nombre de este componente.

Anulaciones:

estado de la red () → {número}
jugador.js , línea 5329

Devuelve el estado actual de la actividad de red del elemento, de los códigos de la lista siguiente.

  • NETWORK_EMPTY (valor numérico 0) El elemento aún no se ha inicializado. Todos los atributos se encuentran en sus estados iniciales.
  • NETWORK_IDLE (valor numérico 1) El algoritmo de selección de recursos del elemento está activo y ha seleccionado un recurso, pero en realidad no utiliza la red en este momento.
  • NETWORK_LOADING (valor numérico 2) El agente de usuario está intentando descargar datos activamente.
  • NETWORK_NO_SOURCE (valor numérico 3) El algoritmo de selección de recursos del elemento está activo, pero aún no ha encontrado ningún recurso que utilizar.
Devoluciones:
número -

el estado actual de la actividad de red

Ver:

opciones (obj) → {Objeto}
componente.js , línea 233

Fusión profunda de objetos de opciones con nuevas opciones.

Nota: Cuando tanto obj como opciones contienen propiedades cuyos valores son objetos. Las dos propiedades se fusionan mediante Module:MergeOptions

Parámetros:
Nombre Tipo Descripción
obj Objeto

Objeto que contiene nuevas opciones.
Devoluciones:
Objeto -

Un nuevo objeto de esto.options_ y obj se fusionaron.

Anulaciones:

pausa () → { Jugador }
jugador.js , línea 2467

Pausa la reproducción de vídeo

Devoluciones:
Jugador-

Referencia al objeto reproductor en el que se ha llamado esta función.

en pausa () → {booleano}
jugador.js , línea 2478

Comprueba si el reproductor está en pausa o aún no ha jugado

Devoluciones:
booleano -
  • falso: si el medio se está reproduciendo actualmente - verdadero: si el medio no se está reproduciendo actualmente

jugar () → {Promesa|indefinido}
jugador.js , línea 2366

Intente comenzar la reproducción a la primera oportunidad.

Devoluciones:
Promesa | indefinido -

Devuelve una promesa si el navegador admite Promesas (o se pasó una como una opción). Esta promesa se resolverá sobre el valor de retorno del juego. Si esto no está definido, cumplirá la cadena de promesas; de lo contrario, la cadena de promesas se cumplirá cuando se cumpla la promesa del juego.

tasa de reproducción ( opción de tasa) → {número}
jugador.js , línea 4258

Obtiene o establece la velocidad de reproducción actual. Una velocidad de reproducción de 1,0 representa la velocidad normal y 0,5 indica reproducción a media velocidad, por ejemplo.

Parámetros:
Nombre Tipo Atributos Descripción
tarifa número <optional>

Nueva velocidad de reproducción que se va a establecer.
Devoluciones:
número -

La velocidad de reproducción actual al obtener o 1,0

Ver:

tasas de reproducción (tasas nuevas) → {Array.< número> }
jugador.js , línea 5127

Establezca u obtenga las tasas de reproducción actuales. Toma una matriz y actualiza el menú de tasas de reproducción con los nuevos elementos. Pase una matriz vacía para ocultar el menú. Los valores que no sean matrices se ignoran.

Parámetros:
Nombre Tipo Descripción
nuevoTarifas Formación.< número>

Las nuevas tasas a las que debería actualizarse el menú de tasas de reproducción. Una matriz vacía ocultará el menú.
Fuegos:
Devoluciones:
Formación.< número> -

Cuando se usa como captador, devolverá las tasas de reproducción actuales

jugado () → {Rango de tiempo}
jugador.js , línea 2491

Obtenga un objeto TimeRange que represente los rangos de tiempo actuales que ha jugado el usuario.

Devoluciones:
Rango de tiempo -

Objeto de rango de tiempo que representa todos los incrementos de tiempo que se han jugado.

jugador () → { Jugador }
componente.js , línea 218

Devuelve el Jugador que el Componente se ha adjuntado a.

Devoluciones:
Jugador-

El jugador que este Componente se ha adjuntado a.

Anulaciones:

juegaen línea (valor opt ) → {string| jugador }
jugador.js , línea 3772

Establece o desestablece el atributo playsinline. Playsinline indica al navegador que se prefiere la reproducción que no sea a pantalla completa.

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano <optional>
  • verdadero significa que debemos intentar jugar en línea de manera predeterminada; falso significa que debemos usar el modo de reproducción predeterminado del navegador, que en la mayoría de los casos es en línea. iOS Safari es una excepción notable y se reproduce a pantalla completa de forma predeterminada.
Devoluciones:
cuerda | Jugador -
  • el valor actual de playsinline - el jugador al configurar
Ver:

cartel (src opt ) → {cadena}
jugador.js , línea 3811

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

Parámetros:
Nombre Tipo Atributos Descripción
src cuerda <optional>

URL fuente de imagen de póster
Fuegos:
Devoluciones:
cadena -

El valor actual del póster al obtener

precarga (valor opt ) → {cadena}
jugador.js , línea 3696

Obtener o configurar el atributo de precarga

Parámetros:
Nombre Tipo Atributos Descripción
valor booleano <optional>
  • verdadero significa que debemos precargar - falso significa que no debemos precargar
Devoluciones:
cadena -

El valor del atributo de precarga al obtener

listo () → { Componente }
componente.js , línea 709

Enlazar 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.

Devoluciones:
Componente-

Devuelve por sí mismo; el método se puede encadenar.

Anulaciones:

readyState () → {número}
jugador.js , línea 5350

Devuelve un valor que expresa el estado actual del elemento con respecto a la representación de la posición de reproducción actual, a partir de los códigos de la lista siguiente.

  • HAVE_NOTHING (valor numérico 0) No hay información disponible sobre el recurso multimedia.
  • HAVE_METADATA (valor numérico 1) Se ha obtenido lo suficiente del recurso para que esté disponible la duración del recurso.
  • HAVE_CURRENT_DATA (valor numérico 2) Los datos de la posición de reproducción actual inmediata están disponibles.
  • HAVE_FUTURE_DATA (valor numérico 3) Los datos de la posición de reproducción actual inmediata están disponibles, así como datos suficientes para que el agente de usuario avance la posición de reproducción actual en la dirección de reproducción.
  • HAVE_ENOUGH_DATA (valor numérico 4) El agente de usuario estima que hay suficientes datos disponibles para que la reproducción continúe sin interrupciones.
Devoluciones:
número -

el estado actual de representación de reproducción

Ver:

tiempo restante () → {número}
jugador.js , línea 2623

Calcula cuánto tiempo queda en el vídeo. No forma parte de la API de vídeo nativa.

Devoluciones:
número -

El tiempo restante en segundos

visualización de tiempo restante () → {número}
jugador.js , línea 2634

Una función de tiempo restante que está destinada a utilizarse cuando el tiempo se va a mostrar directamente al usuario.

Devoluciones:
número -

El tiempo redondeado restante en segundos

remoteTextTrackEls () → { HtmlTrackElementList }
jugador.js , línea 5194

Obtener el control remoto HtmlTrackElementList pistas.

Devoluciones:
HtmlTrackElementList -

La lista de elementos de la pista de texto remota actual

Pistas de texto remotas () → { Lista de pistas de texto }
jugador.js , línea 5185

Obtener el control remoto TextTrackList

Devoluciones:
Lista de canciones de texto-

La lista de pistas de texto remoto actual

removeAttribute(atributo)
componente.js , línea 931

Elimina un atributo del elemento del componente.

Parámetros:
Nombre Tipo Descripción
atributo cuerda

Nombre del atributo que se va a quitar.
Anulaciones:
Ver:

RemoveChild(componente)
componente.js , línea 553

Quitar a un niño Componente de esto Componentes lista de niños. Elimina también el elemento secundario del componentes de este elemento componente.

Parámetros:
Nombre Tipo Descripción
componente Componente

El componente secundario que se va a quitar.
Anulaciones:

Quitar clase(clase para quitar)
componente.js , línea 834

Elimina un nombre de clase CSS del elemento Component.

Parámetros:
Nombre Tipo Descripción
Clase que se eliminará cuerda

Nombre de clase CSS que se va a quitar
Anulaciones:

removeRemoteTextTrack (pista) → {indefinido}
jugador.js , línea 4558

Quitar un control remoto TextTrack desde el respectivo TextTrackList y HtmlTrackElementList.

Parámetros:
Nombre Tipo Descripción
pista Objeto

TextTrack remoto para eliminar
Devoluciones:
indefinido -

no devuelve nada

reportUserActivity(evento)
jugador.js , línea 4067

Informar de actividad del usuario

Parámetros:
Nombre Tipo Descripción
evento Objeto

Objeto de evento

requestAnimationFrame (fn) → {número}
componente.js , línea 1511

Hace cola una devolución de llamada para pasar a RequestAnimationFrame (raF), pero con algunas bonificaciones adicionales:

  • Admite navegadores que no admiten raF al volver al Componente #setTimeout.

  • La devolución de llamada se convierte en un componente ~ GenericCallback (es decir, enlazado al componente).

  • La cancelación automática de la devolución de llamada raF se gestiona si el componente se elimina antes de llamarlo.

Parámetros:
Nombre Tipo Descripción
fn Componente~Devolución de llamada genérica

Función que se enlazará a este componente y se ejecutará justo antes de volver a pintar el navegador.
Escucha eventos:
Devoluciones:
número -

Devuelve un ID de raF que se utiliza para identificar el tiempo de espera. También se puede utilizar en el componente #cancelAnimationFrame para cancelar la devolución de llamada del marco de animación.

Anulaciones:
Ver:

requestFullscreen(opciones de pantalla completaoptar)
jugador.js , línea 2862

Aumentar el tamaño del vídeo a pantalla completa En algunos navegadores, la pantalla completa no es compatible de forma nativa, por lo que entra en «modo de ventana completa», donde el vídeo 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.

Parámetros:
Nombre Tipo Atributos Descripción
opciones de pantalla completa Objeto <optional>

Anular las opciones de pantalla completa del reproductor
Fuegos:

Solicitud NamedAnimationFrame(nombre, fn)
componente.js , línea 1547

Solicite un marco de animación, pero solo se pondrá en cola un marco de animación con nombre. Nunca se añadirá otro hasta que termine el anterior.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

El nombre que se va a asignar a este RequestAnimationFrame
fn Componente~Devolución de llamada genérica

Función que se enlazará a este componente y se ejecutará justo antes de volver a pintar el navegador.
Anulaciones:

requestPictureInPicture () → {Promesa}
jugador.js , línea 3115

Cree una ventana de vídeo flotante siempre encima de otras ventanas para que los usuarios sigan consumiendo contenido multimedia mientras interactúan con otros sitios de contenido o aplicaciones de su dispositivo.

Fuegos:
Devoluciones:
Promesa -

Una promesa con una ventana de imagen en imagen.

Ver:

reset()
jugador.js , línea 3566

Restablece el reproductor. Carga la primera tecnología en el techOrder, elimina todas las pistas de texto en el tecnico y llama Reiniciar sobre el tecnico.

resetControlBarUI_()
jugador.js , línea 3596

Restablezca la interfaz de usuario de la barra de control llamando a los submétodos que restablecen todos los componentes de la barra de control

resetPlaybackRate_()
jugador.js , línea 3622

Restablecer la relación de reproducción

resetProgressBar_()
jugador.js , línea 3605

Restablecer el progreso de la tecnología para que la barra de progreso se restablezca en la interfaz de usuario

resetVolumeBar_()
jugador.js , línea 3630

Restablecer barra de volumen

sensible (valor) → {booleano}
jugador.js , línea 4830

Obtenga o establezca una bandera que indique si este jugador debe ajustar su interfaz de usuario en función de sus dimensiones.

Parámetros:
Nombre Tipo Descripción
valor booleano

Debiera ser cierto si el jugador debe ajustar su interfaz de usuario en función de sus dimensiones; de lo contrario, debería ser falso.
Devoluciones:
booleano -

Estarán cierto si este reproductor debe ajustar su interfaz de usuario en función de sus dimensiones; de lo contrario, será falso.

runPlayCallbacks_(val)
jugador.js , línea 2449

Cuando se retrasa una devolución de llamada para reproducir, tenemos que ejecutar estas devoluciones de llamada cuando la tecnología realmente solicita el juego. Esta función ejecuta las devoluciones de llamada que se retrasaron y acepta el valor de retorno del técnico.

Parámetros:
Nombre Tipo Descripción
val indefinido | Promesa

El valor de retorno de la tecnología.

runPlayTerminatedQueue_()
player.js , línea 2430

Estas funciones se ejecutarán cuando finalice la reproducción. Si se ejecuta play runPlayCallbacks_, esta función no se ejecutará. Esto nos permite diferenciar entre una jugada terminada y una llamada a jugar real.

depuración (isScrubbing opt ) → {boolean}
jugador.js , línea 2506

Devuelve si el usuario está «limpiando» o no. La limpieza se produce cuando el usuario ha hecho clic en el controlador de la barra de progreso y lo arrastra a lo largo de la barra de progreso.

Parámetros:
Nombre Tipo Atributos Descripción
se está fregando booleano <optional>

si el usuario está fregando o no
Devoluciones:
booleano -

El valor de fregar al obtener

buscable () → {Rangos de tiempo}
jugador.js , línea 5321

Devuelve los timeRanges de los medios que están disponibles actualmente para buscar.

Devoluciones:
TimeRanges -

los intervalos de búsqueda de la cronología de los medios

buscando () → {Booleano}
jugador.js , línea 5314

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

Devoluciones:
booleano -

True si el jugador está en estado de búsqueda, falso si no.

selectSource (fuentes) → {Objeto|booleano}
jugador.js , línea 3315

Seleccionar fuente según el orden técnico o el orden de origen Utiliza la selección del orden de origen si las opciones.SourceOrder es veraz. De lo contrario, se establece por defecto la selección de pedidos técnicos

Parámetros:
Nombre Tipo Descripción
fuentes Matriz

Fuentes de un activo multimedia
Devoluciones:
Objeto | booleano -

Objeto de origen y orden tecnológico o falso

setAttribute(atributo, valor)
componente.js , línea 919

Establecer el valor de un atributo en el Componenteelemento de

Parámetros:
Nombre Tipo Descripción
atributo cuerda

Nombre del atributo que se va a establecer.
valor cuerda

Valor en el que establecer el atributo.
Anulaciones:
Ver:

setInterval (fn, intervalo) → {número}
componente.js , línea 1450

Crea una función que se ejecuta cada x milisegundos. Esta función es un envoltorio alrededor de Window.setInterval. Sin embargo, hay algunas razones para usar este.

  1. Se borra a través de Componente # clearInterval cuando Componente # desechar se llama.
  2. La devolución de llamada de la función será un componente ~ GenericCallback
Parámetros:
Nombre Tipo Descripción
fn Componente~Devolución de llamada genérica

Función que se ejecuta cada x segundos.
intervalo número

Ejecute la función especificada cada x milisegundos.
Escucha eventos:
Devoluciones:
número -

Devuelve un id que se puede utilizar para identificar el intervalo. También se puede utilizar en el componente #clearInterval para borrar el intervalo.

Anulaciones:
Ver:

setTimeout (fn, tiempo de espera) → {número}
componente.js , línea 1385

Crea una función que se ejecuta tras un tiempo de espera de x milisegundos. Esta función es un envoltorio alrededor de Window.setTimeout. Sin embargo, hay algunas razones para usar este:

  1. Se borra a través de Componente # clearTimeout cuando Componente # desechar se llama.
  2. La devolución de llamada de la función se convertirá en un componente ~ GenericCallback

Nota: No puedes usar Window.CleartimeOut en el id devuelto por esta función. Esto hará que su oyente de desecho no se limpie. Utilice el componente #clearTimeout o el componente #dispose en su lugar.

Parámetros:
Nombre Tipo Descripción
fn Componente~Devolución de llamada genérica

Función que se ejecutará tras el tiempo de espera.
tiempo de espera número

Tiempo de espera en milisegundos para retrasar antes de ejecutar la función especificada.
Escucha eventos:
Devoluciones:
número -

Devuelve un identificador de tiempo de espera que se utiliza para identificar el tiempo de espera. También se puede utilizar en el componente #clearTimeout para borrar el tiempo de espera establecido.

Anulaciones:
Ver:

show()
componente.js , línea 857

Muestre el elemento Component si está oculto eliminando el nombre de clase 'vjs-hidden'.

Anulaciones:

src (fuente opt ) → {cadena|indefinido}
jugador.js , línea 3500

Obtenga o configure la fuente de video.

Parámetros:
Nombre Tipo Atributos Descripción
fuente Tech~SourceObject | Array.<tech~SourceObject> | cadena <optional>

SourceObject, una matriz de SourceObjects o una cadena que hace referencia a una URL a un origen multimedia. Se recomienda encarecidamente que se utilice un objeto o una matriz de objetos aquí, para que los algoritmos de selección de fuente puedan tener en cuenta el tipo .

Si no se proporciona, este método actúa como captador.
Devoluciones:
string | undefined -

Si el fuente Falta un argumento, devuelve la URL de origen actual. De lo contrario, no devuelve nada o indefinido.

admite pantalla completa () → {booleano}
jugador.js , línea 2806

Compruebe si la tecnología actual puede admitir la pantalla completa nativa (por ejemplo, con controles integrados como iOS)

Devoluciones:
booleano -

si se admite pantalla completa nativa

tecnología ( opción de seguridad) → { Tecnología }
jugador.js , línea 1311

Devuelve una referencia a la actual Tecnología. Imprimirá una advertencia de forma predeterminada sobre el peligro de usar la tecnología directamente, pero cualquier argumento que se transmita silenciará la advertencia.

Parámetros:
Nombre Tipo Atributos Descripción
seguridad * <optional>

Cualquier cosa pasó para silenciar la advertencia.
Devoluciones:
Tecnología -

La tecnología

Pistas de texto () → { Lista de pistas de texto }
jugador.js , línea 5174

Obtener la lista de canciones de texto

Devoluciones:
Lista de canciones de texto-

la lista de pistas de texto actual

ToggleClass(ClassToggle,opt predicado)
componente.js , línea 849

Añada o elimine un nombre de clase CSS del elemento del componente.

Parámetros:
Nombre Tipo Atributos Descripción
Clase para alternar cuerda

La clase que se va a agregar o eliminar según (@link Component #hasClass}
predicado boolean | DOM~Predicado <optional>

Una función de predicado DOM~o booleano
Anulaciones:

toJSON () → {Objeto}
jugador.js , línea 4664

devuelve un objeto JavaScript que representa la información de pista actual. no lo devuelve como JSON

Devoluciones:
Objeto -

Objeto que representa la información actual de la pista

Listo para activadores()
componente.js , línea 733

Activa todos los oyentes listeners para este componente.

Fuegos:
Anulaciones:

updateSourceCaches_(srcObj)
jugador.js , línea 1517

Actualice las cachés de fuentes internas para que devolvamos la fuente correcta de src () , fuente actual() , y currentSources ().

Nota: currentSources no se actualizará si la fuente que se pasa existe en el actual currentSources cache.

Parámetros:
Nombre Tipo Descripción
Sr.COBJ Tech~SourceObject

Una cadena o fuente de objeto para actualizar nuestros cachés.

userActive ( opción booleana) → {booleana}
jugador.js , línea 4084

Obtener/establecer si el usuario está activo

Parámetros:
Nombre Tipo Atributos Descripción
bool booleano <optional>
  • verdadero si el usuario está activo - falso si el usuario está inactivo
Fuegos:
Devoluciones:
booleano -

El valor actual de userActive al obtener

usandoNativeControls (bool opt ) → {boolean}
jugador.js , línea 3942

Activa y desactiva los controles nativos. Los controles nativos son los controles integrados en los dispositivos (por ejemplo, controles predeterminados de iPhone) u otras tecnologías (por ejemplo, Vimeo Controls) Esto solo debe ser establecido por la tecnología actual, porque solo la tecnología sabe si puede admitir controles nativos

Parámetros:
Nombre Tipo Atributos Descripción
bool booleano <optional>
  • true para activar los controles nativos - false para desactivar los controles nativos
Fuegos:
Devoluciones:
booleano -

El valor actual de los controles nativos al obtener

usandoPlugin (nombre) → {booleano}
jugador.js , línea 5430

Informa si un jugador está usando un complemento por su nombre.

Para complementos básicos, esto solo informa si el complemento se ha inicializado alguna vez en este reproductor.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre de un complemento.
Devoluciones:
booleano -

Si este reproductor está usando el complemento solicitado o no.

videoHeight () → {número}
jugador.js , línea 4603

Obtener altura de vídeo

Devoluciones:
número -

altura de vídeo actual

Pistas de vídeo () → { Lista de Pistas de Vídeo }
jugador.js , línea 5154

Obtenga la lista de seguimiento de vídeo

Devoluciones:
VideoTrackList -

lista de pistas de vídeo actual

videoWidth () → {número}
jugador.js , línea 4593

Obtener ancho de vídeo

Devoluciones:
número -

ancho de vídeo actual

volumen (percentAsDecimal opt ) → {número}
jugador.js , línea 2704

Obtener o configurar el volumen actual de los medios

Parámetros:
Nombre Tipo Atributos Descripción
Porcentaje como decimal número <optional>

El nuevo volumen como porcentaje decimal: - 0 es silenciado/0 %/apagado - 1,0 es 100 %/lleno - 0,5 es la mitad del volumen o 50 %
Devoluciones:
número -

El volumen actual como porcentaje al obtener

ancho (valor opt ) → {número}
jugador.js , línea 874

Un getter / setter para el Jugadorde ancho. Devuelve el valor configurado del jugador. Para obtener el ancho actual, use currentWidth ().

Parámetros:
Nombre Tipo Atributos Descripción
valor número <optional>

El valor para establecer el Jugadorde ancho a.
Devoluciones:
número -

El ancho actual de la Jugador al conseguir.

Anulaciones:

Definiciones de tipo

Objeto multimedia
jugador.js , línea 4886

Objeto que describe un solo medio.

Se conservarán las propiedades que no formen parte de esta descripción de tipo; por lo tanto, esto también puede verse como un mecanismo genérico de almacenamiento de metadatos.

Propiedades:
Nombre Tipo Atributos Descripción
álbum cuerda <optional>

Sin usar, excepto si este objeto se pasa al MediaSession API.
artista cuerda <optional>

Sin usar, excepto si este objeto se pasa al MediaSession API.
obra de arte Matriz.<Objeto> <optional>

Sin usar, excepto si este objeto se pasa al MediaSession API. Si no se especifica, se completará a través del póster , si está disponible.
póster cuerda <optional>

URL a una imagen que se mostrará antes de la reproducción.
src Tech~SourceObject | Array.<tech~SourceObject> | cadena <optional>

Un único objeto de origen, una matriz de objetos de origen o una cadena que hace referencia a una URL a una fuente de medios. Se recomienda encarecidamente que se utilice un objeto o una matriz de objetos aquí, para que los algoritmos de selección de fuente puedan tener en cuenta el tipo .
título cuerda <optional>

Sin usar, excepto si este objeto se pasa al MediaSession API.
Pistas de texto Matriz.<Objeto> <optional>

Una matriz de objetos que se utilizarán para crear pistas de texto, siguiendo el formato de elemento de pista nativo . Para facilitar la eliminación, estos se crearán como pistas de texto "remotas" y se configurarán para que se limpien automáticamente en los cambios de fuente.

Estos objetos pueden tener propiedades como `src`, `kind`, `label`,
      y `idioma`, consulte Tech#createRemoteTextTrack .
Ver:
  • https://wicg.github.io/mediasession/#the-mediametadata-interface

Eventos

antes de la configuración del plugin: $name
plugin.js , línea 488

Señala que un complemento está a punto de configurarse en un reproductor, por su nombre. El nombre es el nombre del complemento.

Tipo:

abortar
jugador.js , línea 77

Se activa cuando se cancela la carga de un audio/vídeo.

Tipo:

antes de configurar el plugin
plugin.js , línea 481

Señala que un complemento está a punto de configurarse en un reproductor.

Tipo:

puede jugar
jugador.js , línea 1776

El medio tiene un estado ReadyState de HAVE_FUTURE_DATA o superior.

Tipo:

puede jugar
jugador.js , línea 1794

El medio tiene un estado ReadyState de HAVE_ENOUGH_DATA o superior. Esto significa que se puede reproducir todo el archivo multimedia sin almacenamiento en búfer.

Tipo:

tamaño de componente
componente.js , línea 1032

Se activa cuando se cambia el tamaño de un componente.

Tipo:
Anulaciones:

controles desactivados
jugador.js , línea 3914

Tipo:

controles habilitados
jugador.js , línea 3903

Tipo:

desechar
jugador.js , línea 609

Se llama cuando se está eliminando al jugador.

Tipo:
Oyentes de este evento:
Anulaciones:

cambio de duración
jugador.js , línea 2607

Tipo:
Oyentes de este evento:

vaciado
jugador.js , línea 109

Se activa cuando la lista de reproducción actual está vacía.

Tipo:

terminó
jugador.js , línea 1925

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

Tipo:
Oyentes de este evento:

Ingresar ventana completa
jugador.js , línea 3016

Tipo:

introducir imagen en imagen
jugador.js , línea 3117

Este evento se activa cuando el jugador ingresa a la imagen en el modo de imagen.

Tipo:
Oyentes de este evento:

error
jugador.js , línea 4049

Tipo:

Salir de la ventana completa
jugador.js , línea 3060

Tipo:

primera jugada
jugador.js , línea 1877

Se disparó la primera vez que se reproduce un vídeo. No forma parte de la especificación de HLS, y probablemente no sea la mejor implementación hasta el momento, así que úsalo con moderación. Si no tienes motivos para impedir la reproducción, usa MyPlayer.ONE («play»); en su lugar.

Tipo:
En desuso:
  • A partir de la versión 6.0, el evento firstplay está obsoleto.

cambio de pantalla completa
jugador.js , línea 2835

Tipo:
Oyentes de este evento:

cambio de idioma
jugador.js , línea 4634

se dispara cuando el idioma del jugador cambia

Tipo:

dejar foto en imagen
jugador.js , línea 3139

Este evento se activa cuando el jugador deja la imagen en el modo de imagen.

Tipo:
Oyentes de este evento:

datos cargados
jugador.js , línea 156

Se activa cuando el navegador ha cargado el fotograma actual del audio/vídeo.

Tipo:
  • evento

datos cargados
jugador.js , línea 5393

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

Tipo:

metadatos cargados
jugador.js , línea 140

Se activa cuando el navegador ha cargado metadatos para el audio/vídeo.

Tipo:
Oyentes de este evento:

metadatos cargados
jugador.js , línea 5386

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

Tipo:

inicio de carga
jugador.js , línea 1423

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

Tipo:
Oyentes de este evento:

pausa
jugador.js , línea 1899

Disparado cada vez que los medios han estado en pausa

Tipo:
Oyentes de este evento:

jugar
jugador.js , línea 1700

Se activa cada vez que un Tech # jugar Sucede el evento. Indica que la reproducción se ha iniciado o reanudado.

Tipo:
Oyentes de este evento:

cambio de tasas de reproducción
jugador.js , línea 5144

se dispara cuando se cambian las tasas de reproducción en un reproductor

Tipo:
Oyentes de este evento:

redimensionar el jugador
resize-manager.js , línea 108

Llamado cuando el tamaño del jugador ha cambiado

Tipo:

jugando
jugador.js , línea 1813

El contenido multimedia ya no está bloqueado para la reproducción y ha comenzado a reproducirse.

Tipo:

configuración de complementos
plugin.js , línea 496

Señala que se acaba de configurar un complemento en un reproductor.

Tipo:

cambio de póster
jugador.js , línea 3835

Este evento se activa cuando se cambia la imagen del póster en el reproductor.

Tipo:
Oyentes de este evento:

progreso
jugador.js , línea 61

Se activa mientras el agente de usuario descarga datos multimedia.

Tipo:
Oyentes de este evento:

cambio de tarifas
jugador.js , línea 1727

Se activa cuando se cambia la velocidad de reproducción del audio/vídeo

Tipo:
  • evento
Oyentes de este evento:

listo
componente.js , línea 750

Se activa cuando un componente está listo.

Tipo:
Anulaciones:

cambiar tamaño
jugador.js , línea 188

Se activa cuando cambian las dimensiones intrínsecas del video

Tipo:
  • evento

buscado
jugador.js , línea 1850

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

Tipo:
Oyentes de este evento:

buscando
jugador.js , línea 1831

Disparado cada vez que el jugador salta a una nueva hora

Tipo:

conjunto de fuentes
jugador.js , línea 1569

EXPERIMENTAL Se activa cuando la fuente se configura o cambia en el Tech , lo que hace que el elemento multimedia se vuelva a cargar.

Disparará para la fuente inicial y cada fuente subsiguiente. Este evento es un evento personalizado de Video.js y lo activa el Tecnología.

El objeto de evento para este evento contiene un src propiedad que contendrá la fuente que estaba disponible cuando se desencadenó el evento. Por lo general, esto solo es necesario si Video.js está cambiando de tecnología mientras se cambia la fuente.

También se dispara cuando carga se llama en el reproductor (o elemento multimedia) porque el especificación para carga dice que el algoritmo de selección de recursos debe abortarse y reiniciarse. En este caso, es muy probable que el src la propiedad se establecerá en la cadena vacía "" para indicar que no sabemos cuál será la fuente pero que está cambiando.

Este evento aún es experimental y puede cambiar en versiones menores. Para usar esto, pase enableSourceset opción para el jugador.

Tipo:
Propiedades:
Nombre Tipo Descripción
src cuerda

La URL de origen disponible cuando conjunto de fuentes fue activado. Será una cadena vacía si no podemos saber cuál es la fuente pero sabemos que la fuente cambiará.

estancado
jugador.js , línea 124

Se activa cuando el navegador intenta obtener datos multimedia, pero los datos no están disponibles.

Tipo:

suspender
jugador.js , línea 93

Se activa cuando el navegador no recibe datos multimedia intencionalmente.

Tipo:

toque
componente.js , línea 1282

Se activa cuando un Componente se toca.

Tipo:
Anulaciones:

datos de texto
jugador.js , línea 2224

Se activa cuando recibimos un evento textdata de tecnología

Tipo:

cambio de pista de texto
jugador.js , línea 220

Se activa cuando se ha cambiado la pista de texto

Tipo:
  • evento
Oyentes de este evento:

actualización de tiempo
jugador.js , línea 172

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

Tipo:
  • evento
Oyentes de este evento:

actualización de tiempo
jugador.js , línea 5400

Se activa cuando la posición de reproducción actual ha cambiado * Durante la reproducción, se activa cada 15-250 milisegundos, dependiendo de la tecnología de reproducción que se utilice.

Tipo:

usuario activo
jugador.js , línea 4101

Tipo:

usuario inactivo
jugador.js , línea 4127

Tipo:

uso de controles personalizados
jugador.js , línea 3969

player utiliza los controles HTML personalizados

Tipo:

uso de controles nativos
jugador.js , línea 3959

el reproductor utiliza los controles del dispositivo nativo

Tipo:

cambio de volumen
jugador.js , línea 204

Se activa cuando se ha cambiado el volumen

Tipo:
  • evento
Oyentes de este evento:

cambio de volumen
jugador.js , línea 5409

Se activa cuando cambia el volumen

Tipo:

esperando
player.js , línea 1745

Un cambio de ReadyState en el elemento DOM ha provocado que la reproducción se detenga.

Tipo:

pluginsetup: $name
plugin.js , línea 503

Señala que se acaba de configurar un complemento en un reproductor, por su nombre. El nombre es el nombre del complemento.

Tipo: