Beispiel für Brightcove Spieler: Alle Zeit-Videoansichten

In diesem Thema erfahren Sie, wie Sie die All-Time-Ansichten für jedes in einen Player geladene Video anzeigen.

Einschränkungen

Beispiel eines Spielers

Der folgende Spieler enthält eine Wiedergabeliste, die Ihnen zeigt, dass der Code, der zum Abrufen aller Zeitansichten verwendet wird, mit Wiedergabelisten funktioniert. Es funktioniert auch mit einem einzelnen Videoplayer.

Sie sollten die Allzeitansichten für das erste Video sehen, das unter dem Player angezeigt wird. Wähle andere Videos in der Wiedergabeliste aus, um ihre All-Time-Ansichten anzuzeigen. Beachten Sie, dass der Berichtsbereich Ansichten für einen kurzen Zeitraum leer ist, wenn die Daten abgerufen werden.

Sehen Sie sich die Pen 18154-All-Time-Videoaufrufe von Brightcove Learning Services (@rcrooks1969) auf CodePen an.

Quellcode

Sehen Sie sich die Komplettlösung auf GitHub an.

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

API-Methoden API-Ereignisse API-Eigenschaften Verwendete Nicht-Spieler-APIs
spielen () loadedmetadaten player.mediainfo.id Analytics-API
eins ()      
am ()      

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

Ein <div> HTML-Tag mit einem class von vjs-playlist und einem id von bcls_alltimePlaysPlaylist wird als Speicherort für die Wiedergabeliste hinzugefügt.

Ablauf der Anwendung

Die grundlegende Logik hinter dieser Anwendung lautet:

  • Erstellen Sie ein HTML-Element, um die Ansicht-Informationen zu speichern. Dies ist ein dynamisch erstelltes <p> Tag, das dynamisch im DOM platziert wird.
  • Rufen Sie die ID des ersten Videos ab, das im Player platziert wurde, um seine Allzeitansichten abzurufen.
  • Setup, um die IDs anderer Videos während der Wiedergabe von der Wiedergabeliste abzurufen
  • Bereiten Sie sich darauf vor, das zu machen Analytics API Anfrage für das gewünschte Video.
  • Mach das Analytics API Anfrage für das gewünschte Video.
  • Zeigt die zurückgegebenen Views Daten an.

Erstellen und platzieren Sie dynamisch ein HTML-Absatzelement

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

// +++ Create the element to hold the video views +++

Hier wird ein Absatzelement erstellt, gestylt und platziert. Beachten Sie, dass der Code das Vorhandensein einer Wiedergabeliste bei der Bestimmung der Platzierung berücksichtigt.

Listener für zukünftige Anfragen festlegen

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

// +++ Set listener for future requests +++

Aufgrund einiger Initialisierungsaufgaben wird das erste loadedmetadata Ereignis mit der one() Methode verwendet. Danach verwendet der Code die on() Methode, um alle folgenden loadedmetadata Ereignisausschüsse zu behandeln.

Holen Sie sich die ID des Videos, das ursprünglich im Player platziert wurde.

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

// +++ Get the current video id from mediainfo then start process to get views count +++

Die ID ist Teil des mediainfo Objekts.

Bereiten Sie Informationen für die Anfrage an die Proxy/Analytics-API vor

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

// +++ Prepare information for request to proxy/Analytics API +++

Dies ist fast Standardcode, der für alle Brightcove REST API-Aufrufe und Details im Learning Guide verwendet wird: Verwenden des REST-API-Dokuments.

Telefonieren Sie tatsächlich die Proxy/Analytics-API

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

// +++ Prepare information for request to proxy/Analytics API +++

Dies ist fast Standardcode, der für alle Brightcove REST API-Aufrufe und Details im Learning Guide verwendet wird: Verwenden des REST-API-Dokuments.

Styling der Anwendung

Das verwendete CSS formt die Größe und Platzierung der Playlist der Playlist.

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: all-time-views.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.

Proxy-Code

Um Ihre eigene Version der Beispiel-App auf dieser Seite zu erstellen, müssen Sie Ihren eigenen Proxy erstellen und hosten. (Die von Brightcove Learning Services verwendeten Proxys akzeptieren nur Anfragen von Brightcove-Domains.) Ein Beispielproxy, der dem von uns verwendeten sehr ähnlich ist, aber ohne die Prüfungen, die Anfragen von Nicht-BrightCove-Domänen blockieren, kann in diesem GitHub-Repository gefunden werden. Dort finden Sie auch grundlegende Anweisungen zur Verwendung und eine ausführlichere Anleitung zum Erstellen von Apps rund um den Proxy unter Verwenden der REST-APIs.