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

Agregar puntos de referencia

En este ejemplo, aprenderá cómo agregar puntos de referencia a un video mediante el uso de la CMS API.

Introducción

Los puntos de referencia son lugares especificados en la línea de tiempo del video. Cuando se reproduce el video, un evento se transmite automáticamente cada vez que se alcanza un punto de referencia, utilizando el Player API, puede escuchar estos eventos y tomar las medidas que desee. Además, puede leer toda la información del punto de referencia de los metadatos de video almacenados en player mediainfo objeto, lo que te permite marcar los puntos de referencia en la línea de tiempo del video de alguna manera si quieres.

Hay dos tipos de puntos de referencia:

  • Puntos de referencia de anuncios: se utilizan para marcar lugares donde se debe realizar una solicitud de anuncio (si el video y player están habilitados para publicidad).
  • Puntos de referencia de código: se usan para tomar alguna acción usando el Player API - algunos usos típicos son mostrar algún tipo de llamado a la acción (CTA) o mostrar alguna imagen o texto relacionado con el contenido de video, tal vez como una superposición de video o en la página alrededor del player.

Visión general de implementación

Puede agregar puntos de referencia en el módulo Studio Media. También puedes agregarlos usando el CMS API, que es el método que utilizaremos en esta muestra.

Método HTTP

Los puntos de referencia pueden agregarse cuando crea el video o más tarde con un solicitud de actualización. En esta muestra, los agregaremos a un video existente haciendo una Actualización de vídeo solicitud, lo que significa que usará PATCH método.

Punto final

El punto final para la solicitud de actualización de video es:

          https://cms.api.brightcove.com/v1/accounts/account_id/ videos /video_id

Solicitar cuerpo

El cuerpo de la solicitud es un objeto JSON que puede contener muchos elementos de metadatos de video. Aquí solo miraremos el cue_points campo, que se establece en una matriz de objetos de punto de referencia, como en el siguiente ejemplo:

          {
          "cue_points": [
              {
                "name": "Ad Cue Point",
                "type": "AD",
                "time": 2.0,
                "metadata": null,
                "force_stop": false
              },
              {
                "name": "Code Cue Point",
                "type": "CODE",
                "time": 4.0,
                "metadata": "The metadata might be text or the url for an image to display",
                "force_stop": true
              }
            ]
          }

Campos del objeto del punto de inserción

A continuación hay una descripción de los campos para los objetos de punto de referencia.

Campos de objetos de punto de referencia
Campo Tipo Requerido Descripción
name cadena no Un nombre arbitrario: puede ser útil para identificar un punto de referencia particular en su Player API código
type cadena Debe ser AD or CODE
time número Hora del punto de referencia en segundos desde el comienzo del video [1]
metadata cadena no Cualquier cadena hasta caracteres de un solo byte 128: podría ser información útil para su controlador de eventos de punto de referencia, como el texto de una superposición o la ubicación de una imagen para mostrar
force_stop booleano no Si el video debe pausarse cuando se alcanza el punto de referencia ( force_stop es ignorado por el Brightcove Player y actualmente no hay planes para admitirlo, pero puede pausar el video manualmente en su controlador de eventos de punto de referencia)

Notas

  • [1] Técnicamente, el punto de referencia está activo hasta que se alcanza el siguiente punto de referencia, por lo tanto, en la matriz de puntos de referencia que puede recuperar de la Brightcove Player, verás un startTime y endTime también en un time para el punto de referencia.

Obtener credenciales

Para utilizar el CMS API necesitarás las credenciales adecuadas.

La forma más fácil de obtener credenciales en la mayoría de los casos es a través de la sección Autenticación API de Studio API (requiere permisos de administrador en su cuenta). Ver Administrar Credenciales de Autenticación API para detalles. En la mayoría de los casos, es probable que solo quiera obtener permisos para todos CMS API operación:

CMS API Permissions
CMS API Permissions

Si los permisos que necesita no están disponibles en Studio, o si prefiere obtenerlos directamente de OAuth API, usa tu elección del Obtenga Credenciales de Cliente documentos enumerados a continuación. Cualquiera que sea la opción que elija, deberá solicitar los permisos de operación correctos. Lo siguiente se puede utilizar con cURL o cartero para obtener todos los permisos para el CMS API:

          "operations": [
            "video-cloud/video/all",
            "video-cloud/playlist/all",
            "video-cloud/sharing-relationships/all",
            "video-cloud/notifications/all"
          ]

Aplicación de ejemplo

Encuentre todo el código asociado con esta muestra en este Repositorio GitHub.

Vea la pluma CMS API Muestra: Añadir puntos de referencia por Brightcove Learning Services ( @rcrooks1969) Sobre CodePen.

Usando el CodePen

Aquí hay algunos consejos para usar efectivamente el CodePen anterior:

  • Alterne la visualización real de la aplicación haciendo clic en Resultado .
  • Haga clic en el HTML / CSS / JS botones para visualizar UNO de los tipos de código.
  • Oprima Editar en CodePen en la esquina superior derecha para bifurcar este CodePen en su propia cuenta.
  • Encuentre todo el código asociado con esta muestra en este Repositorio GitHub.

Código proxy

Para crear su propia versión de la aplicación de muestra en esta página, debe crear y alojar su propio proxy. (Los proxies utilizados por Brightcove Learning Services solo aceptan solicitudes de dominios de Brightcove). Puede encontrar un proxy de muestra, muy similar al que usamos, pero sin las comprobaciones que bloquean las solicitudes de dominios que no son de Brightcove, se puede encontrar en este repositorio de GitHub. También encontrará instrucciones básicas para usarlo allí, y una guía más elaborada para crear aplicaciones alrededor del proxy en Uso de las API REST.


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