Überblick
Hier sind die Schritte, die Sie ausführen werden:
- Erstellen Sie ein Repository mit der Delivery System API
- Erstellen Sie einen lokalen Ordner für die Dateispeicherung
- Erstellen Sie ein Plugin und kopieren Sie es in das Repo
- Ändern Sie den Player, um das neue Plugin zu verwenden
- Ändern Sie das Plugin und beobachten Sie, wie der Player das geänderte Plugin verwendet
Hinweis: Wenn Sie ein erfahrener Git-Benutzer sind, werden Sie feststellen, dass einige der API-Aufrufe äquivalente Funktionen ausführen, die Sie auch in Git ausführen können. Tatsächlich führen einige der API-Aufrufe zur Dateimanipulation lediglich Git-Befehle aus.
Voraussetzungen
Um diese Schritt-für-Schritt-Anleitung zu starten, wird davon ausgegangen, dass Sie die Schritt für Schritt: Spielerverwaltung. Durch Abschluss dieser Aktivität haben Sie die folgenden Umgebungsvariablen in Ihrem Befehlszeilensystem definiert:
- {account_id}
- {player_id}
Repository erstellen
Sie verwenden nun die Delivery System API, um ein Repository zu erstellen und Dateien in dieses Repository zu kopieren. Sobald das Repository erstellt wurde, können Sie die API auch verwenden, um Repositorys aufzulisten, Details zu einem Repository anzuzeigen, Repositorys zu löschen usw., aber in vielen Workflows ist dies nicht erforderlich.
In einer curl-Anweisung zum Erstellen des neuen Repositorys verwenden Sie ein HTTP PUT -Methode und schließen Sie den Namen des neuen Repositorys in die URL ein. Führen Sie diese Curl-Anweisung aus, um ein 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, in der die Erstellung des Repos bestätigt wird. Die Antwort zeigt: den Namen und die öffentliche URL zum Repository.
- Name: Name des Repositorys
- öffentliche_url: Die öffentliche URL zum Repo
- repo_url: Die Repository-URL
{
"name": "firstRepo",
"public_url": "https://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 den Ordner an einem Ort Ihrer Wahl und verschieben Sie dann (cd) in diesen Ordner.
mkdir firstRepo
cd firstRepo
Plugin erstellen
Jetzt erstellen Sie ein Plugin in Ihrem Ordner, um es in das Repository zu kopieren. Verwenden Sie dasselbe Plugin aus der Schritt-für-Schritt-Anleitung: 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. Verwenden Sie denselben Dateinamen wie in der Schritt-für-Schritt-Anleitung: Spielerverwaltung, 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 nun die neu erstellte Plugin-Datei in das Repository. 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 dem Kopieren sollten Sie eine Bestätigung ähnlich der folgenden sehen:
{
"name": "first-plugin.js",
"public_url": "https://players.brightcove.net/1507807800001/firstRepo/first-plugin.js"
}
Sie können überprüfen, ob die Datei korrekt kopiert wurde, indem Sie ihren Inhalt mit der folgenden cURL-Anweisung anzeigen.
curl https://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.
Neues Plugin verwenden
Im Schritt-für-Schritt: Player Management Sie haben eine curl-Anweisung verwendet, um dem Player die Position des JavaScript-Codes für das Plugin zusammen mit dem CSS-Speicherort und dem Plugin-Namen mitzuteilen. Sie werden dasselbe erneut tun, außer dass der Pfad zum Plugin diesmal den neuen Pfad verwendet, der in der Antwort aus 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": [
"https://players.brightcove.net/{account_id}/firstRepo/first-plugin.js"
],
"stylesheets": [
"https://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 die zurückgegebene preview_url zum Durchsuchen des Players und Sie sehen den neuen Text aus dem Plugin angezeigt. Wenn Sie möchten, können Sie den Player auch veröffentlichen und die veröffentlichte Player-URL abrufen.
Plugin ändern
Eine der Stärken der Verwendung des neuen Brightcove-Players ist die einfache Aktualisierung von Playern durch eine einzige Änderung an einem Plugin, und alle Player, die dieses Plugin verwenden, werden aktualisiert. An diesem Punkt in den Schritten nehmen Sie eine kleine Änderung am Plugin vor und sehen es in Verwendung, ohne Änderungen am Player selbst vorzunehmen.
Öffne das first-plugin.js Datei und aktualisieren Sie den zu lesenden Text NEUER Text!
overlay.innerHTML = "NEWer TEXT!";
Kopieren Sie die Datei erneut in das Repository.
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 wieder von oben. Hinweis: Aufgrund des Browser-Caching müssen Sie möglicherweise den Browser-Tab schließen und erneut surfen oder sogar den Cache des Browsers leeren, um den aktualisierten Text anzuzeigen.
Sobald Sie sehen, dass die neueste Version des Plugins funktioniert, können Sie Ihren Player veröffentlichen.