Plugin(Spieler)

Übergeordnete Klasse für alle erweiterten Plugins.

Neu Plugin(Spieler)
plugin.js , Linie 188

Erstellt eine Instanz dieser Klasse.

Unterklassen sollten anrufen Super um sicherzustellen, dass Plugins richtig initialisiert werden.

Parameter:
Nennen Typ Beschreibung
Spieler Spieler

Eine Video.js-Playerinstanz.
Brände:
Hört auf Ereignisse:
Wirft:

Wenn Sie versuchen, die Basis zu instanziieren Plugin Klasse direkt statt über eine Unterklasse.

Typ
Fehler
Mischt sich ein:

Mitglieder

statisch BASE_PLUGIN_NAME :string
plugin.js , Linie 457

Der Name der Basis-Plug-in-Klasse, wie sie registriert ist.

Zustand :Objekt
mixins/stateful.js, Zeile 22

Ein Hash mit willkürlichen Schlüsseln und Werten, die den Status des Objekts darstellen.

Mischt sich ein:
  • module:stateful~StatefulMixin.state

Zustand :Objekt
mixins/stateful.js, Zeile 22

Ein Hash mit willkürlichen Schlüsseln und Werten, die den Status des Objekts darstellen.

Mischt sich ein:
  • module:stateful~StatefulMixin.state

Methoden

statisches deregisterPlugin(Name)
plugin.js, Zeile 386

Deregistrieren Sie ein Video.js Plugin.

Parameter:
Nennen Typ Beschreibung
Name String

Der Name des Plugins, das abregistriert werden soll. Muss eine Zeichenfolge sein, die mit einem vorhandenen Plugin übereinstimmt.
Wirft:

Wenn versucht wird, das Basis-Plugin abzumelden.

Typ
Fehler

statisch getPlugin(name) → {function|undefined}
plugin.js, Zeile 438

Ruft ein Plugin nach Namen ab, falls es existiert.

Parameter:
Nennen Typ Beschreibung
Name String

Der Name eines Plugins.
Gibt zurück:
funktion | undefined -

Das Plugin (oder undefiniert).

statisch getPlugins(namesopt) → {Object|undefined}
plugin.js, Zeile 407

Ruft ein Objekt ab, das mehrere Video.js Plugins enthält.

Parameter:
Nennen Typ Attribute Beschreibung
Namen Reihe <optional>

Falls angegeben, sollte es sich um ein Array von Plugin-Namen handeln. Standardmäßig werden alle Plugin-Namen verwendet.
Gibt zurück:
Objekt | unbestimmtes -

Ein Objekt, das Plugins enthält, die mit ihrem Namen (n) verknüpft sind oder nicht definiert sind, wenn keine übereinstimmenden Plugins vorhanden sind).

statisch getPluginVersion(name) → {string}
plugin.js, Zeile 431

Ruft die Version eines Plugins ab, falls verfügbar

Parameter:
Nennen Typ Beschreibung
Name String

Der Name eines Plugins.
Gibt zurück:
string -

Die Version des Plugins oder eine leere Zeichenfolge.

static isBasic(Plugin) → {boolean}
plugin.js , Linie 325

Bestimmt, ob ein Plugin ein Basis-Plugin ist (dh keine Unterklasse von Plugin).

Parameter:
Nennen Typ Beschreibung
Plugin Schnur | Funktion

Wenn ein String, entspricht der Name eines Plugins. Wenn eine Funktion vorhanden ist, wird direkt getestet.
Gibt zurück:
boolescher Wert -

Ob ein Plugin ein Basis-Plugin ist oder nicht.

statisch registerPlugin(name, plugin) → {Funktion}
plugin.js, Zeile 346

Registrieren Sie ein Video.js Plugin.

Parameter:
Nennen Typ Beschreibung
Name String

Der Name des zu registrierenden Plugins. Muss eine Zeichenfolge sein und darf nicht mit einem vorhandenen Plugin oder einer Methode des Player-Prototyps übereinstimmen.
Plugin Funktion

Eine Unterklasse von Plugin oder eine Funktion für grundlegende Plugins.
Gibt zurück:
funktion -

Für erweiterte Plugins eine Factory-Funktion für dieses Plugin. Für grundlegende Plugins eine Wrapper-Funktion, die das Plugin initialisiert.

irgendein(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 358

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu. Der Listener wird nur einmal für das erste Ereignis aufgerufen, das ausgelöst und entfernt wird.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

irgendein(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 358

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu. Der Listener wird nur einmal für das erste Ereignis aufgerufen, das ausgelöst und entfernt wird.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

entsorgen()
plugin.js , Linie 291

Verfügt über ein Plugin.

Unterklassen können dies bei Bedarf überschreiben, aber aus Sicherheitsgründen ist es wahrscheinlich am besten, das Ereignis "dispose" zu abonnieren.

Brände:

getEventHash(Hash-Option) → {plugin~pluginEventHash}
plugin.js , Linie 244

Jedes von Plugins ausgelöste Ereignis enthält einen Hash zusätzlicher Daten mit herkömmlichen Eigenschaften.

Dadurch wird dieses Objekt zurückgegeben oder ein vorhandener Hash mutiert.

Parameter:
Nennen Typ Attribute Standardwert Beschreibung
Hash Objekt <optional>
 {}

Ein Objekt, das als Ereignis- oder Ereignis-Hash verwendet werden soll.
Gibt zurück:
Plugin~PluginEventHash -

Ein Ereignis-Hash-Objekt mit eingemischten bereitgestellten Eigenschaften.

abstrakt handleStateChanged(e)
plugin.js , Linie 281

Behandelt "statechanged"-Ereignisse im Plugin. No-Op standardmäßig, überschreiben durch Unterklassen.

Parameter:
Nennen Typ Beschreibung
e Ereignis

Ein Ereignisobjekt, das von einem "statechanged"-Ereignis bereitgestellt wird.

Immobilien
Nennen Typ Beschreibung
Änderungen Objekt

Ein Objekt, das Änderungen beschreibt, die mit dem Ereignis "statechanged" aufgetreten sind.

aus(targetOrTypeopt , typeOrListeneropt , Höreropt)
mixins/evented.js, zeile 398

Entfernt Listener (s) aus Ereignissen eines eventierten Objekts.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt <optional>

Wenn dies eine Zeichenfolge oder ein Array ist, repräsentiert es den Ereignistyp (en).

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, in diesem Fall
    ALLE 3 Argumente sind _erforderlich_.
TypeOrListener string | Array | Funktion <optional>

Wenn das erste Argument eine Zeichenfolge oder ein Array war, kann dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes ereignisbezogenes Objekt war, ist dies die Hörerfunktion; andernfalls werden alle an den Ereignistyp(en) gebundenen Hörer entfernt.
Mischt sich ein:

aus(targetOrTypeopt , typeOrListeneropt , Höreropt)
mixins/evented.js, zeile 398

Entfernt Listener (s) aus Ereignissen eines eventierten Objekts.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt <optional>

Wenn dies eine Zeichenfolge oder ein Array ist, repräsentiert es den Ereignistyp (en).

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, in diesem Fall
    ALLE 3 Argumente sind _erforderlich_.
TypeOrListener string | Array | Funktion <optional>

Wenn das erste Argument eine Zeichenfolge oder ein Array war, kann dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes ereignisbezogenes Objekt war, ist dies die Hörerfunktion; andernfalls werden alle an den Ereignistyp(en) gebundenen Hörer entfernt.
Mischt sich ein:

An(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 257

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

An(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 257

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

einer(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 309

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu. Der Listener wird einmal pro Ereignis aufgerufen und dann entfernt.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

einer(targetOrType, typeOrListener, listeneropt)
mixins/evented.js, zeile 309

Fügen Sie einem Ereignis (oder Ereignissen) für dieses Objekt oder ein anderes eventiertes Objekt einen Listener hinzu. Der Listener wird einmal pro Ereignis aufgerufen und dann entfernt.

Parameter:
Nennen Typ Attribute Beschreibung
TargetorType string | Array | Element | Objekt

Wenn es sich um eine Zeichenfolge oder ein Array handelt, repräsentiert es den Ereignistyp (en), die den Listener auslösen.

    Stattdessen kann hier ein anderes ereignisgesteuertes Objekt übergeben werden, das
    veranlassen den Listener, auf Ereignisse für _das_ Objekt zu warten.

    In beiden Fällen wird der `this'-Wert des Hörers an
    dieses Objekt.
TypeOrListener string | Array | Funktion

Wenn das erste Argument eine Zeichenfolge oder ein Array war, sollte dies die Listener-Funktion sein. Andernfalls ist dies eine Zeichenfolge oder ein Array von Ereignistypen.
Hörer Funktion <optional>

Wenn das erste Argument ein anderes eventiertes Objekt war, ist dies die Listener-Funktion.
Mischt sich ein:

setState(stateUpdates) → {Object|undefined}
mixins/stateful.js, Zeile 37

Legen Sie den Status eines Objekts fest, indem Sie sein State-Objekt an Ort und Stelle mutieren.

Parameter:
Nennen Typ Beschreibung
StateUpdate Objekt | Funktion

Ein neuer Satz von Eigenschaften, die in den Plugin-Status verschmelzen sollen. Kann ein einfaches Objekt oder eine Funktion sein, die ein einfaches Objekt zurückgibt.
Brände:
Gibt zurück:
Objekt | unbestimmtes -

Ein Objekt, das aufgetretene Änderungen enthält. Wenn keine Änderungen aufgetreten sind, wird undefined zurückgegeben.

Mischt sich ein:
  • module:stateful~StatefulMixin.setState

setState(stateUpdates) → {Object|undefined}
mixins/stateful.js, Zeile 37

Legen Sie den Status eines Objekts fest, indem Sie sein State-Objekt an Ort und Stelle mutieren.

Parameter:
Nennen Typ Beschreibung
StateUpdate Objekt | Funktion

Ein neuer Satz von Eigenschaften, die in den Plugin-Status verschmelzen sollen. Kann ein einfaches Objekt oder eine Funktion sein, die ein einfaches Objekt zurückgibt.
Brände:
Gibt zurück:
Objekt | unbestimmtes -

Ein Objekt, das aufgetretene Änderungen enthält. Wenn keine Änderungen aufgetreten sind, wird undefined zurückgegeben.

Mischt sich ein:
  • module:stateful~StatefulMixin.setState

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

Löst ein Ereignis am Plugin-Objekt aus und überschreibt EventedMixin.trigger.

Parameter:
Nennen Typ Attribute Standardwert Beschreibung
Ereignis string | Objekt

Ein Ereignistyp oder ein Objekt mit einer type-Eigenschaft.
Hash Objekt <optional>
 {}

Zusätzlicher Daten-Hash zum Zusammenführen mit a PluginEventHash.

Gibt zurück:
boolescher Wert -

Ob der Ausfall verhindert wurde oder nicht.

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

Löst ein Ereignis auf dieses eventierte Objekt aus, wodurch seine Listener aufgerufen werden.

Parameter:
Nennen Typ Attribute Beschreibung
Ereignis string | Objekt

Ein Ereignistyp oder ein Objekt mit einer type-Eigenschaft.
Hash Objekt <optional>

Ein zusätzliches Objekt, das an Hörer weitergegeben werden soll.
Gibt zurück:
boolescher Wert -

Ob das Standardverhalten verhindert wurde oder nicht.

Mischt sich ein:

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

Löst ein Ereignis auf dieses eventierte Objekt aus, wodurch seine Listener aufgerufen werden.

Parameter:
Nennen Typ Attribute Beschreibung
Ereignis string | Objekt

Ein Ereignistyp oder ein Objekt mit einer type-Eigenschaft.
Hash Objekt <optional>

Ein zusätzliches Objekt, das an Hörer weitergegeben werden soll.
Gibt zurück:
boolescher Wert -

Ob das Standardverhalten verhindert wurde oder nicht.

Mischt sich ein:

Ausführung()
plugin.js , Linie 228

Holen Sie sich die Version des Plugins, die aktiviert war .VERSION

Geben Sie Definitionen ein

PluginEventHash
plugin.js , Linie 511

Eigenschaften:
Nennen Typ Beschreibung
Beispiel String

Bei einfachen Plugins der Rückgabewert der Plugin-Funktion. Bei erweiterten Plugins die Plugin-Instanz, auf der das Ereignis ausgelöst wird.
Name String

Der Name des Plugins.
Plugin String

Für grundlegende Plugins die Plugin-Funktion. Für erweiterte Plugins die Plugin-Klasse/der Konstruktor.

Veranstaltungen

entsorgen
plugin.js , Linie 294

Signalisiert, dass ein erweitertes Plugin verworfen werden soll.

Typ: