Support Kontakt Support | Systemstatus Systemstatus

Plugin-Registrierung

In diesem Thema erfahren Sie, wie Sie mit der Plugin-Registry Ihre Plugins nachverfolgen und verwalten können Brightcove Player benutzt.

Was ist die Plugin-Registrierung?

Die Plugin-Registry ist ein Abschnitt der Player Management API zum Speichern von Informationen über Brightcove-Plugins. Die Registrierung dient als Referenz für alle Versionen jedes gespeicherten Plugins sowie für die zugehörigen Skripte und Stylesheets. Player Die Konfiguration nutzt die Plugin-Registrierung, zeigt die aktuelle Plugin-Version an und ermöglicht es Ihnen, eine Plugin-Version anzugeben.

Vorteile:

Die Vorteile des Plugin-Registers für Brightcove Player Benutzer sind dreifach:

  • Sie können genau sehen, welche Version des Plugins mit Ihrem verwendet wird playersowie die spezifischen JavaScript- und CSS-Dateien, die dieser spezifischen Plugin-Version zugeordnet sind.
  • Sie können Plugins so konfigurieren, dass sie automatisch aktualisiert werden, wenn neue Versionen veröffentlicht werden, die mit Ihren kompatibel sind player Version.
  • Wenn Sie sich aus irgendeinem Grund dafür entscheiden, a player auf eine bestimmte player Version bleiben Ihre Plugins auf den gleichen spezifischen Versionen dafür player als es verschlossen war. Sie müssen sich keine Sorgen machen, dass ein Plugin auf eine Version aktualisiert wird, die nicht mit Ihrer kompatibel ist player Version.

Aktuelle auswählbare Plugins

Die folgende Tabelle zeigt die von Brightcove bereitgestellten Plugins, die mit der Plugin-Registrierung funktionieren. Das Plugin Registrierungs-ID wird mit verwendet player Konfiguration in Verbindung mit dem Player Management API. In diesem Dokument werden zahlreiche Beispiele gezeigt.

Plugin Name Plugin Registrierungs-ID
Adobe Analytics Player @ brightcove / videojs-bc-aa
Chromecast Receiver @ brightcove / videojs-chromecast-receiver
Benutzerdefinierter Bildschirm @ hellcove / videojs-custom-endscreen
DRM @ brightcove / videojs-drm
Google Analytics Player @ brightcove / videojs-bc-ga
IMA3 Werbung @ hellcove / videojs-ima3
Auflage @ hellcove / videojs-überlagerung
Bild im Bild @ brightcove / videojs-pip
Playlist-Benutzeroberfläche @ hellcove / videojs-bc-playlist-ui
Qualitätsauswahlmenü @ hellcove / videojs-Qualitätsmenü
Social @ hellcove / videojs-sozialen
SSAI @ brightcove / videojs-ssai
Tealium Player Plugin @ brightcove / videojs-bc-tealium

Geben Sie die Verwendung eines Plugins an

Um die Verwendung eines Plugins in Ihrem player Bei der Erstellung geben Sie einfach die Registrierungs-ID für das gewünschte Plugin ein. Sie müssen eine Versionsnummer angeben, entweder eine Hauptversion, die automatisch aktualisiert wird (z. B.) 2.x) oder eine Nebenversion (z. B. 2.0.10) die nicht automatisch aktualisiert werden. Details zum Einstellen der Version finden Sie später in diesem Dokument. Sie können auch bereitstellen options für das Plugin, falls vorhanden.

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request POST \
      --data '{
        "name": "Plugin Registry Test Player",
        "configuration": {
          "video_cloud": {
            "video": "4093372393001"
          },
          "plugins": [
           {
              "registry_id": "@brightcove/videojs-custom-endscreen",
              "version": "2.x",
              "options": { "content": "<strong>Content</strong> for <em>custom</em> end screen" }
           }
          ]
        }
      }' \
      https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
          

Informationen zum erstellten player wird von der zurückgegeben Player Management API. Sie können die URL Wert zurückgegeben, ändern Sie die index.html zu config.json und durchsuchen Sie diese URL, um die Konfiguration der veröffentlichten zu sehen player.

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

In der Konfiguration der veröffentlichten player Sie sehen die Informationen auf dem Plugin. Beachten Sie, dass eine bestimmte Version des Plugins zusammen mit den entsprechenden Werten für die JavaScript- und CSS-Dateien angezeigt wird.

    {
      "account_id": "1507807800001",
      "compatibility": true,
      "embed_id": "default",
      "player": {
        "template": {
          "name": "single-video-template",
          "version": "6.7.0"
        }
      },
      "player_id": "SyITgzdjb",
      "player_name": "Plugin Registry Test Player",
      "plugins": [{
        "injected_version": "2.0.10",
        "name": "customEndscreen",
        "registry_id": "@brightcove/videojs-custom-endscreen",
        "version": "2.x"
      }],
      "scripts": [
        "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.min.js"
      ],
      "stylesheets": [
        "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.css"
      ],
      "updated_at": "2017-09-26T17:39:10.080Z",
      "video_cloud": {
        "policy_key": "BCpkADawqM3hOj9I_wRb6jx7SLoklIm8eiW-MH1C0CO5xnf8ndABL7WJQOVdWIusPlnfKUD5EZvjHyJOQGeCFndODaM7CRz4h4GxUTLN3OmO7dTcLnxS3cYrXOZx4eaqaSbVFDx1yFTvWX7m",
        "video": "4093372393001"
      }
    }

Spezifische Hauptversion angeben

Sie können a konfigurieren player um die neueste Version des Plugins für eine bestimmte zu verwenden Dur Version kompatibel mit dem player du benutzt. Wenn Sie dies tun und kleinere Versionen des Plugins veröffentlicht werden, wird das Plugin automatisch auf die neueste kleinere Version aktualisiert.

Zum Beispiel, wenn Sie Ihre wollen player um die neueste kompatible Version des benutzerdefinierten Endscreen-Plugins für zu enthalten Hauptversion 2 des Plugins würden Sie folgendes verwenden:

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request POST \
      --data '{
        "name": "Plugin Registry Test Player",
        "configuration": {
          "video_cloud": {
            "video": "4093372393001"
          },
          "plugins": [
            {
              "registry_id": "@brightcove/videojs-custom-endscreen",
              "version": "2.x"
            }
          ]
        }
      }' \
      https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players

Die resultierende Konfiguration wird in etwa wie folgt aussehen:

    "plugins": [{
      "injected_version": "2.0.10",
      "name": "customEndscreen",
      "registry_id": "@brightcove/videojs-custom-endscreen",
      "version": "2.x"
    }],
    "scripts": [
      "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.min.js"
    ],
    "stylesheets": [
      "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.css"
    ],

Spezifische Version angeben

Sie können eine bestimmte Version des zu verwendenden Plugins angeben. Wenn Sie dies tun, wird das Plugin unter keinen Umständen automatisch aktualisiert, so dass Sie es bei Bedarf manuell aktualisieren müssen.

Um eine Version des Plugins zu sperren, geben Sie beim Erstellen des Plugins einfach die Version an player:

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request POST \
      --data '{
        "name": "Plugin Registry Test Player",
        "configuration": {
          "video_cloud": {
            "video": "4093372393001"
          },
          "plugins": [
            {
              "registry_id": "@brightcove/videojs-overlay",
              "version": "1.0.2"
            }
          ]
        }
      }' \
      https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
          

Unser player Die Konfiguration spiegelt die spezifische Version sowie die JavaScript- und CSS-Dateien wider:

    "plugins": [{
      "name": "overlay",
      "registry_id": "@brightcove/videojs-overlay",
      "version": "1.0.2"
    }],
    "scripts": [
      "//players.brightcove.net/videojs-overlay/1.0.2/videojs-overlay.min.js"
    ],
    "stylesheets": [
      "//players.brightcove.net/videojs-overlay/1.0.2/videojs-overlay.css"
    ],
          

Nicht kompatible Aufgaben

Wenn Sie versuchen, a ein inkompatibles Plugin zuzuweisen player, oder ändern Sie die Version von a player Wenn ein zuvor zugewiesenes Plugin nicht mehr kompatibel ist, treten Fehler auf. Die Fehler werden hier detailliert beschrieben.

Plugin nicht kompatibel zuweisen player

Wenn zu irgendeinem Zeitpunkt, entweder in player Bei der Erstellung oder Aktualisierung versuchen Sie, eine Plugin-Version anzugeben, die nicht mit a kompatibel ist player Version erhalten Sie eine Fehlermeldung. Hier ist beispielsweise eine Antwort von der API, wenn versucht wird, einem neuen ein nicht kompatibles, älteres Plugin zuzuweisen player:

    {
      "message": "There are no versions of the plugin that match the specified major version. The major version specified was 1.x for plugin @brightcove/videojs-bc-playlist-ui",
      "error_code": "PLAYER_MANAGEMENT_ERROR",
    }
          

Ändern player Version also nicht kompatibel mit Plugin

Wenn Sie versuchen, die Version eines vorhandenen zu ändern playerUnd der player hat bereits ein Plugin, das nicht mit der neu zugewiesenen Version des kompatibel ist playererhalten Sie einen Fehler ähnlich dem folgenden:

    {
      "error_code":"APPLICATION_ERROR",
      "message":"plugin \"@brightcove/videojs-ima3\" is not compatible with template 5.28.1"
    }
    

Studio konfiguriertes Plugin

Wenn ein Plugin über Studio geladen wird, wird das Plugin neue Funktionen in der Plugin Registry widerspiegeln:

    {
      "account_id": "1507807800001",
      "compatibility": true,
      "embed_id": "default",
      "player": {
        "template": {
          "name": "single-video-template",
          "version": "6.7.0"
        }
      },
      "player_id": "SJajDfuiW",
      "player_name": "Plugin Registry Studio Configuration",
      "plugins": [{
        "injected_version": "2.0.10",
        "name": "customEndscreen",
        "options": {
          "content": "<h3>This is the endscreen content</h3>"
        },
        "registry_id": "@brightcove/videojs-custom-endscreen",
        "version": "2.x"
      }],
      "scripts": [
        "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.min.js"
      ],
      "stylesheets": [
        "//players.brightcove.net/videojs-custom-endscreen/2.0.10/videojs-custom-endscreen.css"
      ],
      "updated_at": "2017-09-26T18:09:31.940Z",
      "video_cloud": {
        "policy_key": "BCpkADawqM3YPJvvfxBgJNEGrPjTPoOw0LyCbiTPnDGtAVExTzXeAW3hcRtPpS8tNeSiA9MosLG076eMXWO8E2Lxv-V7mq1oTIgqK7Xf0HBP_TEm1i-e5zRN_VIW_SjFagYpRxuoM8btiEoD",
        "video": null
      }
    }
          

Wie Sie in der sehen player Konfiguration wird ein in Studio geladenes Plugin mit dem Hauptversionsverhalten aktualisiert, dh kleinere Versionsaktualisierungen werden automatisch angewendet.

Aktualisieren von Registrierungsinformationen

Sie können die Plugin-Registrierungsinformationen für a aktualisieren player unter Verwendung von Standardverfahren. Beispielsweise verwendet die folgende Curl-Anweisung das HTTP PATCH Methode zum Ändern eines Plugins von einer bestimmten Version in das Hauptversionsupdateverhalten:

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request PATCH \
      --data '{
        "plugins": [{
          "registry_id": "@brightcove/videojs-custom-endscreen",
          "version": "2.x"
        }]
      }' \
      https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
          

Denken Sie daran, Sie müssen Ihre veröffentlichen player nach einer Änderung.

Plugin Registrierung API

Dem wurden zwei neue Endpunkte hinzugefügt Player Management API die das Abrufen von Plugin-Informationen aus der Registrierung ermöglichen, die Ihnen folgende Funktionen bieten:

  • Abrufen aller Plugins in der Registrierung
  • Informationen zu einem bestimmten Plugin abrufen

Holen Sie sich alle Plugins

Verwenden Sie Folgendes, um Informationen zu den derzeit in der Registrierung vorhandenen Plugins abzurufen.

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request GET \
      https://players.api.brightcove.com/v2/plugins
          

Die zurückgegebenen Informationen werden in etwa wie folgt aussehen:

    [{
      "documentation": "https://support.brightcove.com/configuring-adobe-analytics-event-tracking",
      "description": "Adobe Analytics Player Plugin",
      "id": "@brightcove/videojs-bc-aa",
      "name": "bcAa",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/configuring-google-analytics-event-tracking",
      "description": "Google Analytics Player Plugin",
      "id": "@brightcove/videojs-bc-ga",
      "name": "bcGa",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/google-tag-manager-plugin-brightcove-player",
      "description": "Google Tag Manager Player Plugin",
      "id": "@brightcove/videojs-bc-gtm",
      "name": "bcGtm",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/playlist-ui-plugin",
      "description": "Brightcove customizations to videojs-playlist-ui",
      "id": "@brightcove/videojs-bc-playlist-ui",
      "name": "bcPlaylistUi",
      "current_version": "3.x"
    }, {
      "documentation": "https://support.brightcove.com/tealium-plugin-brightcove-player",
      "description": "Tealium Player Plugin",
      "id": "@brightcove/videojs-bc-tealium",
      "name": "bcTealium",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/beta-chromecast-plugin-brightcove-player",
      "description": "A Chromecast Receiver plugin for the Brightcove Player",
      "id": "@brightcove/videojs-chromecast-receiver",
      "name": "chromecastReceiver",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/custom-endscreen-plugin",
      "description": "Custom endscreens for video.js.",
      "id": "@brightcove/videojs-custom-endscreen",
      "name": "customEndscreen",
      "current_version": "2.x"
    }, {
      "documentation": "https://support.brightcove.com/configuring-brightcove-player-drm",
      "description": "Cross-browser support for MPEG-DASH w/ DRM using dash.js and silverlight and HLS Fairplay DRM",
      "id": "@brightcove/videojs-drm",
      "name": "eme",
      "current_version": "5.x"
    }, {
      "documentation": "https://support.brightcove.com/advertising-ima3-plugin",
      "description": "Google Interactive Media Ads (IMA) v3 support for video.js",
      "id": "@brightcove/videojs-ima3",
      "name": "ima3",
      "current_version": "3.x"
    }, {
      "documentation": "https://support.brightcove.com/display-overlay-plugin",
      "description": "Overlay for video.js.",
      "id": "@brightcove/videojs-overlay",
      "name": "overlay",
      "current_version": "2.x"
    }, {
      "documentation": "https://support.brightcove.com/picture-picture-plugin-aka-floating-or-pinned",
      "description": "A plugin for enabling a Picture-In-Picture mode for the Brightcove Player",
      "id": "@brightcove/videojs-pip",
      "name": "pip",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/manual-rendition-selection-plugin",
      "description": "Quality Selection Menu UI",
      "id": "@brightcove/videojs-quality-menu",
      "name": "qualityMenu",
      "current_version": "1.x"
    }, {
      "documentation": "https://support.brightcove.com/social-media-plugin",
      "description": "Social sharing integrations for video.js.",
      "id": "@brightcove/videojs-social",
      "name": "social",
      "current_version": "3.x"
    }, {
      "documentation": "https://support.brightcove.com/advertising-ssai-plugin",
      "description": "A plugin for the Brightcove Player implementing playback of SSAI streams.",
      "id": "@brightcove/videojs-ssai",
      "name": "ssai",
      "current_version": "1.x"
    }]
          

Erhalte spezifische Plugin Informationen

Verwenden Sie Folgendes, um Informationen zu einem bestimmten Plugin abzurufen. Beachten Sie, dass der Plugin-Name URL-codiert sein muss, also statt @brightcove/videojs-ima3 unsere Website benutzen, %40brightcove%2fvideojs-ima3 .

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request GET \
      https://players.api.brightcove.com/v2/plugins/%40brightcove%2fvideojs-ima3
          

Die zurückgegebenen Informationen werden in etwa wie folgt aussehen:

    {
      "versions": [{
        "scripts": ["//players.brightcove.net/videojs-ima3/3/videojs.ima3.min.js"],
        "stylesheets": ["//players.brightcove.net/videojs-ima3/3/videojs.ima3.min.css"],
        "version_number": "3.x",
        "minimum_template_version": "6.0.0"
      }, {
        "minimum_template_version": "5.0.0",
        "version_number": "2.x",
        "stylesheets": ["//players.brightcove.net/videojs-ima3/2/videojs.ima3.min.css"],
        "scripts": ["//players.brightcove.net/videojs-ima3/2/videojs.ima3.min.js"]
      }, {
        "minimum_template_version": "1.14.0",
        "version_number": "1.x",
        "stylesheets": ["//players.brightcove.net/videojs-ima3/1/videojs.ima3.min.css"],
        "scripts": ["//players.brightcove.net/videojs-ima3/1/videojs.ima3.min.js"]
      }],
      "documentation": "https://support.brightcove.com/advertising-ima3-plugin",
      "description": "Google Interactive Media Ads (IMA) v3 support for video.js",
      "id": "@brightcove/videojs-ima3",
      "name": "ima3",
      "current_version": "3.x"
    }

Obwohl in dieser Antwort nicht gezeigt, können Sie auch a sehen before_template-version Eigentum und entsprechender Wert. Dies wird für ältere Plugins angezeigt und stellt die neuesten ein player Vorlagenversion, mit der diese Plugin-Version kompatibel ist. Das minimum_template_version und before_template-version arbeiten Sie zusammen, um den Bereich von festzulegen player Vorlagenversionen, mit denen das Plugin kompatibel ist.


Seite zuletzt aktualisiert am 12. Juni 2020