Die videojs()
Funktion dient gleichzeitig als Hauptfunktion für Benutzer zum Erstellen eines Spieler -Instanz sowie den Namensraum der Hauptbibliothek.
Es kann auch als Getter für ein bereits vorhandenes . verwendet werden Spieler Beispiel. Wir jedoch stark Verwendung empfehlen videojs.getPlayer()
für diesen Zweck, weil es jede Möglichkeit einer unbeabsichtigten Initialisierung vermeidet.
Wegen Einschränkungen unseres JSDoc-Templates können wir dies nicht sowohl als Funktion als auch als Namespace richtig dokumentieren, daher ist seine Funktionssignatur hier dokumentiert.
Argumente
id
Zeichenfolge|Element, erforderlich
Videoelement- oder Videoelement-ID.
Optionen
Objekt, optional
Options-Objekt zum Bereitstellen von Einstellungen. Siehe: Optionshandbuch.
bereit
Komponente~ReadyCallback , Optional
Eine Funktion, die aufgerufen wird, wenn die Spieler und Technik sind bereit.
Rückgabewert
Die videojs()
Funktion gibt a . zurück Spieler Beispiel.
Klassen
Mitglieder
-
statisch Browser :Objekt
-
Ein Hinweis auf die Browser-Utility-Modul als Objekt.
- Siehe:
-
statisch dom :Objekt
-
Ein Hinweis auf die DOM-Dienstprogrammmodul als Objekt.
- Siehe:
-
statisch Protokoll :Funktion
-
Ein Hinweis auf die log-Dienstprogrammmodul als Objekt.
- Siehe:
-
statisch Optionen :Objekt
-
Das globale Optionsobjekt. Dies sind die Einstellungen, die wirksam werden, wenn beim Erstellen des Players keine Überschreibungen angegeben werden.
-
statische Spieler :Objekt
-
Globale Aufzählung von Spielern.
Die Schlüssel sind die Spieler-IDs und die Werte sind entweder die Player-Instanz oder
Null
für entsorgte Spieler. -
statisch TOUCH AKTIVIERT :boolesch
-
Verwenden browser.TOUCH_ENABLED stattdessen; nur aus Gründen der Abwärtskompatibilität mit 4.x enthalten.
- Veraltet:
-
- Verwenden Sie seit Version 5.0 browser.TOUCH_ENABLED stattdessen.
-
statisch URL :Objekt
-
Ein Hinweis auf die URL-Dienstprogrammmodul als Objekt.
- Siehe:
-
statisch AUSFÜHRUNG :string
-
Aktuelle Video.js-Version. Folgt semantische Versionierung.
Methoden
-
statisch Sprache hinzufügen(Code, Daten) → {Objekt
-
Hinzufügen von Sprachen, damit sie für alle Spieler verfügbar sind. Beispiel:
videoJS.addLanguage ('es', {'Hello': 'Hola'});
Parameter:
Nennen Typ Beschreibung Code
String Der Sprachcode oder die Wörterbucheigenschaft
Daten
Objekt Die zu übersetzenden Datenwerte
Gibt zurück:
Objekt -Das resultierende Sprachwörterbuchobjekt
-
statisch bind(kontext, fn, uidopt) → {Funktion}
-
Binden (auch bekannt als Proxy oder Kontext). Eine einfache Methode zum Ändern des Kontextes einer Funktion.
Es speichert auch eine eindeutige ID in der Funktion, sodass sie leicht aus Ereignissen entfernt werden kann.
Parameter:
Nennen Typ Attribute Beschreibung Kontext
Gemischt Das Objekt, das als Bereich gebunden werden soll.
fn
Funktion Die Funktion, die an einen Bereich gebunden werden soll.
uid
Zahl <optional>
Eine optionale eindeutige ID für die zu setzende Funktion
Gibt zurück:
funktion -Die neue Funktion, die in den angegebenen Kontext gebunden wird
-
statisch berechneter Stil(el, Stütze)
-
Ein sicheres GetComputedStyle.
Dies wird benötigt, weil in Firefox, wenn der Player in einem iframe mit geladen wird
Anzeige: keine
, danngetComputedStyle
kehrt zurückNull
, also führen wir eine Nullprüfung durch, um sicherzustellen, dass der Player in diesen Fällen nicht kaputt geht.Parameter:
Nennen Typ Beschreibung el
Element Das Element, von dem Sie den berechneten Stil haben möchten
Requisite
String Der gewünschte Eigenschaftsname
-
statisch createTimeRange(Start Ende)
-
Erstellen Sie ein
TimeRange-Objekt, das eine HTML5 TimeRanges Instanz nachahmt.
Parameter:
Nennen Typ Beschreibung beginnen
nummer | Array.<Array> Der Beginn eines einzelnen Bereichs (eine Zahl) oder eines Arrays von Bereichen (ein Array von Arrays mit jeweils zwei Zahlen).
Ende
Zahl Das Ende eines einzelnen Bereichs. Kann nicht mit der Array-Form des
Start-Arguments verwendet werden.
-
statische CreateTimeranges(start, end)
-
Erstellen Sie ein
TimeRange-Objekt, das eine HTML5 TimeRanges Instanz nachahmt.
Parameter:
Nennen Typ Beschreibung beginnen
nummer | Array.<Array> Der Beginn eines einzelnen Bereichs (eine Zahl) oder eines Arrays von Bereichen (ein Array von Arrays mit jeweils zwei Zahlen).
Ende
Zahl Das Ende eines einzelnen Bereichs. Kann nicht mit der Array-Form des
Start-Arguments verwendet werden.
-
statisches deregisterPlugin(Name)
-
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
-
-
statische Erweiterung(SuperClass,SubClassMethods opt) → {Funktion}
-
Wird verwendet, um eine vorhandene Klasse unterzuordnen, indem die ES-Unterklasse mit dem emuliert wird
erweitert
Stichwort.Parameter:
Nennen Typ Attribute Standardwert Beschreibung SuperClass
Funktion Die Klasse, von der geerbt werden soll
SubClassMethods
Objekt <optional>
{} Methoden der neuen Klasse
Gibt zurück:
funktion -Die neue Klasse mit SubClassMethods, die SuperClass geerbt hat.
- Veraltet:
-
- Ja
Beispiel
var MyComponent = videojs.extend(videojs.getComponent('Component'), { myCustomMethod: function() { // Dinge in meiner Methode tun. } });
-
statisch formatTime(Sekunden, guide) → {string}
-
Delegiert entweder an die Standardzeitformatierungsfunktion oder eine benutzerdefinierte Funktion, die über
SetFormatTime bereitgestellt wird
.Formatiert Sekunden als Zeitzeichenfolge (H:MM:SS oder M:SS). Die Bereitstellung einer Anleitung (in Sekunden) zwingt eine Reihe führender Nullen, um die Länge der Führung abzudecken.
Parameter:
Nennen Typ Beschreibung Sekunden
Zahl Anzahl der Sekunden, die in eine Zeichenfolge umgewandelt werden sollen
Leitfaden
Zahl Zahl (in Sekunden), nach der die Zeichenfolge modelliert werden soll
Gibt zurück:
string -Zeit formatiert als H:MM:SS oder M:SS
Beispiel
formatTime (125, 600) === "02:05"
-
statisch getAllPlayers() → {Array}
-
Gibt ein Array aller aktuellen Spieler zurück.
Gibt zurück:
Array -Ein Array aller Spieler. Das Array wird in der Reihenfolge sein, dass
Objekt.Schlüssel
bietet, die möglicherweise zwischen JavaScript-Engines variieren können. -
statisch getComponent(name) → {Component}
-
Holen Sie sich eine
Komponente
basierend auf dem Namen, mit dem sie registriert wurde.Parameter:
Nennen Typ Beschreibung Name
String Der Name der abzurufen Komponente.
-
statischer getPlayer(id) → {Spieler|undefiniert}
-
Holen Sie sich einen Einzelspieler basierend auf einem ID- oder DOM-Element.
Dies ist nützlich, wenn Sie überprüfen möchten, ob ein Element oder eine ID über einen zugeordneten Video.js-Player verfügt, aber keinen erstellen möchten, wenn dies nicht der Fall ist.
Parameter:
Nennen Typ Beschreibung id
string | Element Ein HTML-Element -
< Video>
,< Audio->
, oder< video-js>
- oder eine Zeichenfolge, die zu passtIch würde
eines solchen Elements.Gibt zurück:
Spieler | nicht definiert -Eine Spielerinstanz oder
nicht definiert
wenn keine Spielerinstanz mit dem Argument übereinstimmt. -
static getPlayers() → {Objekt}
-
Holen Sie sich ein Objekt mit den aktuell erstellten Spielern, die von der Spieler-ID erfasst werden
Gibt zurück:
Objekt -Die erstellten Spieler
-
statisch getPlugin(name) → {function|undefined}
-
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}
-
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}
-
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.
-
statisch getTech(name) → {Tech|undefined}
-
Holen Sie sich einen
Tech
aus der freigegebenen Liste nach Namen.Parameter:
Nennen Typ Beschreibung Name
String CamelCase
oderTitleCase
Name des zu erlangenden TechGibt zurück:
Tech | unbestimmtes -Der
Tech
oder undefined, wenn es keine Technologie mit dem angeforderten Namen gab. -
statisch isCrossOrigin(url, winLocopt) → {boolean}
-
Gibt zurück, ob die übergebene URL eine domänenübergreifende Anfrage ist oder nicht.
Parameter:
Nennen Typ Attribute Beschreibung url
String Die zu überprüfende URL.
WinLoc
Objekt <optional>
Die Domäne, gegen die die URL überprüft werden soll, ist standardmäßig window.location
Immobilien
Nennen Typ Attribute Beschreibung Protokoll
String <optional>
Das Fensterspeicherprotokoll ist standardmäßig window.location protocol
Gastgeber
String <optional>
Der Host für den Fensterstandort ist standardmäßig window.location host
Gibt zurück:
boolescher Wert -Ob es sich um eine domainübergreifende Anfrage handelt oder nicht.
-
statisch mergeOptions(...sources) → {Object}
-
Füge zwei Objekte rekursiv zusammen.
Führt eine tiefe Zusammenführung wie lodash.merge durch, führt aber nur einfache Objekte (keine Arrays, Elemente oder irgendetwas anderes) zusammen.
Nicht einfache Objektwerte werden direkt aus dem Argument ganz rechts kopiert.
Parameter:
Nennen Typ Attribute Beschreibung Quellen
Array.<Objekt> <wiederholbar>
Ein oder mehrere Objekte, die zu einem neuen Objekt zusammengeführt werden sollen.
Gibt zurück:
Objekt -Ein neues Objekt, das das zusammengeführte Ergebnis aller Quellen ist.
-
statisch aus(elem, Typopt, fnopt)
-
Entfernt Ereignis-Listener aus einem Element
Parameter:
Nennen Typ Attribute Beschreibung Elem
Element | Objekt Objekt, aus dem Listener entfernt werden sollen.
Typ
string | Array.<Zeichenfolge> <optional>
Typ des zu entfernenden Listener. Schließen Sie nicht ein, um alle Ereignisse aus dem Element zu entfernen.
fn
eventTarget~EventListener <optional>
Bestimmter Listener, der entfernt werden soll Schließen Sie nicht ein, um Listener für einen Ereignistyp zu entfernen.
-
statisch auf(elem, type, fn)
-
Hinzufügen eines Ereignis-Listener zum Element Es speichert die Handler-Funktion in einem separaten Cache-Objekt und fügt dem Ereignis des Elements einen generischen Handler zusammen mit einer eindeutigen ID (guid) zum Element hinzu.
Parameter:
Nennen Typ Beschreibung Elem
Element | Objekt Element oder Objekt, an das Listener gebunden werden sollen
Typ
string | Array.<Zeichenfolge> Art des Ereignisses, an das gebunden werden soll.
fn
eventTarget~EventListener Event-Listener.
-
statisch (elem, type, fn)
-
Lösen Sie einen Listener nur einmal für ein Ereignis aus.
Parameter:
Nennen Typ Beschreibung Elem
Element | Objekt Element oder Objekt, an das gebunden werden soll.
Typ
string | Array.<Zeichenfolge> Name/Art des Ereignisses
fn
event~EventListener Ereignis-Listener-Funktion
-
statisch parseUrl(url) → {url:URLObject}
-
Lösen und analysieren Sie die Elemente einer URL.
Parameter:
Nennen Typ Beschreibung url
Zeichenfolge Die zu analysende URL
Gibt zurück:
url:urloBject -Ein Objekt von URL-Details
-
statisch Plugin(Name, Plugin)
-
Veraltete Methode zum Registrieren eines Plugins bei Video.js
Parameter:
Nennen Typ Beschreibung Name
String Der Plugin-Name
Plugin
Plugin | Funktion Die Plugin-Unterklasse oder -Funktion
- Veraltet:
-
- videojs.plugin() ist veraltet; verwende stattdessen videojs.registerPlugin()
-
statische RegisterComponent(Name, Zusammensetzung) → {Komponente}
-
Registrieren Sie eine Komponente, damit sie namentlich angesprochen werden kann. Wird beim Hinzufügen zu anderen Komponenten verwendet, entweder über addChild
Component.addChild ('myComponent')
oder über die standardmäßigen untergeordneten Optionen{children: ['myComponent']}
.HINWEIS: Sie können die Komponente auch einfach vor dem Hinzufügen initialisieren.
Komponente.addChild(neue MyComponent());
Parameter:
Nennen Typ Beschreibung Name
String Der Klassenname der Komponente
comp
Komponente Die Komponentenklasse
-
statisch registerPlugin(name, plugin) → {Funktion}
-
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.
-
statische RegisterTech(Name, Technologie)
-
Registriert einen
Tech
in einer freigegebenen Liste für Videojs.Parameter:
Nennen Typ Beschreibung Name
String Name des
Technik
zu registrieren.Tech
Objekt Die
Tech-Klasse zum Registrieren.
-
statisch resetFormatTime()
-
Setzt FormatTime auf die Standardimplementierung zurück.
-
statische setFormatTime(CustomImplementation)
-
Ersetzt die standardmäßige FormatTime-Implementierung durch eine benutzerdefinierte Implementierung.
Parameter:
Nennen Typ Beschreibung CustomImplementierung
Funktion Eine Funktion, die anstelle der standardmäßigen FormatTime-Implementierung verwendet wird. Erhält die aktuelle Zeit in Sekunden und den Guide (in Sekunden) als Argumente.
-
statisch trigger(elem, event, hashopt) → {boolean|undefined}
-
Löst ein Ereignis für ein Element aus
Parameter:
Nennen Typ Attribute Beschreibung Elem
Element | Objekt Element, auf dem ein Ereignis ausgelöst werden soll
Ereignis
eventTarget~Event | string Eine Zeichenfolge (der Typ) oder ein Ereignisobjekt mit einem type-Attribut
Hash
Objekt <optional>
Daten-Hash, der mit dem Ereignis weitergegeben werden soll
Gibt zurück:
boolean | undefined -Gibt das Gegenteil von
DefaultPrevented zurück,
wenn der Standardwert verhindert wurde. Andernfalls gibtundefined zurück
-
statische Verwendung(Typ, Middleware)
-
Definieren Sie eine Middleware, die der Player über eine Factory-Funktion verwenden soll, die ein Middleware-Objekt zurückgibt.
Parameter:
Nennen Typ Beschreibung Typ
String Der übereinstimmende MIME-Typ oder
„*“
für alle MIME-Typen.Middleware
MiddlewareFactory Eine Middleware-Factory-Funktion, die für übereinstimmende Typen ausgeführt wird.
-
static xhr(Optionen) → {xmlHttpRequest|xDomainRequest}
-
Ein browserübergreifender XMLHttpRequest-Wrapper.
Parameter:
Nennen Typ Beschreibung Optionen
Objekt Einstellungen für die Anfrage.
Gibt zurück:
XMLHttpRequest | XDomainRequest -Das Anfrageobjekt.