Brancher(joueur)

Classe parente pour tous les plugins avancés.

Nouveau Brancher(joueur)
plugin.js , ligne 188

Crée une instance de cette classe.

Les sous-classes doivent appeler super pour s'assurer que les plugins sont correctement initialisés.

Paramètres :
Prénom Type Description
joueur Joueur

Une instance de lecteur Video.js.
Incendies :
Écoute les événements :
Lancers :

Si vous essayez d'instancier la base Brancher classe directement au lieu de via une sous-classe.

Type
Erreur
Se mélange dans :

Membres

statique BASE_PLUGIN_NAME :chaîne de caractères
plugin.js , ligne 457

Le nom de la classe de plugin de base tel qu'il est enregistré.

Etat :Objet
mixins/stateful.js, ligne 22

Un hachage contenant des clés et des valeurs arbitraires représentant l'état de l'objet.

Se mélange dans :
  • module:stateful~StatefulMixin.state

Etat :Objet
mixins/stateful.js, ligne 22

Un hachage contenant des clés et des valeurs arbitraires représentant l'état de l'objet.

Se mélange dans :
  • module:stateful~StatefulMixin.state

Méthodes

Plugin statique DeRegisterPlugin(nom)
plugin.js, ligne 386

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 getPlugin(name) → {fonction|non définie}
plugin.js, ligne 438

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}
plugin.js, ligne 407

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}
plugin.js, ligne 431

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 isBasic(plugin) → {booléen}
plugin.js , ligne 325

Détermine si un plugin est un plugin de base (c'est-à-dire pas une sous-classe de Brancher).

Paramètres :
Prénom Type Description
greffon chaîne de caractères | fonction

S'il s'agit d'une chaîne, correspond au nom d'un plugin. Si une fonction, sera testée directement.
Retours :
booléen -

Qu'un plugin soit ou non un plugin de base.

statique registerPlugin(name, plugin) → {fonction}
plugin.js, ligne 346

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.

tout(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 358

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel. L'écouteur ne sera appelé qu'une seule fois pour le premier événement déclenché puis supprimé.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

tout(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 358

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel. L'écouteur ne sera appelé qu'une seule fois pour le premier événement déclenché puis supprimé.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

jetez()
plugin.js , ligne 291

Dispose un plugin.

Les sous-classes peuvent remplacer cela si elles le souhaitent, mais pour des raisons de sécurité, il est probablement préférable de souscrire à l'événement "dispose".

Incendies :

getEventHash(hashopt) → {Plugin~PluginEventHash}
plugin.js , ligne 244

Chaque événement déclenché par les plugins inclut un hachage de données supplémentaires avec des propriétés conventionnelles.

Cela renvoie cet objet ou modifie un hachage existant.

Paramètres :
Prénom Type Attributs Défaut Description
hachage Objet <facultatif>
 {}

Un objet à utiliser comme événement et hachage d'événement.
Retours :
Plugin~PluginEventHash -

Un objet de hachage d'événement avec les propriétés fournies mélangées.

abstrait handleStateChanged(e)
plugin.js , ligne 281

Gère les événements "statechanged" sur le plugin. No-op par défaut, remplacement par sous-classement.

Paramètres :
Prénom Type Description
e Événement

Un objet événement fourni par un événement "statechanged".

Propriétés
Prénom Type Description
changements Objet

Un objet décrivant les changements qui se sont produits avec l'événement "statechanged".

désactivé(cibleOuTypeopter , tapezOuListeneropter , auditeuropter)
mixins/evented.js, ligne 398

Supprime les écouteurs des événements sur un objet événementiel.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet <facultatif>

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement.

    Un autre objet événementiel peut être transmis ici à la place, auquel cas
    Les trois arguments sont _nécessaires_.
Type ou écouteur chaîne | Array | fonction <facultatif>

Si le premier argument était une chaîne ou un tableau, il peut s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agira de la fonction d'écoute ; dans le cas contraire, toutes les fonctions d'écoute liées au(x) type(s) d'événement seront supprimées.
Se mélange dans :

désactivé(cibleOuTypeopter , tapezOuListeneropter , auditeuropter)
mixins/evented.js, ligne 398

Supprime les écouteurs des événements sur un objet événementiel.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet <facultatif>

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement.

    Un autre objet événementiel peut être transmis ici à la place, auquel cas
    Les trois arguments sont _nécessaires_.
Type ou écouteur chaîne | Array | fonction <facultatif>

Si le premier argument était une chaîne ou un tableau, il peut s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agira de la fonction d'écoute ; dans le cas contraire, toutes les fonctions d'écoute liées au(x) type(s) d'événement seront supprimées.
Se mélange dans :

au(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 257

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

au(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 257

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

une(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 309

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel. L'écouteur sera appelé une fois par événement, puis supprimé.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

une(targetOrType, typeOrListener, listeneropter)
mixins/evented.js, ligne 309

Ajoutez un écouteur à un événement (ou aux événements) sur cet objet ou un autre objet événementiel. L'écouteur sera appelé une fois par événement, puis supprimé.

Paramètres :
Prénom Type Attributs Description
Cible ou type chaîne | Tableau | Élément | Objet

S'il s'agit d'une chaîne ou d'un tableau, il représente le ou les types d'événement qui déclencheront l'écouteur.

    Un autre objet événementiel peut être transmis ici à la place, ce qui aura pour effet de
    font que l'auditeur écoute les événements sur _cet_ objet.

    Dans les deux cas, la valeur `this` de l'auditeur sera liée à
    cet objet.
Type ou écouteur chaîne | Array | fonction

Si le premier argument était une chaîne ou un tableau, il doit s'agir de la fonction d'écoute. Sinon, il s'agit d'une chaîne ou d'un tableau de types d'événements.
auditeur fonction <facultatif>

Si le premier argument était un autre objet événementiel, il s'agit de la fonction d'écoute.
Se mélange dans :

setState(stateUpdates) → {Objet|non défini}
mixins/stateful.js, ligne 37

Définir l'état d'un objet en mutant son Etat objet en place.

Paramètres :
Prénom Type Description
Mises à jour Objet | fonction

Un nouvel ensemble de propriétés à fusionner de manière superficielle dans l'état du plugin. Il peut s'agir d'un objet brut ou d'une fonction renvoyant un objet brut.
Incendies :
Retours :
Objet | non défini -

Objet contenant des modifications survenues. Si aucun changement n'est survenu, renvoie non défini.

Se mélange dans :
  • module:stateful~StatefulMixin.setState

setState(stateUpdates) → {Objet|non défini}
mixins/stateful.js, ligne 37

Définir l'état d'un objet en mutant son Etat objet en place.

Paramètres :
Prénom Type Description
Mises à jour Objet | fonction

Un nouvel ensemble de propriétés à fusionner de manière superficielle dans l'état du plugin. Il peut s'agir d'un objet brut ou d'une fonction renvoyant un objet brut.
Incendies :
Retours :
Objet | non défini -

Objet contenant des modifications survenues. Si aucun changement n'est survenu, renvoie non défini.

Se mélange dans :
  • module:stateful~StatefulMixin.setState

trigger(event, hashopt) → {boolean}
plugin.js , ligne 265

Déclenche un événement sur l'objet plugin et remplace EventedMixin.trigger.

Paramètres :
Prénom Type Attributs Défaut Description
événement chaîne | Objet

Un type d'événement ou un objet avec une propriété type.
hachage Objet <facultatif>
 {}

Hachage de données supplémentaires à fusionner avec un PluginEventHash.

Retours :
booléen -

Si le défaut a été empêché ou non.

trigger(event, hashopt) → {boolean}
mixins/evented.js, ligne 443

déclenche un événement sur cet objet événementiel, provoquant l'appel de ses écouteurs.

Paramètres :
Prénom Type Attributs Description
événement chaîne | Objet

Un type d'événement ou un objet avec une propriété type.
hachage Objet <facultatif>

Un objet supplémentaire à transmettre aux auditeurs.
Retours :
booléen -

Indique si le comportement par défaut a été empêché ou non.

Se mélange dans :

trigger(event, hashopt) → {boolean}
mixins/evented.js, ligne 443

déclenche un événement sur cet objet événementiel, provoquant l'appel de ses écouteurs.

Paramètres :
Prénom Type Attributs Description
événement chaîne | Objet

Un type d'événement ou un objet avec une propriété type.
hachage Objet <facultatif>

Un objet supplémentaire à transmettre aux auditeurs.
Retours :
booléen -

Indique si le comportement par défaut a été empêché ou non.

Se mélange dans :

version()
plugin.js , ligne 228

Obtenez la version du plugin qui a été définie sur .VERSION

Définitions de types

PlugineEvent Hash
plugin.js , ligne 511

Propriétés :
Prénom Type Description
exemple chaîne

Pour les plugins de base, la valeur de retour de la fonction plugin. Pour les plugins avancés, l'instance de plugin sur laquelle l'événement est déclenché.
nom chaîne

Le nom du plugin.
greffon chaîne

Pour les plugins de base, la fonction plugin. Pour les plugins avancés, le plugin class/constructor.

Evénements

disposer
plugin.js , ligne 294

Signale qu'un plugin avancé est sur le point d'être supprimé.

Type: