Beispiel für Brightcove Spieler: Benutzerdefinierte Live-Fehlermeldung

In diesem Thema erfahren Sie, wie Sie ein benutzerdefiniertes Overlay-Bild anzeigen, wenn ein Benutzer versucht, einen nicht verfügbaren Live-Videostream abzuspielen.

Beispiel eines Spielers

Der Spieler kann sich nicht mit dem Livestream verbinden. Es wird ein ModalDialog-Objekt erstellt, ein benutzerdefiniertes Bild darin platziert und dann der ModalDialog angezeigt. Wenn der ModalDialog geschlossen ist, wird der Standardfehler angezeigt.

Siehe die Pen 18199-live-custom-error-message von Brightcove Learning Services (@rcrooks1969) auf CodePen.

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
addChild () Fehler player.error () .code
am () modalclose    
dauer ()    
player.errorDisplay.Hide ()    
player.errorDisplay.show ()    

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

Der Seite werden keine anderen HTML-Elemente hinzugefügt.

Ablauf der Anwendung

Die grundlegende Logik hinter dieser Anwendung lautet:

  • Erstellen Sie eine Instanz eines ModalDialog und platzieren Sie ein benutzerdefiniertes Bild darin.
  • Hören Sie auf einen Fehler, und wenn es sich um den richtigen Fehlertyp handelt, zeigen Sie den benutzerdefinierten ModalDialog an.
  • Wenn der Betrachter des Videos den benutzerdefinierten ModalDialog schließen möchte, zeigen Sie die Standardfehlermeldung an.

Erstellen Sie ein div HTML-Element

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

// ### Create a div in which to place HTML content and place image inside ###

Sie erstellen ein div HTML-Element und platzieren ein Bild darin, das Sie anzeigen möchten, wenn der Live-Feed nicht funktioniert.

Baue ein Objekt, in das das div HTML-Element platziert wird

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

  // ### Define options object to be used for modal content ###

Dies ist erforderlich, wenn Sie den ModalDialog erstellen.

Erstellen Sie den ModalDialog und platzieren Sie das Bild als Inhalt

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

// ### Create Modal with options object ###

Dies ist Standardcode, um eine ModalDialog-Instanz zu erstellen und sie dem Player hinzuzufügen. Standardmäßig wird es NICHT angezeigt.

Hören Sie auf einen Fehler, der ausgelöst werden soll

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

// ### Listen for an error event ###

Wenn ein Fehler ausgelöst wird, rufen Sie den Fehlercode und die Dauer ab.

Überprüfen Sie den Fehlertyp

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

  // ### Check if the error code and duration mean no video has loaded ###

Um zu überprüfen, ob ein Live-Stream nicht abgespielt wird, verwenden Sie Folgendes:

if ((errNo = „4" & Dauer = 0) | (errNo = „4" &
Number.isNaN (Dauer)))) {
  // Fehleranzeige ausblenden
  myPlayer.errorDisplay.hide ();
  // Wenn die Bedingungen erfüllt sind, wird das benutzerdefinierte Modal angezeigt
  myModal.open ();
}}

Die Zustandsprüfung errNo == "4" && duration == 0 funktioniert für Chrome und Firefox. Die zweite Zustandsprüfung errNo == "4" && Number.isNaN(duration) wird für Safari und Browser unter Android benötigt.

Standardfehler anzeigen ist benutzerdefinierter ModalDialog ist geschlossen

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

// ### If custom modal error closed, show the default error ###

Dies geschieht nur, wenn Sie dieses Verhalten implementieren möchten. Hören Sie einfach auf das modalclose Ereignis und zeigen Sie in seinem Event-Handler den Standardfehler an.

Styling der Anwendung

Das einzige CSS dimensioniert den Player einfach.

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: liveCustomError.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.