Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    Schritt für Schritt: Liefersystem-API

    Dieses Dokument bietet eine praktische Einführung in die Verwendung der Delivery System API zum Erstellen eines Repositorys (Repo), und im Repo speichern und aktualisieren Sie ein Plugin.

    Übersicht

    Hier sind die Schritte, die Sie ausführen werden:

    • Erstellen eines Repos mit der Delivery System API
    • Erstellen eines lokalen Ordners für die Speicherung von Dateien
    • Erstelle ein Plugin und kopiere es in das Repo
    • Verändern Sie den Player, um das neue Plugin zu verwenden
    • Ändern Sie das Plugin und beobachten Sie, dass der Spieler das geänderte Plugin verwendet

    Hinweis: Wenn Sie ein erfahrener Git-Benutzer sind, werden Sie sehen, dass einige der API-Aufrufe eine gleichwertige Funktionalität ausführen, die Sie auch in Git ausführen können. Tatsächlich führen einige API-Aufrufe zur Dateimanipulation einfach Git-Befehle aus.

    Voraussetzungen

    Um diese Schritt-für-Schritt-Anweisungen zu starten, wird davon ausgegangen, dass Sie Schritt für Schritt abgeschlossen haben: Spieler-Management. Durch das Abschließen dieser Aktivität haben Sie die folgenden Umgebungsvariablen in Ihrem Befehlszeilensystem definiert:

    • $ ACCOUNT_ID
    • $ PER E-MAIL
    • $ SPIELER_ID

    Repo erstellen

    Sie werden jetzt die Delivery System API verwenden, um ein Repo zu erstellen und Dateien in dieses Repo zu kopieren. Sobald das Repo erstellt wurde, können Sie die API auch verwenden, um Repos aufzulisten, Details eines Repos anzuzeigen, Repos zu löschen usw., aber in vielen Workflows ist dies nicht erforderlich.

    In einer curl-Anweisung zum Erstellen des neuen Repos verwenden Sie eine PUT HTTP-Methode und geben den Namen des neuen Repos in die URL ein. Führen Sie diese curl-Anweisung aus, um ein Repo mit dem Namen zu erstellen firstRepo.

        curl \
          --user $EMAIL \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo
        

    Sie erhalten eine Antwort, die die Erstellung von Repo bestätigt. Die Antwort zeigt: den Namen und die öffentliche URL zum Repo.

    • Name: Name des Repos
    • public_url: Die öffentliche URL zum Repo
    • repo_url: Die URL des Repository
        {
          "name": "firstRepo",
          "public_url": "http://players.brightcove.net/1507807800001/firstRepo",
          "repo_url": "https://repos.api.brightcove.com/v1/accounts/1507807800001/repos/firstRepo"
        }

    Ordner erstellen

    Als Nächstes müssen Sie lokal auf Ihrem Computer einen Ordner zum Speichern der mit Ihrem Brightcove Player verknüpften Dateien erstellen. Erstellen Sie an einem Ort Ihrer Wahl den Ordner und verschieben Sie (cd) dann in diesen Ordner.

        mkdir firstRepo
        cd firstRepo

    Plugin erstellen

    Jetzt erstellen Sie ein Plugin in Ihrem Ordner, das Sie in das Repo kopieren können. Verwenden Sie das gleiche Plugin aus dem Step-by-Step: Spielerverwaltung, außer den angezeigten Text zu ändern. Erstellen Sie die Datei, fügen Sie den Text von unten in die Datei ein und speichern Sie sie dann. Verwenden Sie denselben Dateinamen wie in Step-by-Step: Spieler-Management, first-plugin.js.

        videojs.registerPlugin('firstPlugin', function() {
          var player = this,
          overlay = document.createElement('p');
          overlay.className = 'vjs-overlay';
          overlay.innerHTML = "NEW TEXT!";
          player.el().appendChild(overlay);
        });

    Sie kopieren jetzt die neu erstellte Plugin-Datei in das Repo. Verwenden Sie die folgende cURL-Anweisung, um diese Aufgabe auszuführen.

        curl \
          --user $EMAIL \
          --form contents=@first-plugin.js \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo/files/first-plugin.js

    Nach der Kopie sollten Sie eine Bestätigung ähnlich der folgenden sehen:

        {
          "name": "first-plugin.js",
          "public_url": "http://players.brightcove.net/1507807800001/firstRepo/first-plugin.js"
        }

    Sie können bestätigen, dass die Datei korrekt kopiert wurde, indem Sie ihren Inhalt mit der folgenden cURL-Anweisung anzeigen.

        curl http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js

    Sie können die Datei auch anzeigen, indem Sie die von der Dateikopie public_url zurückgegebene durchsuchen.

    Verwenden Sie neues Plugin

    Im Schritt-für-Schritt: Spielerverwaltung Sie haben eine Curl-Anweisung verwendet, um dem Spieler den Speicherort des JavaScript-Codes für das Plugin zusammen mit dem CSS-Standort und dem Plugin-Namen mitzuteilen. Sie werden das Gleiche noch einmal tun, außer dass der Pfad zum Plugin diesmal den neuen Pfad verwendet, der in der Antwort der Dateikopie gefunden wurde (siehe Zeile 2 oben in der Kopierantwort). Führen Sie die folgende curl-Anweisung aus, um auf den neuen Plugin-Speicherort zu verweisen.

        curl \
          --header "Content-Type: application/json" \
          --user $EMAIL \
          --request PATCH \
          --data '{
            "scripts": [
              "http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js"
            ],
            "stylesheets": [
              "http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
            ],
            "plugins": [{
              "name": "firstPlugin"
            }]
          }' \
          https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

    Verwenden Sie den preview_url Returned, um den Player zu durchsuchen, und Sie sehen den neuen Text aus dem Plugin. Wenn Sie möchten, können Sie den Player auch veröffentlichen und die URL des veröffentlichten Spielers abrufen.

    Ändere Plugin

    Eine der Stärken bei der Verwendung des neuen Brightcove-Players ist die einfache Aktualisierung der Spieler durch eine einzige Änderung an einem Plugin, und alle Spieler, die dieses Plugin verwenden, werden aktualisiert. In diesem Punkt in den Schritten nehmen Sie eine kleine Änderung am Plugin vor und sehen es in Gebrauch, ohne Änderungen am Player selbst vorzunehmen.

    Öffnen Sie die first-plugin.js Datei und aktualisieren Sie den Text, um Newer Text zu lesen!

        overlay.innerHTML = "NEWer TEXT!";

    Kopieren Sie die Datei erneut in das Repo.

        curl \
          --user $EMAIL \
          --form contents=@first-plugin.js \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo/files/first-plugin.js

    Stöbern Sie noch einmal preview_url von oben. Hinweis: Aufgrund des Browser-Cachings müssen Sie möglicherweise die Browserregisterkarte schließen und erneut surfen oder sogar den Cache des Browsers löschen, um den Text aktualisiert zu sehen.

    Sobald Sie sehen, dass die neueste Version des Plugins funktioniert, können Sie Ihren Player veröffentlichen.


    Seite zuletzt aktualisiert am 28 Sep 2020