soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Añadir puntos de referencia

    En este ejemplo, aprenderá a agregar puntos de referencia a un vídeo mediante programación mediante la API de CMS.

    Introducción

    Los puntos de referencia son lugares especificados en la línea de tiempo de vídeo. Cuando se reproduce el vídeo, un evento se emite automáticamente cada vez que se llega a un punto de referencia. Con la Player API, puede escuchar estos eventos y realizar la acción que desee. Además, puede leer toda la información del punto de referencia de los metadatos de vídeo almacenados en el mediainfo objeto del reproductor, lo que le permite marcar los puntos de referencia en la línea de tiempo de vídeo de alguna manera si lo desea.

    Hay dos tipos de puntos de referencia:

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

    Introducción a la implementación

    Puede agregar puntos de referencia en el módulo Studio Media. También puede añadirlos usando la API de CMS, que es el método que usaremos en esta muestra.

    HTTP (método)

    Los puntos de referencia se pueden agregar al crear el vídeo o más tarde con una solicitud de actualización. En este ejemplo, vamos a añadirlos a un vídeo existente haciendo una solicitud de actualización de vídeo , lo que significa que usará el PATCH método.

    Endpoint

    El punto final para la solicitud de vídeo de actualización es:

              https://cms.api.brightcove.com/v1/accounts/account_id/vídeos/video_id

    Cuerpo de solicitud

    El cuerpo de la solicitud es un objeto JSON que puede contener muchos elementos de metadatos de vídeo. Aquí vamos a ver 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 de objeto de punto de referencia

    A continuación se muestra una descripción de los campos de los objetos de punto de referencia.

    Campos de objeto de punto de referencia
    Campo Tipo Obligatorio Descripción
    name Cadena no Un nombre arbitrario: esto puede ser útil para identificar un punto de referencia particular en su código Player API
    type Cadena yes Debe ser AD o CODE
    time número yes Tiempo para el punto de referencia en segundos desde el comienzo del vídeo [1]
    metadata Cadena no Cualquier cadena de hasta 128 caracteres de un solo byte: esto podría ser información útil para el controlador de eventos de punto de referencia, como el texto de una superposición o la ubicación de una imagen que se va a mostrar
    force_stop Booleano no Si el vídeo debe estar en pausa cuando se alcanza el punto de referencia ( force_stop es ignorado por el reproductor de Brightcove y no hay planes actualmente para admitirlo, pero puede pausar el vídeo manualmente en el 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 del reproductor de Brightcove, verá un startTime y endTime así como en una time para el punto de referencia.

    Obtener credenciales de autenticación

    Para utilizar el necesitará las credenciales adecuadas.CMS API

    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 de API de administrador de Studio (requiere permisos de administrador en su cuenta). Consulte Administración de credenciales de autenticación de API para obtener más información. En la mayoría de los casos, probablemente solo desee obtener permisos para todas las CMS API operaciones:

    Permisos de API de CMS
    Permisos de API de CMS

    Si los permisos que necesita no están disponibles en Studio, o si prefiere obtenerlos directamente de la API de OAuth, utilice los documentos que elija Obtener credenciales de cliente que se enumeran a continuación. Cualquiera que sea la opción que elija, deberá solicitar los permisos de operación correctos. Lo siguiente se puede usar con cURL o Postman para obtener todos los permisos para la API de CMS:

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

    Aplicación de muestra

    Encuentra todo el código asociado a esta muestra en este repositorio de GitHub.

    Consulte el ejemplo de API de Pen CMS: Añada puntos de referencia de Brightcove Learning Services ( @rcrooks1969 ) en CodePen.

    Uso del CodePen

    • Alterna la visualización real de la aplicación haciendo clic en el botón Resultado.
    • Haga clic en los botones HTML/CSS/JS para mostrar UNO de los tipos de código.
    • Haga clic en Editar en CodePen en la esquina superior derecha para bifurcar este CodePen en su propia cuenta.
    • Encuentra todo el código asociado a esta muestra en este repositorio de GitHub.

    Código proxy

    Para crear su propia versión de la aplicación de ejemplo en esta página, debe crear y alojar su propio proxy. (Los servidores proxy utilizados por Brightcove Learning Services sólo aceptan solicitudes de dominios de Brightcove.) 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 Using the REST API.


    Última actualización de la página el 29-09-2020