Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    Schritt für Schritt: Playerverwaltung

    Dieses Dokument bietet eine praktische Einführung in die grundlegenden Funktionen der Player Management API.

    Einführung

    In diesem Schritt-für-Schritt-Dokument führen Sie die folgenden Aufgaben aus:

    • Erstellen eines Players
    • Aktualisieren Sie den Player, um das Video automatisch abzuspielen
    • Passen Sie einen Player an, indem Sie ein Plugin hinzufügen
    • Zeigen Sie die Konfiguration für einen Player an

    Erste Schritte

    In diesem schrittweisen Dokument werden Curl-Anweisungen verwendet, um mit der Player Service-API zu kommunizieren. 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 Lieblingssprache verwenden, um mit den APIs zu kommunizieren. Probier das aus 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 eines Players, das Anzeigen aller Player, das Löschen von Playern usw. schreiben.

    Bevor Sie die API verwenden können, müssen einige vorbereitende Schritte ausgeführt 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 Ihre neuen Spieler erstellen möchten. 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.
    • Stellen Sie in Studio sicher, dass Sie ausgewählt haben ZUHAUSE aus den Listen der Module. In der oberen linken Ecke der Seite können Sie direkt unter dem Kontonamen Ihre kopieren Konto-ID.
      Zu kopierende Konto-ID
    • Geben Sie in der Befehlszeile Folgendes ein, um einer Umgebungsvariablen den Konto-ID-Wert zuzuweisen:
              export ACCOUNT_ID=YourAccountID
              
              
    • Die Authentifizierung erfolgt durch Angabe der E-Mail-Adresse Ihres Kontos als Teil der Curl-Anweisung. Anschließend fordert Sie die API 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.

    Erstellen eines Players

    Sie können jetzt einen Player mit einem Aufruf der Player-Verwaltungs-API erstellen. Dieser API-Aufruf wird im ausführlich erläutert Player Management API - Übersicht Dokument. Es wird empfohlen, die folgenden Curl-Anweisungen zu kopieren und in die Befehlszeile einzufügen.

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

    1. Die erste Curl-Anweisung erstellt den Player und weist einen Namen und eine Beschreibung zu. Nachdem Sie diese Anweisung in die Befehlszeile eingefügt und gedrückt haben Eingeben werden Sie zur Eingabe Ihres Passworts aufgefordert.
              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 Ihren Player an, indem Sie einen (oder alle) der folgenden Werte verwenden (zu diesem Zeitpunkt befindet sich kein Video im Player, Sie können jedoch ein Video mit Ihrem neu erstellten Player in Studio veröffentlichen):
      • Kopiere das url in einen Browser, um Ihren Player zu sehen.
      • Kopiere das embed_code in eine HTML-Seite, um Ihren Player in einem Iframe anzuzeigen. Damit dies ordnungsgemäß funktioniert, muss die Seite mit dem Iframe von einem tatsächlichen HTTP-Server bereitgestellt werden.
      • Das embed_in_page Die Verwendung der Funktion ist in der Verfügbare Optionen für den erweiterten Einbettungscode (auf der Seite) Dokument.

    Video Cloud-Videos

    Natürlich können Sie einen Player mit einem Video aus Ihrer Video Cloud-Bibliothek erstellen. Anstatt a zu verwenden media Abschnitt in den JSON-Daten verwenden Sie a video_cloud Sektion. Die folgende Curl-Anweisung zeigt die Spielererstellung mit der ID eines Video Cloud-Videos.

            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 eines Players mit 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>"
            }
            
            

    Sie können die Konfiguration des Players anzeigen, indem Sie den zurückgegebenen URL-Wert durchsuchen und den ändern index.html zu config.json. Für den Spieler, der durch die obige Curl-Anweisung erstellt wurde, 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"
              }
            }
            

    Das policy_key wird automatisch zur Konfiguration des Players hinzugefügt. Dies wird mithilfe der Richtlinien-API erstellt und ermöglicht es Ihrem Player, besondere Einschränkungen für den Zugriff auf verschiedene Videos festzulegen. Mit anderen Worten, der Richtlinienschlüssel steuert, welche Videos wann angezeigt werden können.

    Aktualisiere einen Spieler

    Sie haben jetzt die Grundlagen zum Erstellen eines Players ausgeführt. Als nächstes lernen Sie, wie Sie ein einfaches Update des Players durchführen. In diesem Fall stellen Sie den Player so ein, dass das Video im Player automatisch wiedergegeben wird, sofern der Browser dies zulässt.

    1. In der von der Spielererstellung zurückgegebenen JSON ein id Wert wurde angezeigt. Kopieren Sie dies in eine PLAYER_ID Umgebungsvariable.
              export PLAYER_ID=YourPlayerID
              
              
    2. Um den Player zu aktualisieren, verwenden Sie HTTP PATCH Methode. Sie senden Daten, um Ihren Player zu aktualisieren. Sie werden die einstellen autoplay Option zu true. Kopieren Sie die folgende Curl-Anweisung, 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 das 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 oder preview_embed_code Werte, um die Änderungen in der Konfiguration Ihres Players anzuzeigen. Sie werden sehen, dass die automatische Wiedergabe jetzt wahr ist.
    5. Jetzt veröffentlichen Sie den Player, um ihn an den richtigen Ort zu verschieben, damit Benutzer ihn 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 der Player veröffentlicht ist, haben Sie Player, 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 direkt in den Player eingefügt.
      • Eine Version des Poster-Bildes mit niedriger Auflösung wird generiert und in die Seite eingefügt, um die wahrgenommenen Ladezeiten in Netzwerken mit einer hohen Anforderungs-Setup-Zeit (dh zellularen Datennetzen) zu verbessern.
      • Die vorherige Version des Players wird gespeichert, damit sie wiederhergestellt werden kann, wenn nach dem Start des Updates Probleme festgestellt werden.
    6. Stellen Sie sicher, dass die JSON-Antwort vom Veröffentlichen des Players wie folgt angezeigt wird:
              {
              "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 sicherzustellen, dass Ihr veröffentlichter Player ordnungsgemäß funktioniert.

    Passen Sie einen Spieler an

    Sie können Ihren Player mithilfe von Plugins anpassen. Sie können lernen, wie Sie bereits vorhandene Plugins in Ihren Player einbinden oder eigene Plugins in den Player einbauen Schritt für Schritt: Plugin-Entwicklung

    In diesem Fall verwenden Sie ein sehr einfaches, bereits vorhandenes Plugin, um eine Textnachricht über das Video zu legen. 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 Player angehängt wird. 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 so gestaltet sein, dass in diesem speziellen Fall schwarzer Text auf schwarzem Hintergrund vermieden wird. Die folgenden Stile werden auf den Klassennamen des Absatzes angewendet. Dieses Stylesheet ist bereits vorhanden und befindet sich unter //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, verwenden Sie eine Curl-Anweisung, um dem Player Folgendes mitzuteilen:

    • Speicherort der JavaScript-Datei, die den Code für das Plugin enthält
    • Position des Stylesheets
    • Der Name des Plugins, der mit dem Player verwendet werden soll
    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 den aktualisierten Player zu veröffentlichen. Dies ist derselbe Veröffentlichungscode, den Sie im vorherigen Abschnitt zum Veröffentlichen eines Players verwendet haben.
              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.
      Plugin-Text
      Plugin-Text

    Wenn dem Player mithilfe der Player-Verwaltungs-API ein Plugin hinzugefügt wird, sei es ein von Brightcove bereitgestelltes Plugin oder ein von Ihnen erstelltes benutzerdefiniertes Plugin, wird das Plugin Teil des Player-Codes.

    Konfiguration anzeigen

    Um Ihre geleistete Arbeit zu debuggen und zu bestätigen, ist es oft hilfreich, die Konfiguration eines Players anzuzeigen.

    1. Verwenden Sie dazu a GET Methode mit dem 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. Stellen Sie sicher, dass die Antwort auf die 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"
                }]
              }
              

    Eine andere Möglichkeit, einen Blick auf die Konfiguration des Players zu werfen, besteht darin, den zurückgegebenen URL-Wert zu durchsuchen und den zu ändern index.html zu config.json.

    Liefersystem-APIs

    Die 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 von Playern nicht benötigt werden, können jedoch 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. Probieren Sie für eine praktische Einführung die Schritt für Schritt: Liefersystem Dokument.


    Seite zuletzt aktualisiert am 29 Sep. 2020