Beispiel für Brightcove Spieler: Am häufigsten gesehene Videos in Playlist

Beispiel eines Spielers

Im folgenden Beispiel sehen Sie den Spieler mit einer Wiedergabeliste auf der rechten Seite. Die Wiedergabeliste wird ausgefüllt, indem die beliebtesten Videos basierend auf den meisten Wiedergaben mithilfe des Brightcove Player-Katalogs abgerufenwerden.

Siehe die Pen 18175-meistgebeobachtet-Video-Playlist von Brightcove Learning Services (@bcls1969) auf CodePen.

Quellcode

Sehen Sie sich die Komplettlösung auf GitHub an.

Überblick

In diesem Beispiel werden die am häufigsten angesehenen Videos aus Ihrem Konto mithilfe des Brightcove Player-Katalogs zurückgegeben, der auf die Playback-API zugreift. Es ist ähnlich wie bei Beliebte Video-Playlist Beispiel, das Daten aus der Analytics-API verwendet. Es gibt einige Unterschiede, die zu beachten sind:

Brightcove Player-Katalog (Wiedergabe-API)

  • Das plays_total Feld ist die Videoaufrufe aller Zeiten für ein Video.
  • Sie können die Catalog.getSearch () -Methode verwenden, um Daten einfach von der Playback-API abzurufen.

Analytics-API

  • Wenn Sie den from Parameter und den Wert nicht angeben, sind die letzten 30 Tage der Standardwert.
  • Um die gleichen Ergebnisse aus dem zu erhalten Analytics API Verwenden Sie die, die Sie von der Wiedergabe-API erhalten würden ?alltime URL-Parameter in der API-Anforderung.

CodePen verwenden

Hier sind einige Tipps zur effektiven Verwendung des obigen CodePen:

  • Schalten Sie die tatsächliche Anzeige des Players um, indem Sie auf klicken Result Taste.
  • Drücke den HTML/CSS/JS Schaltflächen zur Anzeige EINES der Codetypen.
  • Später in diesem Dokument werden die Logik, der Ablauf und das Styling der Anwendung in der Player/HTML-Konfiguration, im Anwendungsfluss und im Anwendungsstyling diskutiert Abschnitte. Der beste Weg, um den Informationen in diesen Abschnitten zu folgen, besteht darin:
    1. Drücke den EDIT ON CODEPEN Klicken Sie im CodePen auf die Schaltfläche und halten Sie den Code in einem Browser / einer Browser-Registerkarte bereit.
    2. Passen Sie in CodePen an, welcher Code angezeigt werden soll. Sie können die Breite verschiedener CodeAbschnitte in CodePen ändern.
    3. Sieh den Player-/HTML-Konfiguration , Bewerbungsablauf und/oder Bewerbungsstyling Abschnitte in einem anderen Browser/Browser-Tab. Sie können nun den Codeerklärungen folgen und gleichzeitig den Code anzeigen.

Entwicklungs-Sequenz

Hier ist die empfohlene Entwicklungssequenz:

  1. Verwenden Sie die In-Page-Embed-Player-Implementierung, um die Funktionalität Ihres Players, Plugins und CSS zu testen (falls CSS benötigt wird)
  2. Legen Sie JavaScript und CSS des Plugins in separate Dateien zum lokalen Testen
  3. Stellen Sie den Plugin-Code und das CSS auf Ihrem Server bereit, sobald Sie Fehler herausgefunden haben
  4. Benutze Studio, um das Plugin und das CSS deinem Player hinzuzufügen
  5. Ersetzen Sie die In-Page-Embed-Player-Implementierung, wenn Sie feststellen, dass die Iframe-Implementierung besser passt (im nächsten Abschnitt beschrieben)

Weitere Informationen zu diesen Schritten finden Sie in der Schritt-für-Schritt-Anleitung: Leitfaden zur Entwicklung von Plugins

iframe oder In-Page einbetten

Bei der Entwicklung von Verbesserungen für den Brightcove Player müssen Sie entscheiden, ob der Code am besten für die Iframe- oder In-Page-Einbettungsimplementierung geeignet ist. Die Best Practice-Empfehlung besteht darin, ein Plugin zur Verwendung mit einer Iframe-Implementierung zu erstellen. Die Vorteile der Verwendung des iFrame-Players sind:

  • Keine Kollisionen mit vorhandenem JavaScript und/oder CSS
  • Reaktionsschnell
  • Der iframe erleichtert die Verwendung in Social-Media-Apps (oder wann immer das Video in andere Apps „reisen“ muss)

Obwohl die Integration des In-Page-Einbettungsplayers komplexer sein kann, planen Sie Ihren Code in dieser Implementierung manchmal. Um zu verallgemeinern, ist dieser Ansatz am besten, wenn die enthaltende Seite mit dem Spieler kommunizieren muss. Im Einzelnen sind hier einige Beispiele:

  • Der Code auf der enthaltenden Seite muss Spielerereignisse abhören und darauf reagieren
  • Der Player verwendet Stile von der enthaltenden Seite
  • Der Iframe führt dazu, dass die App-Logik fehlschlägt, wie eine Weiterleitung von der enthaltenen Seite

Selbst wenn Ihre endgültige Implementierung den Iframe-Code nicht verwendet, können Sie den In-Page-Einbettungscode trotzdem mit einem Plugin für Ihr JavaScript und einer separaten Datei für Ihr CSS verwenden. Dies kapselt Ihre Logik, sodass Sie sie problemlos in mehreren Spielern verwenden können.

Verwendete API/Plugin-Ressourcen

Spieler-API-Methoden
catalog.GetSearch ()
Playlist ()

Player-/HTML-Konfiguration

Dieser Abschnitt beschreibt jede spezielle Konfiguration, die während der Spielererstellung erforderlich ist. Darüber hinaus werden andere HTML-Elemente beschrieben, die der Seite über den In-Page-Einbettungsplayer-Implementierungscode hinaus hinzugefügt werden müssen.

Player-Konfiguration

Für den Brightcove Player, den Sie für dieses Beispiel erstellen, ist keine spezielle Konfiguration erforderlich.

Anderes HTML

Wenn Sie den Advanced (In-Page-Einbettung) Player verwenden, müssen Sie ein HTML-Element hinzufügen, um den Speicherort der Wiedergabeliste anzugeben. Einzelheiten finden Sie im Implementieren von Wiedergabelisten dokumentieren.

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

Denken Sie daran, das id Attribut dem video-js Tag im Einbettungscode des Spielers hinzuzufügen.

<video-js id="myPlayerID"
...

Ablauf der Anwendung

Die grundlegende Logik hinter dieser Anwendung lautet:

  • Definieren Sie die Suchparameter
  • Holen Sie sich die Videoobjekte
  • Die Wiedergabeliste laden

Definieren Sie die Suchparameter

Finden Sie den Code, der mit der Bezeichnung versehen ist:

// +++ Define the search parameters +++

Wenn Sie die Catalog.getSearch () -Methode verwenden, müssen Sie zuerst die Suchparameter definieren. Diese Abfrage gibt 10 Videos von Ihrem Konto zurück, die in absteigender Reihenfolge nach Videoaufrufen aller Zeiten sortiert sind (plays_total).

Da wir Videos in unserem Video Cloud-Konto suchen, müssen wir einen für die Suche aktivierten Richtlinienschlüssel verwenden.

Holen Sie sich die Videoobjekte

Finden Sie den Code, der mit der Bezeichnung versehen ist:

// +++ Get the video objects +++

Rufen Sie ein Array von Videoobjekten basierend auf den Suchparametern für die catalog.getSearch() Methode ab.

Die Wiedergabeliste laden

Finden Sie den Code, der mit der Bezeichnung versehen ist:

// +++ Load the playlist +++

Verwenden Sie die playlist() Methode, um die zurückgegebenen Videoobjekte in die Wiedergabeliste des Players zu laden.

Styling der Anwendung

CSS wird verwendet, um den Player und die Playlist zu stylen.

Plugin-Code

Normalerweise sind bei der Umwandlung des JavaScript in ein Brightcove Player-Plugin nominelle Änderungen erforderlich. Eine erforderliche Änderung besteht darin, die Standardverwendung der ready() Methode durch den Code zu ersetzen, der ein Plugin definiert.

Hier ist der sehr häufig verwendete Start zu JavaScript-Code, der mit dem Player funktioniert:

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  ...
});

Sie ändern die erste Zeile, um die Standardsyntax zum Starten eines Brightcove Player-Plugins zu verwenden:

videojs.registerPlugin('pluginName', function(options) {
  var myPlayer = this;
  ...
});

Wie bereits erwähnt, können Sie den JavaScript-Code des Plugins im entsprechenden GitHub Repo dieses Dokuments sehen: most-watched-playlist.js.

Verwenden des Plugins mit einem Player

Sobald Sie die CSS- und JavaScript-Dateien des Plugins an einem für das Internet zugänglichen Ort gespeichert haben, können Sie das Plugin mit einem Player verwenden. Im Studio SPIELER Modul können Sie einen Spieler wählen, dann in der PLUGINS fügen Sie die URLs zu den CSS- und JavaScript-Dateien hinzu und fügen Sie auch die Name und Optionen , wenn Optionen benötigt werden.