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

    Integración de su CMS con Video Cloud

    En este tema, aprenderá las operaciones básicas relacionadas con 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 de la API de Brightcove que se pueden utilizar para proporcionar esa funcionalidad.

    Funciones de usuario

    A continuación se muestran las funciones relacionadas con las Video Cloud que es posible que desee proporcionar a los usuarios de su CMS:

    • Añadir nuevos vídeos a Video Cloud
    • Reemplazar un Video Cloud vídeo por una nueva versión
    • Actualizar los metadatos de los vídeos, como el título, la descripción y las etiquetas
    • Eliminar vídeos
    • Crear listas de reproducción
    • Cambiar los vídeos de una lista de reproducción
    • Eliminar listas de reproducción
    • Crear reproductores de vídeo
    • Modificar las propiedades del reproductor de vídeo, como las dimensiones o el estilo
    • Añade una funcionalidad especial a los reproductores de vídeo a través de complementos
    • Publicar vídeos o listas de reproducción individuales
    • Proporcione datos analíticos sobre cargas de vídeo, vistas, velocidades de reproducción, interacción, etc.

    Es posible que no desee exponer toda esta funcionalidad a sus usuarios finales; es posible que no desee permitir que eliminen vídeos, por ejemplo. Una de las ventajas de integrarse Video Cloud con su CMS en lugar de permitir 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. Cree credenciales de cliente con permisos para las operaciones de API que necesita
    2. Utilice las credenciales de cliente para crear un token de acceso temporal para autenticar una solicitud de API

    Creación de credenciales de cliente

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

    Creación de un token de acceso

    Los tokens de acceso temporal se crean mediante OAuth API . El y debe estar codificado en Base64 y pasar como una cadena de autorización.client_idclient_secretBasic

    El devuelto se pasa a su vez en un encabezado de autorización con la llamada a la API:access_token

        >Authorization: Bearer your_access_token
        
        

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

    Añadir vídeos

    Si desea permitir que los usuarios agreguen vídeos Video Cloud desde su CMS, puede hacerlo utilizando el Dynamic Ingest API . Le recomendamos que los usuarios carguen vídeos a su repositorio, lo que podría ser un depósito de S3 o simplemente un servidor público. El sistema de ingesta dinámica puede extraer los vídeos y añadirlos al Video Cloud sistema a través de un proceso de dos pasos que se describe a continuación.

    Agregar un objeto de vídeo a Video Cloud

    El primer paso es crear un objeto de vídeo en el Video Cloud sistema haciendo una POST solicitud al CMS API:

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

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

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

    Ingerir el vídeo

    Al crear el objeto de vídeo, CMS API devolverá un JSON objeto que contenga las propiedades del vídeo. Extraerá el video id del JSON , y lo utilizará para hacer una llamada Dynamic Ingest API a la solicitud de ingestión y transcodificación del video:

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

    De nuevo enviará JSON en el cuerpo de la solicitud especificando la ubicación del archivo de vídeo:

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

    Aquí está el perfil de ingesta que especifica qué copias se deben crear en el proceso de transcodificación.profile 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 de ingesta heredados

    • 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 Ingest Profiles API o utilizando Video Cloud Studio.

    Agregar imágenes de póster y miniatura

    La capture-images opción del código anterior indica Video Cloud capturar imágenes de póster y miniatura del vídeo en el punto medio durante el proceso de transcodificación. Alternativamente, puede configurar 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
        }
        }
        
        

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

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

    También puede utilizar para agregar pistas de texto en archivos WebVTT a vídeos, ya sea en el momento de la ingestión o posterior.Dynamic Ingest API Las pistas de texto se utilizan para añadir subtítulos o capítulos a un vídeo.

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

    Consulte Ingerir archivos WebVTT para obtener más detalles.

    Gestión de Vídeos

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

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

    De forma predeterminada, esta solicitud devuelve una JSON matriz de 20 objetos de vídeo 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 modificó por última vez, las direcciones URL del póster y la miniatura, y mucho más.

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

    limit
    esto determina el número de objetos de vídeo a devolver, y se puede establecer en cualquier número hasta 100 - el valor predeterminado es 20
    offset
    esto determina el número de elementos a omitir, por lo que se utiliza junto con para página a través del catálogo de vídeo - el valor predeterminado es 0limit
    sort
    esto determina el campo de metadatos de vídeo para ordenar el resultado por: de forma predeterminada, los resultados se ordenan por (descendente, para mostrar primero los vídeos actualizados más recientemente)updated_at

    Consulte CMS API Visión General - Parámetros para obtener información detallada sobre estos parámetros.

    Buscar vídeos

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

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

    Para obtener más detalles y todas las opciones de búsqueda, consulte Buscar vídeos.

    Obtener y actualizar un vídeo específico

    Para recuperar un vídeo 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
        
        

    Una GET solicitud devuelve el objeto de vídeo. Para actualizarlo, modifique JSON y devuélvelo utilizando una PATCH solicitud a la misma URL.

    Listas de reproducción

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

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

    El límite en el número de vídeos se puede establecer en cualquier número de hasta 100.

    Al igual que con los vídeos, puede recuperar todas las listas de reproducción, utilizando limit y offset para pasar a través de los resultados si la cuenta tiene un gran número de listas de reproducción:

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

    La matriz devuelta de objetos de lista de reproducción incluirá metadatos para la lista de reproducción, incluyendo el correspondiente a uno de los tipos descritos anteriormente.type Si el tipo es EXPLICIT, también habrá una video_ids matriz que contenga los identificadores de los vídeos incluidos. Si el tipo es uno de los tipos de listas de reproducción inteligentes, habrá una search propiedad que contendrá la cadena de búsqueda que recupera los vídeos, 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 vídeo completos para una lista de reproducción (para mostrar información sobre los vídeos en una página), simplemente agregue a esa URL:/videos

        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 vídeos que coinciden con los criterios de búsqueda en la actualidad, pero que pueden cambiar.

    Creación de reproductores

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

    Puedes hasta 200 jugadores por cuenta, pero generalmente es menos confuso para los usuarios tener tan pocos jugadores como absolutamente necesites. Usted debe tener reproductores separados para reproducir vídeos individuales o listas de reproducción, pero de lo contrario sólo necesita diferentes reproductores cuando se les va a dar un estilo diferente o tener diferentes funcionalidades añadidas a través de complementos.

    Para crear un reproductor, sólo tiene que hacer una POST solicitud a Player Management API:

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

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

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

    La respuesta le dará la ID del reproductor, 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 completa del reproductor, realice una solicitud al extremo, pero agregue el ID del reproductor que se devuelve en la respuesta anterior:/players

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

    Puede realizar una PATCH solicitud al mismo punto final para actualizar la configuración del reproductor.

    Notará en la respuesta anterior, el y.preview_embed_codepreview_url Para permitir la prueba de nuevos jugadores o actualizaciones de jugadores, los jugadores recién creados o actualizados están configurados en el modo de vista previa para que puedas verlo antes de enviar cambios a los jugadores existentes. Para introducir cambios en producción, debe publicar el reproductor con esta solicitud:

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

    Personalización de Jugadores

    El reproductor de Brightcove está diseñado con tecnologías web estándar: HTML, CSS y JavaScript. Puede personalizar el reproductor utilizando esas mismas tecnologías. Esto se puede hacer en la página donde se publica el reproductor, pero la mejor práctica es agregar sus personalizaciones al propio reproductor a través de la configuración del reproductor, actualizando el reproductor a través de una PATCH solicitud al Player Management API como se explicó en la sección anterior.

    También puede agregar funciones y funciones adicionales al reproductor a través de JavaScript complementos , y hay una extensa Player API para ayudarle a integrar su código con el reproductor. Brightcove ofrece una serie de plugins listos para usar, como habilitar la publicidad, personalizar la pantalla final y añadir superposiciones.

    Publicación de vídeos

    En la sección Creación de reproductores anterior hemos visto que cuando se obtiene el objeto de configuración del reproductor utilizando 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 incrustación que elija, deberá agregar un ID de Video Cloud vídeo o un ID de lista de reproducción al código de inserción para agregar contenido al reproductor. El código de inserción iframe se ve así:

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

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

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

    Si se trata de un reproductor de lista de reproducción, se utiliza el parámetro playlistId={playlist_id} en su lugar. La modificación del código de inserción en página es similar.

    A menos que las dimensiones del jugador estén fijas en la configuración del jugador, también tendrá que dimensionar el jugador añadiendo ancho y altura en un atributo:style

        <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>
        
        

    Obtención de informes de

    El Analytics API le permite generar informes de análisis por muchos diferentes dimensions. Consulte las Guías de dimensiones para obtener más información.

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

    En los periodos del último mes, también puedes generar informes detallados de participación que muestren vistas de cada centésima parte del vídeo.

    Resumen de APIs

    Aquí hay un resumen de las API útiles para la integración con Video Cloud.

    OAuth API
    Se utiliza para crear credenciales de cliente y tokens de acceso para acceder a las otras API.
    Gestión multimedia
    Ingest Profiles API
    Se utiliza para crear perfiles de ingesta personalizados que especifican las copias que se crearán para los vídeos agregados a Video Cloud
    Dynamic Ingest API
    Se utiliza para agregar vídeos y recursos multimedia relacionados a Video Cloud
    CMS API
    Se utiliza para crear objetos de vídeo para ingerir, y para administrar vídeos y listas de reproducción
    Reproductores de Brightcove
    El jugador de Brightcove
    El reproductor incluye una JavaScript API para interactuar con el reproductor en tiempo de ejecución
    Player Management API
    Se utiliza para crear y configurar reproductores, y para obtener el código de inserción del reproductor
    Analytics API
    Se utiliza para obtener informes analíticos sobre el rendimiento del vídeo

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