soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema

Registro de complementos

En este tema, aprenderá cómo se puede usar el Registro de complementos para rastrear y administrar los complementos de su Brightcove Player esta usando.

¿Qué es el Registro de complementos?

El Registro de Complementos es una sección de la Player Management API dedicado a almacenar información sobre los complementos de Brightcove. El registro sirve como referencia para todas las versiones de cada complemento almacenado, así como para los scripts y las hojas de estilo asociadas a cada uno. Player la configuración aprovecha el Registro de complementos, muestra la versión actual del complemento y también le permite especificar una versión del complemento.

Ventajas

Las ventajas del Plugin Registry para Brightcove Player los usuarios son tres veces:

  • Puede ver exactamente qué versión del complemento se está utilizando con su player, así como los archivos JavaScript y CSS específicos asociados con esa versión específica del complemento.
  • Puede configurar complementos para que se actualicen automáticamente cuando se lancen nuevas versiones que sean compatibles con su player versión.
  • Si por alguna razón elige mantener un player en un específico player versión, sus complementos permanecerán en las mismas versiones específicas para ese player cuando estaba cerrado No tiene que preocuparse de que un complemento se actualice a una versión que no sea compatible con su player versión.

Complementos elegibles actuales

La siguiente tabla muestra los complementos suministrados por Brightcove que funcionan con el Registro de complementos. los ID del registro del complemento será utilizado con player configuración en conjunto con el Player Management API. Numerosos ejemplos se mostrarán en este documento.

Plugin Name ID del registro del complemento
Adobe Analytics Player @ brightcove / videojs-bc-aa
Receptor Chromecast @ brightcove / videojs-chromecast-receptor
Pantalla final personalizada @ brightcove / videojs-custom-endscreen
DRM @ brightcove / videojs-drm
Google Analytics Player @ brightcove / videojs-bc-ga
Publicidad IMA3 @ brightcove / videojs-ima3
Superposición @ brightcove / videojs-overlay
Picture-In-Picture @ brightcove / videojs-pip
Lista de reproducción UI @ brightcove / videojs-bc-playlist-ui
Menú de selección de calidad @ brightcove / videojs-quality-menu
Social @ brightcove / videojs-social
SSAI @ brightcove / videojs-ssai
Tealium Player Enchufar @ brightcove / videojs-bc-tealium

Especificar el uso de un complemento

Para especificar el uso de un complemento, en su player Para la creación, simplemente proporcione el ID de registro para el complemento deseado. Debe especificar un número de versión, ya sea una versión principal que se actualizará automáticamente (por ejemplo 2.x) o una versión menor (por ejemplo 2.0.10) que no se actualizará automáticamente. Los detalles sobre cómo configurar la versión aparecen más adelante en este documento. También puedes proporcionar options para el complemento, si hay alguno.

    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
          

Información sobre lo creado player es devuelto por el Player Management API. Puede utilizar el url valor devuelto, cambie el index.html a config.json y navegue esa URL para ver la configuración de la publicación 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>"
    }

En la configuración de lo publicado player ves la información en el complemento. Tenga en cuenta que se muestra una versión específica del complemento, junto con los valores correspondientes para los archivos JavaScript y CSS.

    {
      "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"
      }
    }

Especificar la versión principal específica

Puedes configurar un player usar la última versión del complemento para un determinado una gran diferencia versión compatible con el player Tu estas usando. Cuando hace esto, y se lanzan versiones menores del complemento, el complemento se actualizará automáticamente a la última versión menor.

Por ejemplo, si quieres tu player para contener la última versión compatible del complemento de pantalla final personalizada para versión principal 2 del complemento usaría lo siguiente:

    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

La configuración resultante aparecerá similar a la siguiente:

    "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"
    ],

Especificar la versión específica

Puede especificar una versión específica del complemento para usar. Si hace esto, el complemento NO se actualizará automáticamente bajo ninguna circunstancia, por lo que tendrá que actualizarlo manualmente si es necesario.

Para bloquear una versión del complemento, simplemente especifique la versión al crear el 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
          

La player la configuración reflejará la versión específica, así como también en los archivos JavaScript y CSS:

    "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"
    ],
          

Asignaciones no compatibles

Si intenta asignar un complemento incompatible a un playero cambiar la versión de un player por lo que un complemento previamente asignado ya no es compatible, se producirán errores. Los errores se detallan aquí.

Asignar complemento a no compatible player

Si en cualquier momento, ya sea en player creación o actualización, intenta especificar una versión de complemento que no sea compatible con un player versión, obtendrá un error. Por ejemplo, aquí hay una respuesta de la API cuando se intenta asignar un complemento antiguo no compatible a un nuevo 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",
    }
          

Cambiar player versión tan incompatible con el complemento

Si intenta cambiar la versión de una existente player, Y el player ya tiene un complemento que no es compatible con la versión recién asignada del player, obtendrá un error similar al siguiente:

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

Complemento configurado para Studio

Si un complemento se carga a través de Studio, el complemento reflejará una nueva funcionalidad en el Registro de complementos:

    {
      "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
      }
    }
          

Como se puede ver en el player configuración, un complemento cargado en Studio se actualizará utilizando el comportamiento de la versión principal, es decir, las actualizaciones de versiones menores se aplicarán automáticamente.

Actualización de la información del registro

Puede actualizar la información de registro del complemento para un player utilizando procedimientos estándar. Por ejemplo, la siguiente instrucción curl usa HTTP PATCH método para cambiar un complemento de una versión específica a un comportamiento de actualización de versión principal:

    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
          

Recuerde, debe publicar su player Después de hacer un cambio.

Plugin de registro API

Dos nuevos puntos finales se han agregado a la Player Management API que permiten la recuperación de la información del complemento desde el registro, que proporciona funcionalidad para que usted:

  • Recuperar todos los complementos en el registro.
  • Recuperar información sobre un plugin específico.

Obtenga todos los complementos

Use lo siguiente para recuperar información sobre los complementos actualmente en el registro.

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

La información devuelta aparecerá similar a la siguiente:

    [{
      "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"
    }]
          

Obtenga información específica de complementos

Use lo siguiente para recuperar información sobre un plugin específico. Tenga en cuenta que el nombre del complemento debe estar codificado en la URL, por lo tanto, en lugar de @brightcove/videojs-ima3 usa %40brightcove%2fvideojs-ima3 .

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

La información devuelta aparecerá similar a la siguiente:

    {
      "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"
    }

Aunque no se muestra en esta respuesta, también puedes ver un before_template-version propiedad y valor correspondiente. Esto aparecerá para los complementos más antiguos y establece los últimos player versión de plantilla con la que esa versión de complemento es compatible. los minimum_template_version y before_template-version trabajar juntos para establecer el rango de player versiones de plantilla con las que el complemento es compatible.


Página actualizada por última vez el 12 jun 2020