videojs~videojs

Les videojs() La fonction sert également de fonction principale aux utilisateurs pour créer un Joueur instance ainsi que l'espace de noms de la bibliothèque principale.

Il peut également être utilisé comme getter pour un préexistant Joueur exemple. Cependant, nous recommandons fortement d'utiliser videojs.getPlayer() à cette fin, car cela évite tout risque d'initialisation involontaire.

En raison de limites de notre modèle JSDoc, nous ne pouvons pas documenter correctement cela à la fois comme une fonction et un espace de noms, donc sa signature de fonction est documentée ici.

Arguments

ID

chaîne|Élément, obligatoire

Élément vidéo ou ID d'élément vidéo.

options

Objet, facultatif

Objet d'options pour fournir des paramètres. Voir : Guide des options.

prêt

Composant~PrêtRappel , optionnel

Une fonction à appeler lorsque le Joueur et Technologie sont prêts.

Valeur de retour

Les videojs() la fonction renvoie un Joueur exemple.

Des classes

Piste audio
module:videojs~videojs.AudioTrack

Target de l'événement
module:videojs~videojs.EventTarget

TextTrack
module:videojs~videojs.TextTrack

Piste vidéo
module:videojs~videojs.VideoTrack

Membres

statique navigateur :Objet

Une référence à la module utilitaire de navigateur comme objet.

Voir :

statique dom :Objet

Une référence à la module utilitaire DOM comme objet.

Voir :

statique Journal :fonction

Une référence à la module utilitaire de journalisation comme objet.

Voir :

statique options :Objet

L'objet d'options globales. Ce sont les paramètres qui prennent effet si aucun remplacement n'est spécifié lors de la création du lecteur.

lecteurs statiques : Object

Dénombrement mondial des joueurs.

Les clés sont les identifiants des joueurs et les valeurs sont soit les Joueur exemple ou nul pour les joueurs disposés.

statique TOUCH_ENABLED :booléen

Utilisation navigateur.TOUCH_ENABLED au lieu; uniquement inclus pour la rétrocompatibilité avec 4.x.

Obsolète :

statique URL :Objet

Une référence à la module utilitaire d'URL comme objet.

Voir :

statique VERSION :chaîne de caractères

Version actuelle de Video.js. Suit versionnage sémantique.

Méthodes

statique AddLanguage(code, données) → {Object

Ajout de langues pour qu'elles soient disponibles pour tous les joueurs. Exemple : videojs.addLanguage('es', { 'Hello' : « Hola »}) ;

Paramètres :
Prénom Type Description
code chaîne

Le code de langue ou la propriété de dictionnaire

Les données Objet

Les valeurs de données à traduire

Retours :
Objet -

L'objet dictionnaire de langue résultant

statique bind(context, fn, uidopt) → {fonction}

Bind (alias proxy ou contexte). Une méthode simple pour modifier le contexte d'une fonction.

Il stocke également un identifiant unique sur la fonction afin qu'il puisse être facilement supprimé des événements.

Paramètres :
Prénom Type Attributs Description
contexte Mixte

Objet à lier en tant qu'étendue.

fn fonction

Fonction à lier à une portée.

UID numéro <facultatif>

Un identifiant unique en option pour la fonction à définir

Retours :
fonction -

La nouvelle fonction qui sera liée au contexte donné

statique stylecalculé(el, accessoire)

Un GetComputedStyle sûr.

Cela est nécessaire car dans Firefox, si le lecteur est chargé dans un iframe avec display:none, GetComputedStyle retourne null, donc nous effectuons un null-check pour s'assurer que le joueur ne se brise pas dans ces cas.

Paramètres :
Prénom Type Description
el Element

L'élément que vous souhaitez utiliser le style de calcul de

accessoire chaîne

Le nom de la propriété que vous souhaitez

Voir :

statique createTimeRange(début Fin)

Créer un Intervalle de temps objet qui imite un Instance HTML5 TimeRanges.

Paramètres :
Prénom Type Description
début number | Array.<matrice>

Début d'une plage unique (un nombre) ou d'un tableau de plages (tableau de deux nombres chacun).

fin numéro

La fin d'une plage unique. Ne peut pas être utilisé avec la forme matricielle du début argument.

Pages CreateTimeranges statiques(début, fin)

Créer un Intervalle de temps objet qui imite un Instance HTML5 TimeRanges.

Paramètres :
Prénom Type Description
début number | Array.<matrice>

Début d'une plage unique (un nombre) ou d'un tableau de plages (tableau de deux nombres chacun).

fin numéro

La fin d'une plage unique. Ne peut pas être utilisé avec la forme matricielle du début argument.

Plugin statique DeRegisterPlugin(nom)

Désenregistrez un plugin Video.js.

Paramètres :
Prénom Type Description
nom chaîne

Le nom du plugin à désinsenregistrer. Il doit s'agir d'une chaîne qui correspond à un plugin existant.

Lancers :

Si une tentative de désenregistrement du plugin de base est effectuée.

Type
Erreur

statique extend(superClass, subClassMethodsopt) → {fonction}

Utilisé pour sous-classer une classe existante en émulant le sous-classement ES à l'aide de la s'étend mot-clé.

Paramètres :
Prénom Type Attributs Défaut Description
SuperClass fonction

La classe à laquelle hériter

Méthodes de sous-classe Objet <facultatif>
{}

Méthodes de la nouvelle classe

Retours :
fonction -

La nouvelle classe avec SubClassMethods qui a hérité de SuperClass.

Obsolète :
  • Oui
Exemple
var MyComponent = videojs.extend(videojs.getComponent('Component'), {
  myCustomMethod : function() {
    // Faire des choses dans ma méthode.
  }
}) ;

statique formatTime(seconds, guide) → {string}

Délègue soit la fonction de formatage horaire par défaut, soit à une fonction personnalisée fournie via SetFormatTime.

Formate les secondes sous forme de chaîne de temps (H:MM:SS ou M:SS). La fourniture d'un guide (en secondes) forcera un certain nombre de zéros principaux à couvrir la longueur du guide.

Paramètres :
Prénom Type Description
secondes numéro

Nombre de secondes à transformer en chaîne

guide numéro

Nombre (en secondes) pour modéliser la chaîne après

Retours :
corde -

Heure formatée en H:MM:SS ou M:SS

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

statique getAllPlayers() → {Array}

Renvoie un tableau de tous les joueurs actuels.

Retours :
Array -

Un tableau de tous les joueurs. Le tableau sera dans l'ordre Objet.clés fournit, qui peut potentiellement varier entre les moteurs JavaScript.

statique getComponent(name){Component}

Obtenez un composant basé sur le nom avec qui il a été enregistré.

Paramètres :
Prénom Type Description
nom chaîne

Nom du composant à obtenir.

Retours :
Composante-

Composant enregistré sous le prénom.

statique getPlayer(id) → {Player|non défini}

Obtenez un seul joueur basé sur un élément ID ou DOM.

Ceci est utile si vous souhaitez vérifier si un élément ou un ID a un lecteur Video.js associé, mais pas en créer un si ce n'est pas le cas.

Paramètres :
Prénom Type Description
ID chaîne | Element

Un élément HTML - < vidéo> , < l'audio> , ou < vidéo-js> - ou une chaîne correspondant au identifiant d'un tel élément.

Retours :
Joueur | indéfini -

Une instance de joueur ou indéfini s'il n'y a pas d'instance de joueur correspondant à l'argument.

statique getPlayers() → {Objet}

Obtenez un objet avec les joueurs actuellement créés, saisis par ID de joueur

Retours :
Objet -

Les joueurs créés

statique getPlugin(name) → {fonction|non définie}

Obtient un plugin par son nom s'il existe.

Paramètres :
Prénom Type Description
nom chaîne

Le nom d'un plugin.

Retours :
fonction | indéfini -

Le plugin (ou non défini).

statique getPlugins(namesopt) → {Objet|non défini}

Obtient un objet contenant plusieurs plugins Video.js.

Paramètres :
Prénom Type Attributs Description
noms baie <facultatif>

S'il est fourni, devrait être un tableau de noms de greffons. Par défaut, tous les noms de plugins sont pris en compte.

Retours :
Objet | non défini -

Objet contenant des plugins associés à leur nom (s) ou non défini (s) s'il n'existe pas de plug-ins correspondants).

statique getPluginVersion(name) → {string}

Obtient la version d'un plugin, si disponible

Paramètres :
Prénom Type Description
nom chaîne

Le nom d'un plugin.

Retours :
corde -

La version du plugin ou une chaîne vide.

statique getTech(name){Tech|non défini}

Obtenez un Tech de la liste partagée par son nom.

Paramètres :
Prénom Type Description
nom chaîne

affaire de chameau ou TitreCase nom de la Tech à obtenir

Retours :
Tech | indéfini -

Le Tech ou non défini s'il n'y avait pas de technologie portant le nom demandé.

statique isCrossOrigin(url, winLocopt) → {boolean}

Indique si l'URL transmise est une requête interdomaine ou non.

Paramètres :
Prénom Type Attributs Description
url chaîne

L'URL à vérifier.

WinLoc Objet <facultatif>

le domaine pour vérifier l'URL, est par défaut window.location

Propriétés
Prénom Type Attributs Description
protocole chaîne <facultatif>

Le protocole d'emplacement des fenêtres est par défaut window.location.protocol.

hôte chaîne <facultatif>

L'hôte de l'emplacement de la fenêtre est par défaut window.location.host

Retours :
booléen -

Qu'il s'agisse d'une demande interdomaine ou non.

statique mergeOptions(...sources) → {Objet}

Fusionnez deux objets récursivement.

Effectue une fusion profonde comme lodash.merge, mais ne fusionne que des objets simples (pas des tableaux, des éléments ou autre chose).

Les valeurs des objets non simples seront copiées directement à partir de l'argument le plus à droite.

Paramètres :
Prénom Type Attributs Description
sources matrice.<Objet> <répétable>

Un ou plusieurs objets à fusionner dans un nouvel objet.

Retours :
Objet -

Un nouvel objet qui est le résultat fusionné de toutes les sources.

statique désactivé(elem, typeopt, fnopt)

Supprime les écouteurs d'événements d'un élément

Paramètres :
Prénom Type Attributs Description
élém Element | Objet

Objet à supprimer des écouteurs.

type string | Array.<corde> <facultatif>

Type d'écouteur à supprimer. Ne pas inclure pour supprimer tous les événements de l'élément.

fn EventTarget~EventListener <facultatif>

Écouteur spécifique à supprimer. Ne pas inclure pour supprimer les écouteurs d'un type d'événement.

statique sur(élém, type, fn)

Ajouter un écouteur d'événements à l'élément Il stocke la fonction de gestionnaire dans un objet cache distinct et ajoute un gestionnaire générique à l'événement de l'élément, ainsi qu'un identifiant unique (guid) à l'élément.

Paramètres :
Prénom Type Description
élém Element | Objet

Élément ou objet pour lier les auditeurs

type string | Array.<corde>

Type d'événement auquel se lier.

fn EventTarget~EventListener

Écouteur d'événements.

statique (élém, type, fn)

Déclenchez un écouteur une seule fois pour un événement.

Paramètres :
Prénom Type Description
élém Element | Objet

Élément ou objet auquel se lier.

type string | Array.<corde>

Nom/type d'événement

fn Event~EventListener

Fonction d'écoute d'événements

statique parseUrl(url) → {url:URLObject}

Résolvez et analysez les éléments d'une URL.

Paramètres :
Prénom Type Description
url String

L'URL à analyser

Retours :
URL : objet URL -

Un objet contenant des détails d'URL

statique brancher(nom, plugin)

Méthode obsolète pour enregistrer un plugin avec Video.js

Paramètres :
Prénom Type Description
nom chaîne

Le nom du plugin

greffon Brancher | fonction

La sous-classe ou fonction du plugin

Obsolète :
  • videojs.plugin() est obsolète ; utilisez plutôt videojs.registerPlugin()

statique registerComponent(name, comp){Component}

Enregistrez un composant afin qu'il puisse être référencé par son nom. Utilisé lors de l'ajout à d'autres composants, soit par l'intermédiaire de addChild component.addChild('myComponent') , soit par l'intermédiaire des options d'enfants par défaut { children : ['myComponent'] }.

REMARQUE : Vous pouvez également simplement initialiser le composant avant de l'ajouter. component.addChild(new MyComponent());

Paramètres :
Prénom Type Description
nom chaîne

Le nom de classe du composant

comp Composante

La classe de composants

Retours :
Composante-

Le composant nouvellement enregistré

statique registerPlugin(name, plugin) → {fonction}

Enregistrez un plugin Video.js.

Paramètres :
Prénom Type Description
nom chaîne

Le nom du plugin à enregistrer. Doit être une chaîne et ne doit pas correspondre à un plugin ou à une méthode existant sur le Joueur prototype.

greffon fonction

Une sous-classe de Plugin ou une fonction pour les plugins de base.

Retours :
fonction -

Pour les plugins avancés, une fonction d'usine pour ce plugin. Pour les plugins de base, une fonction wrapper qui initialise le plugin.

RegisterTech statique(nom, technologie)

Enregistre un Tech dans une liste partagée pour videojs.

Paramètres :
Prénom Type Description
nom chaîne

Nom de la Tech à enregistrer.

technologie Objet

Les Technologie classe pour s'inscrire.

statique ResetFormatTime()

Réinitialise FormatTime à l'implémentation par défaut.

statique SetFormatTime(Implémentation personnalisée)

Remplace l'implémentation FormatTime par défaut par une implémentation personnalisée.

Paramètres :
Prénom Type Description
Implémentation personnalisée fonction

Fonction qui sera utilisée à la place de l'implémentation FormatTime par défaut. Va recevoir l'heure actuelle en secondes et le guide (en secondes) comme arguments.

statique trigger(elem, event, hashopt) → {boolean|undefined}

Déclencher un événement pour un élément

Paramètres :
Prénom Type Attributs Description
élém Element | Objet

Élément pour déclencher un événement sur

événement EventTarget~Event | chaîne

Une chaîne (le type) ou un objet événement avec un attribut type

hachage Objet <facultatif>

hachage de données à transmettre avec l'événement

Retours :
booléen | indéfini -

Renvoie le contraire de DefaultPrevented si la valeur par défaut a été empêchée. Sinon, renvoie non défini

utilisation statique(type, middleware)

Définissez un intergiciel que le lecteur doit utiliser au moyen d'une fonction d'usine qui renvoie un objet intergiciel.

Paramètres :
Prénom Type Description
type chaîne

Type MIME correspondant ou  * » pour tous les types MIME.

intergiciel Middleware Factory

Fonction d'usine d'intergiciels qui sera exécutée pour les types correspondants.

statique xhr(options) → {XMLHttpRequest|XDomainRequest}

Un wrapper XMLHttpRequest multi-navigateurs.

Paramètres :
Prénom Type Description
options Objet

Paramètres de la demande.

Retours :
XMLHttpRequête | XDomainRequest -

L'objet de requête.

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