videojs~videojs

los videojs () función funciona como la función principal para que los usuarios creen un Jugador instancia, así como el espacio de nombres de la biblioteca principal.

También se puede utilizar como getter para un preexistente Jugador ejemplo. Sin embargo, recomendamos enfáticamente usar videojs.getPlayer() para este propósito porque evita cualquier potencial de inicialización no deseada.

Debido a las limitaciones de nuestra plantilla JSDoc, no podemos documentarlo correctamente como función y espacio de nombres, por lo que su firma de función se documenta aquí.

Argumentos

id

cadena | Elemento, requerido

Elemento de video o ID de elemento de video.

opciones

Objeto, opcional

Objeto de opciones para proporcionar configuraciones. Ver: Guía de opciones.

listo

Componente ~ ReadyCallback , Opcional

Una función que se llamará cuando el Jugador y Tecnología estan listos.

Valor devuelto

los videojs () la función devuelve un Jugador ejemplo.

Clases

pista de audio

Objetivo del evento

Track de texto

pista de vídeo

Miembros

estático navegador :Objeto

Una referencia a la módulo de utilidad del navegador como un objeto.

Ver:

estático dom :Objeto

Una referencia a la Módulo de utilidad DOM como un objeto.

Ver:

estático Iniciar sesión :función

Una referencia a la módulo de utilidad de registro como un objeto.

Ver:

estático opciones :Objeto

El objeto de opciones globales. Estos son los ajustes que tienen efecto si no se especifican modificaciones cuando se crea el reproductor.

reproductores estáticos :Objeto

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.

estático TOUCH_ENABLED : booleano

Usar browser.TOUCH_ENABLED en lugar de; solo se incluye para compatibilidad con versiones anteriores con 4.x.

En desuso:

estático url :Objeto

Una referencia a la Módulo de utilidad de URL como un objeto.

Ver:

estático VERSIÓN :cuerda

Versión actual de Video.js. Sigue control de versiones semántico.

Métodos

static addLanguage(code, data) → {Object

Agregar idiomas para que estén disponibles para todos los jugadores. Ejemplo: videojs.addLanguage('es', { 'Hola': 'Hola' });

Parámetros:
Nombre Tipo Descripción
código cuerda

El código de idioma o la propiedad del diccionario

datos Objeto

Los valores de los datos a traducir

Devoluciones:
Objeto -

El objeto de diccionario de idioma resultante

enlace estático (contexto, fn, uid opt ) → {función}

Enlazar (también conocido como proxy o contexto). Un método sencillo para cambiar el contexto de una función.

También almacena un identificador único en la función para que pueda eliminarse fácilmente de los eventos.

Parámetros:
Nombre Tipo Atributos Descripción
contexto mixto

Objeto que se va a enlazar como ámbito.

fn función

Función que se va a enlazar a un ámbito.

uid número <optional>

Identificador único opcional para la función que se va a configurar

Devoluciones:
función -

La nueva función que se vinculará al contexto dado

estático computedStyle(el, prop)

Un getComputedStyle seguro.

Esto es necesario porque en Firefox, si el reproductor se carga en un iframe con display:none, getComputedStyle devuelve nulo, por lo que hacemos un null-check para asegurarse de que el reproductor no se rompa en estos casos.

Parámetros:
Nombre Tipo Descripción
el Elemento

El elemento del que desea el estilo calculado de

utiLería cuerda

El nombre de la propiedad que quieres

Ver:

estático createTimeRange(inicio fin)

Crear un Intervalo de tiempo objeto que imita un Instancia HTML5 TimeRanges.

Parámetros:
Nombre Tipo Descripción
inicio number | Matriz.<Matrices >

El inicio de un único rango (un número) o una matriz de rangos (una matriz de matrices de dos números cada uno).

final número

El final de un solo rango. No se puede utilizar con la forma de matriz del comienzo argumento.

ranjos de tiempo de creación estáticos(inicio, final)

Crear un Intervalo de tiempo objeto que imita un Instancia HTML5 TimeRanges.

Parámetros:
Nombre Tipo Descripción
inicio number | Matriz.<Matrices >

El inicio de un único rango (un número) o una matriz de rangos (una matriz de matrices de dos números cada uno).

final número

El final de un solo rango. No se puede utilizar con la forma de matriz del comienzo argumento.

estática de anulación de registro Plugin(nombre)

Anular el registro de un complemento Video.js.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del complemento que se va a cancelar el registro. Debe ser una cadena que coincida con un plugin existente.

Lanzamientos:

Si se intenta anular el registro del complemento base.

Tipo
Error

extensión estática (superclase, subClassMethods opt ) → {función}

Se utiliza para crear una subclase de una clase existente emulando la subclase ES utilizando la se extiende palabra clave.

Parámetros:
Nombre Tipo Atributos Predeterminado Descripción
SuperClass función

La clase de la que se heredará

Métodos de subclase Objeto <optional>
{}

Métodos de la nueva clase

Devoluciones:
función -

La nueva clase con SubclassMethods que heredó SuperClass.

En desuso:
Ejemplo
var MiComponente = videojs.extend(videojs.getComponent('Componente'), {
  miMetodoPersonalizado: function() {
    // Hacer cosas en mi método.
  }
});

formato estáticoTiempo (segundos, guía) → {cadena}

Delega a la función de formato de hora predeterminada o a una función personalizada proporcionada a través de setFormatTime.

Da formato a segundos como cadena de tiempo (H:MM:SS o M:SS). El suministro de una guía (en segundos) obligará a varios ceros a la izquierda a cubrir la longitud de la guía.

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

Número de segundos que se convertirán en una cadena

guía número

Número (en segundos) para modelar la cadena después

Devoluciones:
cadena -

Hora formateada como H:MM:SS o M:SS

Ejemplo
FormatTime (125, 600) === "02:05"

getAllPlayers estático () → {Array}

Devuelve una matriz de todos los jugadores actuales.

Devoluciones:
Matriz -

Una variedad de todos los jugadores. La matriz estará en el orden en que Object.keys proporciona, que podría variar potencialmente entre los motores de JavaScript.

getComponent estático (nombre) → { Componente }

Obtenga un componente basado en el nombre con el que se registró.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del componente que se va a obtener.

Devoluciones:
Componente-

El componente que se registró con el nombre de pila.

getPlayer estático (id) → { Jugador |indefinido}

Obtenga un solo jugador basado en un elemento ID o DOM.

Esto es útil si desea verificar si un elemento o ID tiene un reproductor Video.js asociado, pero no crear uno si no lo tiene.

Parámetros:
Nombre Tipo Descripción
id string | Elemento

Un elemento HTML - < video> , < audio> , o < video-js> - o una cadena que coincida con el identificación de tal elemento.

Devoluciones:
Jugador | indefinido -

Una instancia de jugador o indefinido si no hay una instancia de jugador que coincida con el argumento.

getPlayers estáticos () → {Objeto}

Obtenga un objeto con los jugadores creados actualmente, codificados por ID de jugador

Devoluciones:
Objeto -

Los jugadores creados

getPlugin estático (nombre) → {función|indefinido}

Obtiene un complemento por su nombre si existe.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre de un complemento.

Devoluciones:
función | indefinido -

El complemento (o no definido).

getPlugins estáticos ( opción de nombres) → {Objeto|indefinido}

Obtiene un objeto que contiene varios complementos Video.js.

Parámetros:
Nombre Tipo Atributos Descripción
nombres Matriz <optional>

Si se proporciona, debería haber una serie de nombres de complementos. Los valores predeterminados son todos los nombres de los complementos.

Devoluciones:
Objeto | indefinido -

Objeto que contiene complementos asociados a sus nombres o no definidos si no existen complementos coincidentes).

getPluginVersion estática (nombre) → {cadena}

Obtiene la versión de un plugin, si está disponible

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre de un complemento.

Devoluciones:
cadena -

La versión del complemento o una cadena vacía.

getTech estático (nombre) → { Tech |indefinido}

Obtenga un técnico de la lista compartida por su nombre.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

CamelCase o TitleCase nombre de la tecnología que se va a obtener

Devoluciones:
Tecnología | undefined -

La tecnología o indefinida si no había tecnología con el nombre solicitado.

isCrossOrigin estático (url, winLoc opt ) → {boolean}

Devuelve si la url pasada es una solicitud entre dominios o no.

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

URL que se va a comprobar.

WinLOC Objeto <optional>

el dominio con el que comprobar la url, el valor predeterminado es window.location

Propiedades
Nombre Tipo Atributos Descripción
protocolo cuerda <optional>

El protocolo de ubicación de ventana se establece de forma predeterminada en window.location.protocol

anfitrión cuerda <optional>

El host de ubicación de la ventana se establece de forma predeterminada en window.location.host

Devoluciones:
booleano -

Tanto si se trata de una solicitud multidominio como si no.

mergeOptions estáticas (...fuentes) → {Objeto}

Fusiona dos objetos de forma recursiva.

Realiza una fusión profunda como lodash.merge, pero solo fusiona objetos planos (no matrices, elementos ni cualquier otra cosa).

Los valores de objeto no simples se copiarán directamente desde el argumento situado más a la derecha.

Parámetros:
Nombre Tipo Atributos Descripción
fuentes Matriz.<Objeto> <repeatable>

Uno o varios objetos para fusionar en un nuevo objeto.

Devoluciones:
Objeto -

Un nuevo objeto que es el resultado combinado de todos los orígenes.

static off(elem, typeopt, fnopt)

Elimina los detectores de eventos de un elemento

Parámetros:
Nombre Tipo Atributos Descripción
elem Elemento | Objeto

Objeto del que quitar los oyentes.

tipo string | Matriz.<cadena> <optional>

Tipo de agente de escucha que se va a eliminar. No incluyas para eliminar todos los eventos del elemento.

fn Objeto de eventos~Escuchador de eventos <optional>

Listener específico que se va a eliminar. No incluyas para eliminar oyentes de un tipo de evento.

estática activada(elem, type, fn)

Agregar un detector de eventos al elemento Almacena la función de controlador en un objeto de caché independiente y añade un controlador genérico al evento del elemento, junto con un identificador único (guid) al elemento.

Parámetros:
Nombre Tipo Descripción
elem Elemento | Objeto

Elemento u objeto al que vincular a los oyentes

tipo string | Matriz.<cadena>

Tipo de evento al que se va a vincular.

fn Objeto de eventos~Escuchador de eventos

Escuchador de eventos.

uno estático(elem, type, fn)

Activa un oyente solo una vez para un evento.

Parámetros:
Nombre Tipo Descripción
elem Elemento | Objeto

Elemento u objeto al que enlazar.

tipo string | Matriz.<cadena>

Nombre/tipo de evento

fn Event~EventListener

Función de escucha de eventos

parseUrl estático (url) → {url:URLObject}

Resuelve y analiza los elementos de una URL.

Parámetros:
Nombre Tipo Descripción
url cuerda

URL que se va a analizar

Devoluciones:
URL:urlObject -

Un objeto de detalles de url

estático enchufar(nombre, complemento)

Método obsoleto para registrar un complemento con Video.js

Parámetros:
Nombre Tipo Descripción
nombre cuerda

El nombre del complemento

plugin Enchufar | función

La subclase o función del complemento

En desuso:
  • videojs.plugin () está obsoleto; use videojs.registerPlugin () en su lugar

Componente de registro estático (nombre, borrador) → { Componente }

Registre un componente para que se pueda hacer referencia a él por su nombre. Se usa cuando se agrega a otros componentes, ya sea a través de addChild component.addChild('myComponent') o a través de opciones secundarias predeterminadas { children: ['myComponent'] } .

NOTA: También puede inicializar el componente antes de agregarlo. componente.addChild (nuevo MyComponent ());

Parámetros:
Nombre Tipo Descripción
nombre cuerda

El nombre de clase del componente.

comp Componente

La clase de componente

Devoluciones:
Componente-

El componente recién registrado

static registerPlugin (nombre, complemento) → {función}

Registre un complemento Video.js.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del complemento que se va a registrar. Debe ser una cadena y no debe coincidir con un complemento o método existente en el Jugador prototipo.

plugin función

Una subclase de Plugin o una función para complementos básicos.

Devoluciones:
función -

Para plugins avanzados, una función de fábrica para ese complemento. Para plugins básicos, una función envolvente que inicializa el complemento.

estática RegisterTech(nombre, tecnología)

Registra un técnico en una lista compartida para videojs.

Parámetros:
Nombre Tipo Descripción
nombre cuerda

Nombre del técnico que se va a registrar.

tecnología Objeto

los Tecnología clase para registrarse.

estática restetFormatTime()

Restablece FormatTime a la implementación predeterminada.

setFormatTime estático(implementación personalizada)

Sustituye la implementación predeterminada de FormatTime por una implementación personalizada.

Parámetros:
Nombre Tipo Descripción
Implementación personalizada función

Función que se utilizará en lugar de la implementación predeterminada de FormatTime. Recibirá la hora actual en segundos y la guía (en segundos) como argumentos.

disparador estático (elemento, evento, hash opt ) → {boolean|indefinido}

Activar un evento para un elemento

Parámetros:
Nombre Tipo Atributos Descripción
elem Elemento | Objeto

Elemento en el que activar un evento

evento eventtarget~Event | cadena

Una cadena (el tipo) o un objeto de evento con un atributo type

hachís Objeto <optional>

hash de datos para transmitir junto con el evento

Devoluciones:
boolean | undefined -

Devuelve lo contrario de DefaultPrevented si se ha impedido el valor predeterminado. De lo contrario, devuelve sin definir

uso estático(tipo, middleware)

Defina un middleware que el reproductor debe utilizar mediante una función de fábrica que devuelva un objeto middleware.

Parámetros:
Nombre Tipo Descripción
tipo cuerda

Tipo MIME que coincide o «*» para todos los tipos MIME.

middleware Fábrica de Midleware

Función de fábrica de middleware que se ejecutará para tipos coincidentes.

xhr estático (opciones) → {XMLHttpRequest|XDomainRequest}

Un contenedor XMLHttpRequest de varios navegadores.

Parámetros:
Nombre Tipo Descripción
opciones Objeto

Configuración de la solicitud.

Devoluciones:
XMLHttpRequest | XDomainRequest -

El objeto de la solicitud.

Ver:
  • https://github.com/Raynos/xhr