Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Schritt für Schritt: Player Verwaltung

    Dieses Dokument bietet eine praktische Einführung in die grundlegenden Operationen des Player Management API.

    Einführung

    In diesem schrittweisen Dokument führen Sie die folgenden Aufgaben aus:

    • Erstelle einen Spieler
    • Aktualisieren Sie die player um das Video automatisch abzuspielen
    • Anpassen a player durch Hinzufügen eines Plugins
    • Zeigen Sie die Konfiguration für a an player

    Schnellster Start

    Der Ansatz dieses schrittweisen Dokuments besteht darin, Curl-Anweisungen zu verwenden, um mit dem zu kommunizieren Player Service-API. Das Curl-Tool wird in der Befehlszeile verwendet, um Daten mit URL-Syntax zu übertragen. Weitere Informationen zu Curl erhalten Sie von http://curl.haxx.se.

    Der Einfachheit halber müssen Sie Curl nicht wie in diesem Schritt-für-Schritt-Dokument verwenden. Sie können natürlich Ihre bevorzugte Sprache verwenden, um mit den APIs zu kommunizieren. Besuche die Setup für Player-Management-Beispiele Hier wird gezeigt, wie Sie mithilfe der Basisauthentifizierung, AJAX und JavaScript einige Mini-Apps für grundlegende Aufgaben wie das Erstellen von a schreiben playerund zeigt alle Ihre players, löschen players usw.

    Bevor Sie mit der Verwendung der API beginnen können, müssen einige vorbereitende Schritte unternommen werden. Diese sind:

    • Melden Sie sich bei Studio an. Wenn Sie mehrere Konten haben, wählen Sie in der Dropdown-Liste das Konto aus, in dem Sie Ihr neues Konto erstellen möchten players. Damit das Anmeldeinformationssystem ordnungsgemäß funktioniert, müssen Sie über Administratorrechte für dieses Konto verfügen. Wenn Sie nicht sicher sind, ob ein Benutzer über Administratorrechte verfügt, rufen Sie die Seite Benutzereinstellungen auf, um die zusammen mit ihrer Rolle aufgelisteten Benutzer anzuzeigen.
    • Vergewissern Sie sich in Studio, dass Sie ausgewählt haben HOME aus den Listen der Module. In der oberen linken Ecke der Seite können Sie, direkt unter dem Kontonamen, Ihre Kopie kopieren Konto-ID.
      Konto-ID zum Kopieren
    • Geben Sie in der Befehlszeile Folgendes ein, um den Konto-ID-Wert einer Umgebungsvariablen zuzuweisen:
              export ACCOUNT_ID=YourAccountID
              
              
    • Die Authentifizierung erfolgt, indem Sie die E-Mail-Adresse Ihres Kontos als Teil der curl-Anweisung angeben. Anschließend fordert die API Sie zur Eingabe eines Kennworts auf. Da die E-Mail-Adresse häufig verwendet wird, weisen Sie diesen Wert auch einer Umgebungsvariablen zu:
              export EMAIL=YourEmailAddress
              
              

    Sie können jetzt die API verwenden.

    Erstelle einen Spieler

    Sie können jetzt eine erstellen player mit einem Anruf bei der Player Management API. Dieser API - Aufruf wird in der Player Management API Überblick Dokument. Es wird empfohlen, die folgenden curl-Anweisungen in die Befehlszeile zu kopieren und einzufügen.

    Die folgenden Schritte unterstützen Sie beim Erstellen eines player.

    1. Die erste Curl-Anweisung erstellt die player und weist einen Namen und eine Beschreibung zu. Nachdem Sie diese Anweisung in die Befehlszeile eingefügt und gedrückt haben Weiter, werden Sie nach Ihrem Passwort gefragt.
              curl \
                --header "Content-Type: application/json" \
                --user $EMAIL \
                --request POST \
                --data '{
                  "name": "My New Player Name v2",
                  "description": "My new player description"
                  }' \
                https://players.api.brightcove.com/v1/accounts/$ACCOUNT_ID/players
              

      Sie sehen, dass der Server Antwortdaten im JSON-Format zurückgibt:

              {
                "id": "S1qN4xeG7",
                "url": "http://players.brightcove.net/1507807800001/S1qN4xeG7_default/index.html",
                "embed_code": "<iframe src='//players.brightcove.net/1507807800001/S1qN4xeG7_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
                "embed_in_page": "http://players.brightcove.net/1507807800001/S1qN4xeG7_default/in_page.embed",
                "preview_url": "http://preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/index.html",
                "preview_embed_in_page": "http://preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/in_page.embed",
                "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
              }
              
    2. Zeigen Sie Ihre player Wenn Sie einen (oder alle) der folgenden Werte verwenden (zu diesem Zeitpunkt befindet sich kein Video in der playerSie können jedoch ein Video mit Ihrem neu erstellten Video veröffentlichen player mit Studio):
      • Kopieren Sie die url in einen Browser, um Ihre zu sehen player.
      • Kopieren Sie die embed_code in eine HTML-Seite, um Ihre anzuzeigen player in einem Iframe. Damit dies ordnungsgemäß funktioniert, muss die Seite mit dem Iframe von einem tatsächlichen HTTP-Server bereitgestellt werden.
      • Der embed_in_page Feature-Verwendung ist detailliert in der Verfügbare Optionen für den erweiterten Einbettungscode (in-page) Dokument.

    Video Cloud Videos

    Natürlich können Sie eine erstellen player mit einem Video von Ihrem Video Cloud Bibliothek. Anstelle von a media Abschnitt in den JSON-Daten verwenden Sie ein video_cloud Sektion. Die folgende Curl-Anweisung zeigt player Erstellung mit a Video Cloud Video ID.

            curl \
              --header "Content-Type: application/json" \
              --user $EMAIL \
              --request POST \
              --data '{
                "name": "Video Cloud CURL 10 March",
                "configuration": {
                  "video_cloud": {
                    "video": "4093372393001"
                  }
                }
              }' \
            https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
            

    Die Antwort entspricht logisch der Antwort beim Erstellen von a player Verwendung von Medien / Quellen / src wie oben gezeigt.

            {
            "id": "HJyMlHiuZ",
            "url": "http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/index.html",
            "embed_code": "<iframe src="//players.brightcove.net/1507807800001/HJyMlHiuZ_default/index.html" allowfullscreen="" webkitallowfullscreen="" mozallowfullscreen=""></iframe>",
            "embed_in_page": "http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/in_page.embed",
            "preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/preview/embeds/default/master/index.html",
            "preview_embed_code": "<iframe src="//preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/preview/embeds/default/master/index.html" allowfullscreen="" webkitallowfullscreen="" mozallowfullscreen=""></iframe>"
            }
            
            

    Du kannst das ... sehen playerKonfiguration durch Durchsuchen des zurückgegebenen URL-Werts und Ändern des index.html zu config.json. Für die player Mit der obigen Curl-Anweisung wird Folgendes angezeigt:

            {
              "account_id": "1507807800001",
              "compatibility": true,
              "embed_id": "default",
              "player": {
                "template": {
                  "name": "single-video-template",
                  "version": "6.5.0"
                }
              },
              "player_id": "HJyMlHiuZ",
              "player_name": "Video Cloud CURL 10 March",
              "updated_at": "2017-08-23T17:48:55.622Z",
              "video_cloud": {
                "policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT",
                "video": "4093372393001"
              }
            }
            

    Der policy_key wird automatisch zum hinzugefügt playerKonfiguration. Dies wird mit dem erstellt Policy APIund es werden spezielle Einschränkungen für Sie festgelegt player für den Zugriff auf verschiedene Videos. Mit anderen Worten, der Richtlinienschlüssel steuert, welche Videos wann angezeigt werden können.

    Aktualisieren Sie a player

    Sie haben nun die Grundlagen zum Erstellen eines player. Als nächstes lernen Sie, wie Sie ein einfaches Update des durchführen player. In diesem Fall legen Sie die player um das Video in der automatisch abzuspielen player, wenn vom Browser erlaubt.

    1. In der zurückgegebenen JSON von player Schöpfung an id Wert wurde angezeigt. Kopiere dies in ein PLAYER_ID variable Umgebung
              export PLAYER_ID=YourPlayerID
              
              
    2. Um das zu aktualisieren player Sie werden das HTTP verwenden PATCH Methode. Sie senden Daten, um Ihre zu aktualisieren player. Sie werden die einstellen autoplay Option zu true. Kopieren Sie die folgende curl-Anweisung und fügen Sie sie ein und führen Sie sie aus.
              curl \
                --header "Content-Type: application/json" \
                --user $EMAIL \
                --request PATCH \
                --data '{
                  "autoplay": true
                }' \
              https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
              
    3. Stellen Sie sicher, dass der Server Daten zurückgibt, die den Server enthalten id , preview_url und preview_embed_code Werte im folgenden JSON-Format:
              {
                "id": "S1qN4xeG7",
                "preview_url": "http://preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/index.html",
                "preview_embed_in_page": "http://preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/in_page.embed",
                "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v2/accounts/1507807800001/players/S1qN4xeG7/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
              }
              
    4. Verwenden Sie entweder die preview_url or preview_embed_code Werte, um die Änderungen in Ihrem zu sehen playerKonfiguration. Sie werden sehen, dass die automatische Wiedergabe jetzt wahr ist.
    5. Jetzt veröffentlichen Sie die player um es an den richtigen Ort zu verschieben, damit Benutzer es anzeigen können. Geben Sie den folgenden Befehl ein:
              curl \
              --header "Content-Type: application/json" \
              --user $EMAIL \
              --request POST \
              https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/publish
              
              

      Sobald die player veröffentlicht wird, haben Sie players, die sich von den Vorschauversionen unterscheiden. Die veröffentlichten Versionen unterscheiden sich in folgenden Punkten von den Vorschauversionen:

      • JavaScript und CSS werden minimiert, verkettet und in das eingebunden player direkt.
      • Eine niedrig auflösende Version des Posterbildes wird generiert und in die Seite eingezeichnet, um die wahrgenommenen Ladezeiten in Netzwerken mit einer hohen Anforderungszeit (z. B. Mobilfunkdatennetzwerken) zu verbessern.
      • Die vorherige Version des player wird gespeichert, damit es wiederhergestellt werden kann, wenn nach dem Update Probleme festgestellt werden live.
    6. Überprüfen Sie, ob die JSON-Antwort vom Veröffentlichen der player erscheint wie folgt:
              {
              "id": "S1qN4xeG7",
              "url": "http://players.brightcove.net/1507807800001/S1qN4xeG7_default/index.html",
              "embed_code": "<iframe src='//players.brightcove.net/1507807800001/S1qN4xeG7_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
              "embed_in_page": "http://players.brightcove.net/1507807800001/S1qN4xeG7_default/in_page.embed"
              }
              
              
    7. Verwenden Sie eine der player Implementierungen, um sicherzugehen, dass Sie veröffentlicht player funktioniert richtig.

    Anpassen a player

    Sie können anpassen, Ihre player mit Plugins. Sie können lernen, wie Sie bereits vorhandene Plugins in Ihr Plugin aufnehmen player oder bauen Sie Ihre eigenen in der Schritt für Schritt: Plugin-Entwicklung.

    In diesem Fall verwenden Sie ein sehr einfaches, bereits vorhandenes Plugin, um eine Textnachricht auf dem Video zu überlagern. Es folgt der Code für ein Plugin, das ein HTML-Absatz-Tag erstellt. Hinweis: Dem Absatz wird ein Klassenname und ein Text zugewiesen, der dann an den vorhandenen angehängt wird player. Dieses Plugin ist bereits vorhanden und befindet sich unter //solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js.

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

    Der Absatz muss formatiert sein, um in diesem speziellen Fall schwarzen Text auf schwarzem Hintergrund zu verhindern. Die folgenden Stile werden auf den Klassennamen des Absatzes angewendet. Dieses Stylesheet existiert bereits zu Ihrer Bequemlichkeit und befindet sich bei //solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css.

            .vjs-overlay {
              background-color: #333333;
              color: white;
              font-size: 2em;
              padding: 5px;
              position: absolute;
              top: 100px;
              left: 20px;
              width: 150px;
            }
            
            

    So wie Sie eine Curl-Anweisung verwendet haben, um die Videoquelle und das Posterbild zuzuweisen, werden Sie eine Curl-Anweisung verwenden, um das zu erkennen player die folgende:

    • Speicherort der JavaScript-Datei, die den Code für das Plugin enthält
    • Speicherort des Stylesheets
    • Der Name des Plugins, der mit dem verwendet werden soll player
    1. Verwenden Sie die folgende curl-Anweisung, um das Plugin funktionsfähig zu machen.
              curl\
              --header "Content-Type: application/json"\
              --user $EMAIL\
              --request PATCH\
              --data '{
                "scripts": [
                  "//solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"
                 ],
                 "stylesheets": [
                  "//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
              
    2. Verwenden Sie die folgende Curl-Anweisung, um die Aktualisierung zu veröffentlichen player. Dies ist derselbe Veröffentlichungscode, den Sie im vorherigen Abschnitt zum Veröffentlichen von a verwendet haben player.
              curl \
                --header "Content-Type: application/json" \
                --user $EMAIL \
                --request POST \
                https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/publish
              
    3. Kopieren Sie die zurückgegebene URL und durchsuchen Sie sie. Sie werden sehen, dass das Plugin funktioniert und der Plugin-Text angezeigt wird.
      Plugintext
      Plugintext

    Wenn ein Plugin zum hinzugefügt wird player Verwendung der Player Management APISei es ein von Brightcove bereitgestelltes Plugin oder ein benutzerdefiniertes Plugin, das Sie erstellt haben, das Plugin wird Teil des player Code selbst.

    Konfiguration anzeigen

    Um Ihre geleistete Arbeit zu debuggen und zu bestätigen, ist es oft hilfreich, a anzuzeigen playerKonfiguration.

    1. Verwenden Sie dazu a GET Methode mit der configuration URL.
              curl \
                --header "Content-Type: application/json" \
                --user $EMAIL \
                --request GET \
                https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
              
              
    2. Überprüfen Sie, ob die Antwort zur JSON-Konfiguration der folgenden ähnelt:
              {
                "media": {
                  "poster": {
                    "highres": "//solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
                  },
                  "sources": [{
                    "type": "application/x-mpegURL",
                    "src": "//solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
                  }, {
                    "type": "video/mp4",
                    "src": "//solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
                  }]
                },
                "compatibility": true,
                "video_cloud": {
                  "video": "4093372393001",
                  "policy_key": "BCpkADawqM3ugPRAtcx48_C4FjXiEiJORcRFnXkeL9siQUpauO_o7SaIhSnYvM24nUCeD74UFG1LMW8vtmaftsO1vYeeOn2iglfvEbG-c0PYwJ_zQCQGsvkrbgrNyEDvbEKjyrsQVXj0DOco"
                },
                "player": {
                  "template": {
                    "name": "single-video-template",
                    "version": "6.7.0"
                  }
                },
                "scripts": ["//solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
                "stylesheets": ["//solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
                "plugins": [{
                  "name": "firstPlugin"
                }]
              }
              

    Ein anderer Weg, um einen Blick auf die playerDie Konfiguration erfolgt durch Durchsuchen des zurückgegebenen URL-Werts und Ändern des index.html zu config.json.

    Bereitstellungssystem-APIs

    Der Delivery System APIs ermöglichen die Verwaltung und Bereitstellung einer Gruppe von Dateien, die als Repository bezeichnet werden. Diese Dateien werden über REST-APIs und über Git verwaltet. Diese APIs sollten von den meisten Benutzern beim Erstellen oder Bearbeiten nicht benötigt werden players, aber sie können eine sehr interessante Reihe von APIs sein, die für andere Zwecke verwendet werden können. Wenn Sie sie ausprobieren möchten, können Sie mach das hier. Für eine praktische Einführung, probieren Sie die Schritt für Schritt: Liefersystem Dokument.


    Seite zuletzt aktualisiert am 29