Playlist-API-Anleitung

Überblick

Die folgenden Methoden, Ereignisse und Konfigurationsoptionen sind als Teil der API verfügbar:

Beispiel

Der folgende Brightcove Player hat eine Wiedergabeliste geladen und mit den Schaltflächen können Sie sich in der Wiedergabeliste bewegen.

Nächstes Video

Vorheriges Video

Zum 4. Video springen

Playlist Item Object

autoadvance () Methode

Das player.playlist.autoadvance( ) Die Methode fungiert nur als Setter und legt die automatische Weiterentwicklung der Wiedergabeliste fest. Nach der Aktivierung wird am Ende eines Videos die angegebene Anzahl von Sekunden gewartet, bevor automatisch mit dem nächsten Video fortgefahren wird. Jeder Wert, der keine positive, endliche Ganzzahl ist, wird als Aufforderung behandelt, das automatische Vorrücken abzubrechen und zurückzusetzen. Wenn Sie die Funktion für den automatischen Vorlauf während eines Zeitlimits ändern, wird der automatische Vorlauf abgebrochen und nicht zum nächsten Video weitergeleitet, sondern der neue Wert für das Zeitlimit für die folgenden Videos verwendet.

Parameter:

• timeout:: Eine Ganzzahl in Sekunden, die verzögert werden muss, bevor das nächste Video in die Wiedergabeliste geladen wird

Zurückgegebener Wert:

Die Methode gibt keinen Wert zurück.

Beispielanwendungen der Methode folgen:

player.playlist.autoadvance(0); Will not wait before loading the next item

player.playlist.autoadvance(5); Waits 5 seconds before loading the next item

player.playlist.autoadvance(null); Resets and cancels the auto advance

enthält () Methode

Das player.playlist.contains( item ) Methode überprüft eine Wiedergabeliste auf das Vorhandensein des Objekts in der item Parameter. Wenn die item ist in der Wiedergabeliste true wird zurückgegeben, wenn nicht vorhanden false ist zurück gekommen.

Parameter:

• item:: Ein Wert, der ein Videoelement in der Wiedergabeliste darstellt.

Zu den gültigen Formularen für den Artikelparameter gehören:

• URL zu einem Video als String

  '//media.w3.org/2010/05/sintel/trailer.mp4'

• Array mit einem Objekt mit definierter Quelle und Typ

  [{
    src: '//media.w3.org/2010/05/sintel/poster.png',
    type: 'image/png'
  }]

• Objekt, das ein Element aus dem Quellen-Array enthält

  {
    sources: [{
      src: '//media.w3.org/2010/05/sintel/trailer.mp4',
      type: 'video/mp4'
    }]
  }

• In der Video Cloud können Sie die verwenden currentSrc() Methode mit dem contains() Methode, um sicherzustellen, dass das aktuell abgespielte Video aus der aktuell geladenen Wiedergabeliste stammt.

  myPlayer.playlist.contains(myPlayer.currentSrc());

Zurückgegebener Wert:

Die Methode gibt ein Objekt vom Typ zurück boolean.

currentIndex () -Methode

Das player.playlist.currentIndex( ) Methode ruft den Index des aktuellen Elements in der Wiedergabeliste ab. Dies ist identisch mit dem Aufruf currentItem() ohne Argumente.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt einen Wert vom Typ number zurück. Der zurückgegebene Wert stellt die Array-Position des Videos dar, das derzeit im Player abgespielt wird. Wenn der Player gerade ein Video ohne Wiedergabeliste abspielt, currentIndex() wird zurückkehren -1.

currentItem () -Methode

Die player.playlist.currentItem(index) Methode fungiert sowohl als Getter als auch als Setter und ruft entweder den aktuellen Index des Videos aus der im Player abgespielten Playlist ab oder weist basierend auf dem Index ein neues Video zur Wiedergabe im Player zu. Wenn sie ohne Argument aufgerufen wird, führt die Methode den Abruf durch und fungiert als Getter, wobei ein Argument den Wert zuweist und als Setter fungiert.

Parameter (Setter):

• index:: Eine Zahl, die den auf Null basierenden Array-Index aus der Wiedergabeliste des Videos darstellt, das in den Player geladen werden soll.

Zurückgegebener Wert (Getter):

Die Methode gibt einen Wert vom Typ zurück number. Der zurückgegebene Wert stellt die Array-Position des Videos dar, das derzeit im Player abgespielt wird. Wenn der Player gerade ein Video ohne Wiedergabeliste abspielt, currentItem() wird zurückkehren -1.

Ein Beispiel für die Verwendung der Methode in einer Funktion zum Springen zu einem bestimmten Video folgt:

function goto2(){
  myPlayer.playlist.currentItem(2);
}

first () Methode

Das player.playlist.first() Methode spielt das erste Element in der Wiedergabeliste. Das neue Video, das im Player abgespielt wird, wird von diesem Methodenaufruf zurückgegeben. Der currentItem wird mit dem neuen Index aktualisiert.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt ein Objekt vom Typ zurück object. Ein Beispiel für dieses Objekt für eine manuell erstellte Wiedergabeliste folgt:

Ein Beispiel für dieses Objekt für eine Video Cloud-Wiedergabeliste folgt:

Ein Beispiel für die Verwendung der Methode in einer Funktion, um zum nächsten Video zu wechseln, folgt:

function goToBeginning() {
  var nextVidObject = myPlayer.playlist.first();
}

indexOf () -Methode

Das player.playlist.indexOf( item ) Methode überprüft die Wiedergabeliste auf das Vorhandensein des Objekts in der item Wenn der Parameter gefunden wird, wird der auf Null basierende Index des Elements zurückgegeben. Die Methode gibt zurück -1 wenn der Artikel nicht gefunden wird.

Parameter:

• item:: Ein Wert, der ein Videoelement in der Wiedergabeliste darstellt.

Zu den gültigen Formularen für den Artikelparameter gehören:

• URL zu einem Video als String

  '//media.w3.org/2010/05/sintel/trailer.mp4'

• Array mit einem Objekt mit definierter Quelle und Typ

  [{
    src: '//media.w3.org/2010/05/sintel/poster.png',
    type: 'image/png'
  }]

• Objekt, das ein Element aus dem Quellen-Array enthält

  {
    sources: [{
      src: '//media.w3.org/2010/05/sintel/trailer.mp4',
      type: 'video/mp4'
    }]
  }

• In der Video Cloud können Sie die verwenden currentSrc() Methode mit dem indexOf() Methode zum Ermitteln des Speicherorts des aktuell wiedergegebenen Videos in der Wiedergabeliste.

  myPlayer.playlist.indexOf(myPlayer.currentSrc());

Zurückgegebener Wert:

Die Methode gibt einen Wert vom Typ zurück number. Der Wert stellt die nullindizierte Position des Elements dar oder -1, wenn das Objekt nicht gefunden wird.

last () Methode

Das player.playlist.last() Methode spielt das letzte Element in der Wiedergabeliste. Das neue Video, das im Player abgespielt wird, wird von diesem Methodenaufruf zurückgegeben. Der currentItem wird mit dem neuen Index aktualisiert.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt ein Objekt vom Typ zurück object. Ein Beispiel für dieses Objekt für eine manuell erstellte Wiedergabeliste folgt:

Ein Beispiel für dieses Objekt für eine Video Cloud-Wiedergabeliste folgt:

Ein Beispiel für die Verwendung der Methode in einer Funktion, um zum nächsten Video zu wechseln, folgt:

function goToEnd() {
  var nextVidObject = myPlayer.playlist.last();
}

lastIndex () -Methode

Das player.playlist.lastIndex( ) Methode gibt den Index des letzten Elements in der Wiedergabeliste zurück.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt einen Wert vom Typ zurück number. Der zurückgegebene Wert repräsentiert die Array-Position des letzten Videos in der Wiedergabeliste.

next () Methode

Das player.playlist.next() Die Methode bringt den Spieler zum nächsten Element in der Wiedergabeliste. Das neue Video, das im Player abgespielt wird, wird von diesem Methodenaufruf zurückgegeben. Der currentItem wird mit dem neuen Index aktualisiert. Wenn Sie sich am Ende der Wiedergabeliste befinden, können Sie das Ende nicht mehr fortsetzen und es wird nichts zurückgegeben.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt ein Objekt vom Typ zurück object. Ein Beispiel für dieses Objekt für eine manuell erstellte Wiedergabeliste folgt:

Ein Beispiel für dieses Objekt für eine Video Cloud-Wiedergabeliste folgt:

Ein Beispiel für die Verwendung der Methode in einer Funktion, um zum nächsten Video zu wechseln, folgt:

function nextVideo() {
  var nextVidObject = myPlayer.playlist.next();
}

nextIndex () -Methode

Das player.playlist.nextIndex( ) Methode gibt den Index des nächsten Elements in der Wiedergabeliste zurück.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt einen Wert vom Typ zurück number. Der zurückgegebene Wert gibt die Array-Position des nächsten Videos an, das in der Wiedergabeliste abgespielt wird.

Befindet sich der Spieler auf dem letzten Gegenstand, gibt diese Methode den Index des letzten Gegenstands zurück. Wenn sich die Wiedergabeliste jedoch wiederholt und sich auf dem letzten Element befindet, wird die Methode zurückgegeben 0. Wenn der Player gerade ein Video ohne Wiedergabeliste abspielt, wird es zurückgegeben -1.

playlist () Methode

Das player.playlist(newPlayList) Die Methode fungiert sowohl als Getter als auch als Setter und ruft entweder die Wiedergabeliste ab, die gerade im Player abgespielt wird, oder weist dem Player eine Wiedergabeliste zum Spielen zu. Wenn sie ohne Argument aufgerufen wird, führt die Methode den Abruf durch und fungiert als Getter, wobei ein Argument den Wert zuweist und als Setter fungiert.

Parameter (Setter):

• newPlaylist:: Eine Reihe von Videoquellen / -objekten. Die Objekte können entweder manuell erstellt werden oder einfach eine Video Cloud-Wiedergabelisten-ID oder eine Referenz-ID.

Obwohl Sie die verwenden können playlist() Als Setter empfiehlt es sich, die Katalogfunktionalität von Brightcove Player zum Laden einer Wiedergabeliste zu verwenden myPlayer.catalog.getPlaylist( playlistID ) und myPlayer.catalog.load( playlist ). Siehe die Spielerkatalog Dokument für weitere Informationen.

Ein Beispiel für die Verwendung der Methode mit einer manuell erstellten Wiedergabeliste folgt:

myPlayer = this;
myPlayer.playlist([{
  "sources": [{
    "src": "//solutions.brightcove.com/bcls/assets/videos/Sea_SeaHorse.mp4", "type": "video/mp4"
  }],
  "name": "Seahorse",
  "thumbnail": "//solutions.brightcove.com/bcls/assets/images/Sea_Seahorse_poster.png",
  "poster": "//solutions.brightcove.com/bcls/assets/images/Sea_Seahorse_poster.png"
}, {
  "sources": [{
    "src": "//solutions.brightcove.com/bcls/assets/videos/Sea_Anemone.mp4", "type": "video/mp4"
  }],
  "name": "Sea Anemone",
  "thumbnail": "//solutions.brightcove.com/bcls/assets/images/Sea_Anemone_poster.png",
  "poster": "//solutions.brightcove.com/bcls/assets/images/Sea_Anemone_poster.png"
}, {
  "sources": [{
    "src": "//solutions.brightcove.com/bcls/assets/videos/Tiger.mp4", "type": "video/mp4"
  }],
  "name": "Tiger",
  "thumbnail": "//solutions.brightcove.com/bcls/assets/images/Tiger_poster.png",
  "poster": "//solutions.brightcove.com/bcls/assets/images/Tiger_poster.png"
}, {
  "sources": [{
    "src": "//solutions.brightcove.com/bcls/assets/videos/Sea_ClownFish.mp4", "type": "video/mp4"
  }],
  "name": "Clownfish",
  "thumbnail": "//solutions.brightcove.com/bcls/assets/images/Sea_ClownFish_poster.png",
  "poster": "//solutions.brightcove.com/bcls/assets/images/Sea_ClownFish_poster.png"
}, {
  "sources": [{
    "src": "//solutions.brightcove.com/bcls/assets/videos/Sea_LionFish.mp4", "type": "video/mp4"
  }],

Zurückgegebener Wert (Getter):

Die Methode gibt eine zurück array of objects.

Es folgt ein Beispiel für eine zurückgegebene Video Cloud-Wiedergabeliste (eine Reihe von Video Cloud-Videoobjekten):

Das folgende Beispiel zeigt die Verwendung der Katalogobjekte getPlaylist() und load() Methoden zum Laden einer Video Cloud-Wiedergabeliste. Wie bereits erwähnt, ist dies der empfohlene Ansatz bei der Verwendung von Video Cloud-Wiedergabelisten. Weitere Informationen finden Sie in der Spielerkatalog Dokument.

myPlayer = this;
myPlayer.catalog.getPlaylist('1754200320001', function(error, playlist){
  myPlayer.catalog.load(playlist);
  console.log('mediainfo', myPlayer.mediainfo);
)};

console.log('playlist id: ', myPlayer.options()['data-playlist-id']);

vorherige () Methode

Das previous() Methode spielt das vorherige Element in der Wiedergabeliste ab. Das neue Video, das im Player abgespielt wird, wird von diesem Methodenaufruf zurückgegeben. Der currentItem wird mit dem neuen Index aktualisiert. Wenn Sie sich am Anfang der Wiedergabeliste befinden, können Sie den Start nicht fortsetzen und es wird nichts zurückgegeben.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt ein Objekt vom Typ zurück object. Ein Beispiel für dieses Objekt für eine manuell erstellte Wiedergabeliste folgt:

Ein Beispiel für dieses Objekt für eine Video Cloud-Wiedergabeliste folgt:

Ein Beispiel für die Verwendung der Methode in einer Funktion zum Verschieben zum vorherigen Video folgt:

function previousVideo() {
  myPlayer.playlist.previous();
}

vorherigeIndex () -Methode

Das player.playlist.previsousIndex( ) Die Methode gibt den Index des Videos zurück, in dem das aktuell im Player abgespielte Video fortgesetzt wird.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt einen Wert vom Typ zurück number. Der zurückgegebene Wert stellt die Array-Position des Videos dar, mit dem das aktuell im Player abgespielte Video fortgesetzt wird.

Befindet sich der Spieler auf dem ersten Gegenstand, kehrt die Methode zurück 0. Wenn sich die Wiedergabeliste jedoch wiederholt und sich auf dem ersten Element befindet, wird der Index des letzten Elements zurückgegeben. Wenn der Player gerade ein Video ohne Wiedergabeliste abspielt, wird es zurückgegeben -1.

wiederhole () Methode

Sie können eine Wiedergabeliste wiederholen, nachdem das letzte Video in der Wiedergabeliste beendet wurde playlist.repeat() Methode. Diese Funktion spielt das erste Video in der Wiedergabeliste ab, sobald das letzte Video in der Wiedergabeliste fertig ist.

Parameter:

• Boolescher Wert, der angibt, ob die Wiedergabeliste wiederholt werden soll oder nicht; Standard ist false

Zurückgegebener Wert:

Der aktuelle Wert von playlist.repeat

Die Methode legt den Wert durch Übergabe fest true oder false als Argument. Wenn kein Argument verwendet wird, gibt die Methode den aktuellen Wert zurück. Der folgende Code zeigt die Implementierung:

• Zeilen 1-11: Standard-Playlist-Player-Code mit Ausnahme von id wird mit einem Wert von addiert myPlayerID.
• Zeile 16: Legt fest, dass die Wiedergabeliste wiederholt wird.
• Zeile 17: Zeigt die Methode in Aktion als Getter an. Zeigt in der Konsole den Wert von an repeat.

<video-js id="myPlayerID"
    data-playlist-id="5455901760001"
    data-account="1507807800001"
    data-player="SyMOsyA-W"
    data-embed="default"
    data-application-id=""
    controls=""></video-js>
  <script src="https://players.brightcove.net/1507807800001/SyMOsyA-W_default/index.min.js"></script>

  <div class="vjs-playlist"></div>

<script type="text/javascript">
  videojs.getPlayer('myPlayerID').ready(function() {
    var myPlayer = this;
    myPlayer.playlist.repeat(true);
    console.log('myPlayer.repeat()',myPlayer.playlist.repeat());
  });
</script>

reverse () Methode

Das player.playlist.reverse( ) Die Methode ändert die Reihenfolge der Videos in der Wiedergabeliste, sodass das erste Video das letzte und das letzte Video das erste wird.

Parameter:

• Keine

Zurückgegebener Wert:

Die Methode gibt keinen Wert zurück.

Kehrt die Reihenfolge der Videos in der Wiedergabeliste um. Beispielsweise wird das erste Video zum letzten und das letzte Video zum ersten.

Die Methode löst das playlistsorted Ereignis nach dem Rückwärtsfahren aus.

shuffle () -Methode

Das player.playlist.shuffle( ) Die Methode mischt / randomisiert die Reihenfolge der Wiedergabelistenelemente.

Parameter:

• Optional rest Möglichkeit: Standardmäßig wird die gesamte Wiedergabeliste zufällig ausgewählt. Dies ist jedoch möglicherweise nicht in allen Fällen wünschenswert, z. B. wenn ein Benutzer bereits ein Video ansieht. Wann true Wird diese Option übergeben, werden nur Wiedergabelistenelemente nach dem aktuellen Element gemischt. Wenn Sie beispielsweise das erste Element verwenden, mischt die Methode nur das zweite Element und darüber hinaus. Die Syntax zur Verwendung des Parameters lautet:

  player.playlist.shuffle({rest: true});

Zurückgegebener Wert:

Die Methode gibt keinen Wert zurück.

Diese Methode mischt die Elemente in der Wiedergabeliste mit Fisher-Yates-Shuffle-Algorithmus.

Die Methode versendet die playlistsorted Ereignis nach dem Mischen.

Wenn Sie beim ersten Laden des Players eine Wiedergabeliste mischen möchten, müssen Sie diese verwenden Methode in einem Event-Handler für die playlistsorted Veranstaltung. Dies verhindert den Zustand, in dem die Methode versucht, die Wiedergabeliste zu mischen, bevor sie in den Player geladen wird. Beispielsyntax ist:

myPlayer.on("duringplaylistchange", function() {
  myPlayer.playlist.shuffle();
});

sort () Methode

Das player.playlist.sort( ) Methode sortiert die Videos in einer Wiedergabeliste auf eine Weise, die mit JavaScript identisch ist Array.prototype.sort () Methode.

Parameter:

• compareFunction:: Eine Funktion, die definiert, wie die Videos sortiert werden sollen.

Zurückgegebener Wert:

Die Methode gibt keinen Wert zurück.

Ein Beispiel für die Verwendung der Methode zum Sortieren der Videos nach duration folgt:

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  myPlayer.on('loadedmetadata', function(){
    myPlayer.playlist.sort(function(a, b) {
      return a.duration - b.duration;
    });
  });
});

Die Methode löst das playlistsorted Ereignis nach dem Rückwärtsfahren aus.

beforeplaylistitem event

Das beforeplaylistitem Das Ereignis wird ausgelöst, bevor zu einer neuen Inhaltsquelle innerhalb einer Wiedergabeliste gewechselt wird (dh wenn eine von currentItem() , first() usw. wird aufgerufen), aber bevor der Status des Spielers geändert wurde.

während des Playlistchange-Ereignisses

Das duringplaylistchange Das Ereignis wird ausgelöst, nachdem der Inhalt der Wiedergabeliste beim Aufruf geändert wurde playlist() , aber bevor das aktuelle Wiedergabelistenelement geändert wird. Das Ereignisobjekt hat mehrere spezielle Eigenschaften:

• nextIndex: Der Index aus der nächsten Wiedergabeliste, der zuerst abgespielt wird.
• nextPlaylist: Ein flacher Klon der nächsten Wiedergabeliste.
• previousIndex: Der Index aus der vorherigen Wiedergabeliste (stimmt immer mit dem aktuellen Index überein, wenn dieses Ereignis ausgelöst wird, wird jedoch der Vollständigkeit halber bereitgestellt).
• previousPlaylist: Ein flacher Klon der vorherigen Wiedergabeliste.

Vorbehalte

Während des Auslösens dieses Ereignisses wird davon ausgegangen, dass sich die Wiedergabeliste in einem sich ändernden Zustand befindet, der folgende Auswirkungen hat:

• Aufrufen der Hauptwiedergabelistenmethode, player.playlist([...]) wird einen Fehler auslösen.
• Navigationsmethoden für Wiedergabelisten, first , last , next und previous , werden funktionsunfähig gemacht.
• Das currentItem() Methode fungiert nur als Getter.
• Während die Sortiermethoden, sort , reverse und shuffle , wird weiterarbeiten, sie versenden die nicht playlistsorted Veranstaltung.
•  

Warum dieses Ereignis nutzen?

Dieses Ereignis bietet die Möglichkeit, den Einstellungsprozess für die Wiedergabeliste abzufangen, bevor eine neue Quelle auf dem Player und vor dem eingestellt wird playlistchange Ereignis wird ausgelöst, während eine konsistente Wiedergabelisten-API bereitgestellt wird. Ein Anwendungsfall könnte das Mischen einer Wiedergabeliste sein, die gerade von einem Server stammt, aber bevor die ursprüngliche Quelle in den Player geladen oder die Benutzeroberfläche der Wiedergabeliste aktualisiert wird:

player.on('duringplaylistchange', function() {
  // Remember, this will not trigger a "playlistsorted" event!
  player.playlist.shuffle();
});

player.on('playlistchange', function() {
  videojs.log('The playlist was shuffled, so the UI can be updated.');
});

Wiedergabelistenwechselereignis

Das playlistchange Das Ereignis wird asynchron ausgelöst, wenn die Wiedergabeliste geändert wird. Wenn dieses Ereignis ausgelöst wird, lädt der Player das erste Video in die neue Wiedergabeliste. Es wird asynchron ausgelöst, damit der Browser das erste Video in die neue Wiedergabeliste lädt.

Playlistitem-Ereignis

Das playlistitem Ereignis wird ausgelöst, wenn zu einer neuen Inhaltsquelle innerhalb einer Wiedergabeliste gewechselt wird (dh wenn eine von currentItem() , first() usw. wird aufgerufen), nachdem der Status des Spielers geändert wurde, aber bevor die Wiedergabe fortgesetzt wurde.

Wiedergabelistenereignis

Das playlistsorted Das Ereignis wird ausgelöst, wenn eine Methode aufgerufen wird, die die Reihenfolge der Wiedergabelistenelemente ändert sort() , reverse() oder shuffle().

PlayonSelect

Dieser Wert ist eine Konfigurationsoption, die auf gesetzt ist true bewirkt, dass ein angeklicktes Video aus der Wiedergabeliste abgespielt wird, auch wenn das aktuelle Video im Player zuvor angehalten wurde. Standardmäßig wird das neue Video durch Klicken auf ein neues Video aus der Wiedergabeliste das neue Video geladen, aber der Player pausiert, wenn er vorher angehalten wurde.

Informationen zur Bearbeitung dieses Wertes finden Sie in der Player-Konfigurationshandbuch - Abschnitt Wiedergabelisten.

Visuelle Wiedergabelisten

Wenn Sie eine visuelle Darstellung der Wiedergabeliste auf Ihrer Seite wünschen, müssen Sie den Player dafür konfigurieren. Sie können die Konfiguration mit Studio im Internet aktualisieren PLAYERS > Styling Abschnitt, wie hier gezeigt (Sie können entweder eine vertikale oder eine horizontale Wiedergabeliste auswählen):

Wenn Sie möchten, können Sie auch die Player-Verwaltungs-API verwenden, um Ihren Player für Wiedergabelisten zu konfigurieren. Siehe die Playlists Abschnitt der Player-Konfigurationshandbuch für vollständige Informationen.

Sie können programmgesteuert überprüfen, ob Wiedergabelisten aktiviert sind, indem Sie überprüfen, ob der Wert von player.playlistUi ist definiert.

console.log('myPlayer.playlistUi:', myPlayer.playlistUi);