Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Schritt für Schritt: Delivery System API

    Dieses Dokument bietet eine praktische Einführung in die Verwendung des Delivery System API um ein Repository (Repo) zu erstellen, und im Repo speichern und aktualisieren Sie ein Plugin.

    Überblick

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

    • Erstellen Sie ein Repo mit der Delivery System API
    • Erstellen Sie einen lokalen Ordner für den Dateispeicher
    • Erstellen Sie ein Plugin und kopieren Sie es in den Repo
    • Ändern Sie die player um das neue Plugin zu benutzen
    • Ändern Sie das Plugin und beachten Sie die player verwendet das geänderte Plugin

    Hinweis: Wenn Sie ein erfahrener Git-Benutzer sind, werden einige der API-Aufrufe gleichwertige Funktionen 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 schrittweisen Anweisungen zu starten, wird davon ausgegangen, dass Sie das ausgefüllt haben Schritt für Schritt: Player Verwaltung. Durch das Abschließen der Aktivität haben Sie die folgenden Umgebungsvariablen in Ihrem Kommandozeilensystem definiert:

    • $ ACCOUNT_ID
    • $ EMAIL
    • $PLAYER_ICH WÜRDE

    Erstellen Sie Repo

    Sie werden jetzt die verwenden Delivery System API 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. In vielen Workflows ist dies jedoch nicht erforderlich.

    In einer curl-Anweisung zum Erstellen des neuen Repos verwenden Sie ein HTTP PUT Methode und fügen Sie den Namen des neuen Repos in die URL ein. Führen Sie diese curl-Anweisung aus, um einen Repo namens 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 des Repos bestätigt. Die Antwort zeigt Folgendes an: Name und öffentliche URL des Repos.

    • Name: Name des Repos
    • public_url: Die öffentliche URL zum Repo
    • repo_url: Die Repository-URL
        {
          "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 einen Ordner auf Ihrem Computer erstellen, in dem die mit Ihrem Computer verknüpften Dateien gespeichert werden Brightcove Player. Erstellen Sie an einem Ort Ihrer Wahl den Ordner und verschieben Sie ihn (cd) 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 der Schritt-für-Schritt-Anleitung: Player Verwaltung, außer den angezeigten Text ändern. Erstellen Sie die Datei, fügen Sie den Text von unten in die Datei ein und speichern Sie ihn. Verwenden Sie den gleichen Dateinamen wie in der Schritt-für-Schritt-Anleitung: Player 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 werden nun die neu erstellte Plugin-Datei in den Repo kopieren. 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 den 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 public_url von der Dateikopie zurückgegeben.

    Verwenden Sie ein neues Plugin

    Schritt für Schritt: Player Management Sie haben eine Curl-Anweisung verwendet, um das zu sagen player den Speicherort des JavaScript-Codes für das Plugin sowie den CSS-Speicherort und den Namen des Plugins. Sie werden dasselbe erneut tun, außer dass der Pfad zum Plugin diesmal den neuen Pfad verwendet, der in der Antwort von der Dateikopie gefunden wurde (siehe Zeile 2 oben in der Antwort zum Kopieren). 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

    Benutze das zurückgegebene preview_url um die zu durchsuchen player und Sie sehen den neuen Text aus dem Plugin angezeigt. Wenn Sie möchten, können Sie auch die veröffentlichen player und das veröffentlichen lassen player URL.

    Plugin ändern

    Eine der Stärken der neuen Brightcove player ist die einfache Aktualisierung players durch eine einzige Änderung an einem Plugin und allem players, die dieses Plugin verwenden, werden aktualisiert. An dieser Stelle in den Schritten nehmen Sie eine kleine Änderung am Plugin vor und sehen, dass es verwendet wird, ohne Änderungen am player sich.

    Öffnen Sie die first-plugin.js Datei und aktualisieren Sie den zu lesenden Text NEUerer Text!

        overlay.innerHTML = "NEWer TEXT!";

    Kopieren Sie die Datei erneut in den 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

    Durchsuchen Sie das gleiche preview_url von oben wieder. Hinweis: Aufgrund des Browser-Cachings müssen Sie möglicherweise die Browser-Registerkarte schließen und erneut durchsuchen oder den Cache des Browsers löschen, um den aktualisierten Text anzuzeigen.

    Sobald Sie die neueste Version des Plugins sehen, können Sie Ihre veröffentlichen player.


    Seite zuletzt aktualisiert am 28. Juli 2020