soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Integrando tu CMS con Video Cloud

    En este tema, aprenderá las operaciones básicas involucradas en la integración de Brightcove Video Cloud con un CMS Enumera las funciones típicas que los usuarios realizan dentro del CMS y las operaciones API de Brightcove que se pueden utilizar para proporcionar esa funcionalidad.

    Las funciones de usuario

    A continuación se encuentran las funciones relacionadas con Video Cloud que puede querer proporcionar a los usuarios de su CMS:

    • Agrega nuevos videos a Video Cloud
    • Reemplace un Video Cloud video con una nueva versión
    • Actualizar los metadatos de los videos, como el título, la descripción y las etiquetas
    • Eliminar videos
    • Crea listas de reproducción
    • Cambiar los videos en una lista de reproducción
    • Eliminar listas de reproducción
    • Crear reproductores de video
    • Modificar las propiedades del reproductor de video, como las dimensiones o el estilo
    • Agregue funcionalidad especial a reproductores de video a través de complementos
    • Publique videos individuales o listas de reproducción
    • Proporcione datos analíticos sobre cargas de video, vistas, niveles de reproducción, participación, etc.

    Es posible que no desee exponer toda esta funcionalidad a sus usuarios finales; es posible que no desee permitirles que eliminen videos, por ejemplo. Una de las ventajas de integrar Video Cloud con su CMS en lugar de dejar que los usuarios vayan directamente a Video Cloud Studio es que puede elegir exactamente qué funcionalidad exponer a los usuarios a través de las API de Brightcove.

    Autenticación

    Para todas las solicitudes de API de Brightcove, la autenticación se basa en tokens de acceso OAuth2. Hay un proceso de dos pasos para obtener tokens de acceso:

    1. Crea credenciales de cliente con permisos para las operaciones de API que necesitas
    2. Utilice las credenciales del cliente para crear un token de acceso temporal para autenticar una solicitud de la API

    Creando credenciales del cliente

    La creación de credenciales del cliente es una operación de una sola vez que se puede realizar a través de Video Cloud Estudio o el OAuth API . Como lo hagas, un client_id y client_secret se devuelven, que debe guardar para solicitar tokens de acceso.

    Crear un token de acceso

    Los tokens de acceso temporal se crean usando el OAuth API . El client_id y client_secret debe estar codificado en BASE64 y pasado como un Basic Cadena de autorización.

    El access_token devuelto se pasa en un encabezado de Autorización con la llamada API:

        >Authorization: Bearer your_access_token
        
        

    Los tokens de acceso son válidos para los minutos de 5. A menos que esté realizando algún tipo de operación por lotes que realizará cientos de llamadas API sucesivas, tiene sentido simplemente solicitar una nueva para cada llamada API en lugar de intentar realizar un seguimiento del tiempo de espera.

    Agregar videos

    Si desea que los usuarios agreguen videos a Video Cloud de su CMS, puede hacerlo usando el Dynamic Ingest API . Recomendamos que los usuarios suban videos a su repositorio, que podría ser un depósito S3 o solo un servidor público. El sistema Dynamic Ingest puede incorporar los videos y agregarlos al Video Cloud sistema a través de un proceso de dos pasos que se detalla a continuación.

    Agregar un objeto de video a Video Cloud

    El primer paso es crear un objeto de video en el Video Cloud sistema haciendo una PUBLICAR solicitud al CMS API:

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

    El cuerpo de la solicitud incluirá propiedades de video básicas en un JSON objeto - como mínimo, el video name, pero también puede incluir metadatos adicionales, como description y tags:

        {
        "name": "Woodpecker",
        "description": "A bird that hunts insects inside wood",
        "reference_id": "Bird_Woodpecker.mp4",
        "tags": ["bird", "air", "nature"]
        }
        
        

    Ingerir el video

    Cuando crea el objeto de video, CMS API devolverá un JSON objeto que contiene las propiedades del video. Extraerás el video id de la JSON, y úsala para hacer una llamada al Dynamic Ingest API para solicitar la ingestión y la transcodificación del video:

        https://ingest.api.brightcove.com/v1/accounts/ACCOUNT_ID/videos/VIDEO_ID/ingest-requests
        
        

    Nuevamente enviarás JSON en el cuerpo de la solicitud que especifica la ubicación del archivo de video:

        {
          "master":{
            "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
          },
          "profile":"multi-platform-extended-static",
          "capture-images": true
        }
        
        

    El profile aquí está el perfil de ingestión que especifica qué entregas deben crearse en el proceso de transcodificación. En la mayoría de los casos, uno de los siguientes perfiles estándar debería ser adecuado:

    Perfiles de Entrega Dinámica

    • multi-platform-extended-static
    • multi-platform-standard-static

    Perfiles heredados de herencia

    • videocloud-default-v1 (the default)
    • screencast-1280
    • smart-player-transition
    • single-bitrate-high
    • audio-only
    • single-bitrate-standard
    • high-resolution

    Sin embargo, puede crear perfiles de ingesta personalizados adicionales, si es necesario, utilizando el Ingest Profiles API o utilizando Video Cloud Estudio.

    Agregar póster e imágenes en miniatura

    El capture-images opción en el código anterior instruye Video Cloud para capturar imágenes de pósters y miniaturas para el video en el punto medio durante el proceso de transcodificación. Alternativamente, puedes establecer capture-images a false e ingiera imágenes en su lugar, ya sea al mismo tiempo que ingiere el video o más tarde:

        {
        "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
        },
        "profile":"multi-platform-extended-static",
        "capture-images": false,
        "poster": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
        "width": 640,
        "height": 360
        },
        "thumbnail": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
        "width": 160,
        "height": 90
        }
        }
        
        

    Vea Imágenes y el Dynamic Ingest API para más detalles.

    Agregar pistas de texto para títulos o capítulos

    También puedes utilizar la Dynamic Ingest API para agregar pistas de texto en WebVTT archivos a videos, ya sea en el momento de la ingestión o más tarde. Las pistas de texto se usan para agregar subtítulos or capítulos a un video

        {
        "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
        },
        "profile":"multi-platform-extended-static",
        "capture-images": false,
        "poster": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
        "width": 640,
        "height": 360
        },
        "thumbnail": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
        "width": 160,
        "height": 90
        },
        "text_tracks": [
        {
        "url": "http://learning-services-media.brightcove.com/captions/for_video/Water-in-Motion.vtt",
        "srclang": "en",
        "kind": "captions",
        "label": "English",
        "default": true
        }
        ]
        }
        
        

    Vea Ingestión de archivos WebVTT para más detalles.

    Administrar videos

    El CMS API le permite recuperar datos de video para una cuenta. (Como se muestra arriba, también se usa para crear objetos de video como parte del proceso de ingestión de video). La solicitud más básica es la siguiente:

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

    Por defecto, esta solicitud devuelve un JSON una matriz de objetos de video 20 que contienen una gran cantidad de metadatos, incluidos el nombre, la descripción, las etiquetas, los campos personalizados, las fechas en que se creó y la última modificación, las URL para el póster y la miniatura, y mucho más.

    Puede refinar los resultados de la solicitud agregando uno o más de los siguientes parámetros a la solicitud:

    limit
    esto determina la cantidad de objetos de video que se devolverán y se puede establecer en cualquier número arriba de 100; el valor predeterminado es 20
    offset
    esto determina la cantidad de elementos que se saltan y, por lo tanto, se usa junto con limit para recorrer el catálogo de videos, el valor predeterminado es 0
    sort
    esto determina el campo de metadatos del video para ordenar el resultado por - de manera predeterminada, los resultados están ordenados por updated_at (descendiendo, para mostrar primero los videos actualizados más recientemente)

    Vea CMS API Descripción general - Parámetros para obtener información detallada sobre estos parámetros.

    Buscando videos

    También puede buscar videos por una amplia gama de criterios usando el q parámetro. Puede buscar por campos específicos como el nombre, la descripción y las etiquetas, así como las fechas y el estado de los videos:

        https://cms.api.brightcove.com/v1/accounts/account_id/videos?q=tags:sea,mammal
        
        

    Para detalles y todas las opciones para buscar, vea Búsqueda de vídeos.

    Obtener y actualizar un video específico

    Para recuperar un video específico por su ID o ID de referencia:

        https://cms.api.brightcove.com/v1/accounts/account_id/videos/id
        or
        https://cms.api.brightcove.com/v1/accounts/account_id/videos/ref:reference_id
        
        

    A OBTENGA solicitud devuelve el objeto de video. Para actualizarlo, modifique el JSON y devolverlo usando un PARCHE solicitar a la misma URL.

    Playlists

    La información de la lista de reproducción también se administra utilizando el CMS API de la misma manera que la información de video. Tenga en cuenta que Video Cloud admite ocho tipos de listas de reproducción en dos categorías:

    Manual (o EXPLICIT) listas de reproducción
    contiene un conjunto específico de videos: hasta 100 se pueden incluir videos
    Listas de reproducción inteligentes
    construido dinámicamente en tiempo de ejecución en función de los criterios de búsqueda: hay siete variedades de listas de reproducción inteligentes correspondientes a la forma en que se ordenan los videos dentro de la lista:
    • ACTIVATEDOLDESTTONEWEST
    • ACTIVATEDNEWESTTOOLDEST
    • ALPHABETICAL
    • PLAYSTOTAL
    • PLAYSTRAILINGWEEK
    • STARTDATEOLDESTTONEWEST
    • STARTDATENEWESTTO_OLDEST

    El límite en la cantidad de videos se puede establecer en cualquier número hasta 100.

    Al igual que con los videos, puede recuperar todas las listas de reproducción, usando limit y offset para desplazarse por los resultados si la cuenta tiene una gran cantidad de listas de reproducción:

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists
        
        

    La matriz devuelta de los objetos de la lista de reproducción incluirá metadatos para la lista de reproducción, incluido el type correspondiente a uno de los tipos descritos anteriormente. Si el tipo es EXPLICIT, también habrá un video_ids matriz que contiene los identificadores de los videos incluidos. Si el tipo es uno de los tipos de lista de reproducción inteligente, habrá una search propiedad que contiene la cadena de búsqueda que recupera los videos, algo como esto:

        q=tags:fish,birds
        
        

    También puede recuperar una sola lista de reproducción por su id:

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
        
        

    Si necesita recuperar los objetos de video completos para una lista de reproducción (para mostrar información sobre los videos en una página), simplemente agrega /videos a esa URL:

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

    Tenga en cuenta que para una lista de reproducción inteligente, la solicitud devolverá los videos que coinciden con los criterios de búsqueda actualmente, pero eso puede cambiar.

    Creando jugadores

    Brightcove players se pueden crear a través de Player Management API . La API te permite crear jugadores, actualizar sus propiedades y obtener el código de inserción en forma de una URL, una iframe etiqueta, o un bloque de HTML para incrustar en la página.

    Puedes obtener hasta 200 jugadores por cuenta, pero generalmente es menos confuso para los usuarios tener tan pocos jugadores como necesites. Debes tener jugadores separados para reproducir videos individuales o listas de reproducción, pero de lo contrario solo necesitarás diferentes jugadores cuando se les aplique un estilo diferente o se agreguen funcionalidades diferentes a través de complementos.

    Para crear un jugador, simplemente hace un PUBLICAR solicitud al Player Management API:

        https://players.api.brightcove.com/v2/accounts/account_id/players
        
        

    En el cuerpo de la solicitud, incluya el configuración del jugador - lo único que se requiere es un name:

        {
        "name": "Single video player for blog posts"
        }
        
        

    La respuesta le dará la identificación del jugador, así como el código de inserción en múltiples formas:

        {
        "embed_code": "<iframe src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "embed_in_page": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/in_page.embed",
        "id": "de055fa4-4f09-45af-8531-419c6794ad04",
        "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "preview_url": "http://preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html",
        "url": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html"
        }
        
        

    Para obtener la configuración de jugador completo, realice una solicitud al /players punto final, pero agregue la identificación del jugador que se devuelve en la respuesta anterior:

        https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04
        
        

    Puedes hacer una PARCHE solicitar al mismo punto final para actualizar la configuración del jugador.

    Notarás en la respuesta anterior, preview_embed_code y preview_url. Para permitir la prueba de nuevos jugadores o actualizaciones de jugadores, los jugadores recién creados o actualizados se configuran en modo de vista previa para que pueda verlos antes de enviar los cambios a los jugadores existentes. Para impulsar los cambios en la producción, necesita publicar el jugador con esta solicitud:

        https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04/publish
        
        

    Personalizando jugadores

    El Brightcove player está construido con tecnologías web estándar: HTML, CSS y JavaScript. Puedes personalizar el player usando esas mismas tecnologías. Esto se puede hacer en la página donde player se publica, pero la mejor práctica es agregar sus personalizaciones a player a través del player configuración, actualizando al jugador a través de un PARCHE solicitud al Player Management API como se explicó en la sección anterior.

    También puede agregar características y funcionalidades adicionales al player a través de JavaScript plugins, y hay una extensa Player API para ayudarlo a integrar su código con el player. Brightcove ofrece una serie de complementos listos para usar para habilitar la publicidad, personalizar la pantalla final y agregar superposiciones.

    Publicación de videos

    En la sección que pone Creando la sección de Jugadores arriba vimos que cuando obtienes el objeto de configuración del jugador usando el Player Management API, los datos devueltos incluyen una etiqueta iframe para incrustar el reproductor en una página HTML, y también una URL para el HTML completo si desea incrustar el reproductor directamente en una página.

    Para cualquier inserción que elija, deberá agregar un Video Cloud ID de video o ID de la lista de reproducción en el código de inserción para agregar contenido al reproductor. El código de inserción del iframe tiene este aspecto:

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html'
        allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
        
        

    Para la URL del jugador, debe agregar el parámetro videoId={}video_id, de modo que el código de inserción completo se vea así:

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
        allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
        
        

    Si este es un reproductor de listas de reproducción, usa el parámetro playlistId={playlist_id} en lugar. La modificación del código de inserción in-page es similar.

    A menos que las dimensiones del jugador estén fijadas en la configuración del reproductor, también necesitará ajustar el tamaño del jugador agregando ancho y alto en una style atributo:

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
        allowfullscreen webkitallowfullscreen mozallowfullscreen
        style=width:640px;height:360px;></iframe>
        
        

    Obtener informes analíticos

    El Analytics API le permite generar informes analíticos por muchos diferentes dimensions. Consulte la Guías de dimensiones .

    Puede especificar el intervalo de fechas para el informe, las métricas a devolver y puede obtener los datos en JSON, csv o xlxs formato

    Para los períodos del último mes, también puede generar detalles Informes de compromiso que muestran vistas por cada centésima parte del video.

    Resumen de API

    Aquí hay un resumen de las API útiles para integrarse con Video Cloud.

    OAuth API
    Se usa para crear credenciales de cliente y tokens de acceso para acceder a las otras API.
    Administración de medios
    Ingest Profiles API
    Se usa para crear perfiles de ingesta personalizados que especifican las representaciones que se crearán para los videos agregados a Video Cloud
    Dynamic Ingest API
    Se usa para agregar videos y activos de medios relacionados a Video Cloud
    CMS API
    Se usa para crear objetos de video para la ingestión y para administrar videos y listas de reproducción
    Brightcove Players
    El Brightcove Player
    El player incluye una JavaScript API para interactuar con el player en tiempo de ejecución
    Player Management API
    Se usa para crear y configurar jugadores, y para obtener el código incrustado del jugador
    Analytics API
    Se usa para obtener informes analíticos sobre el rendimiento de video

    Página actualizada por última vez el 28 Sep 2020