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

    Resumen: Player Management API

    Administración de reproductores se refiere a la creación, edición y gestión de reproductores como un recurso para los editores. La administración de reproductores se logra mediante una API REST del lado del servidor que permite a sus consumidores crear, configurar, previsualizar y publicar instancias de reproductor.
     

    Introducción

    La creación y actualización de jugadores se realiza en un enfoque de dos fases. En lugar de tener todos los cambios aplicados automáticamente a los reproductores de producción, los cambios se separan en vista previa y publicados. Ahora puede realizar todas las actualizaciones que desee a su reproductor de previsualización sin afectar a lo que ven sus usuarios finales. Puede optar por publicar los cambios cuando lo desee.

    La API de administración del reproductor permite a un usuario:

    1. Crear un reproductor
    2. Ver los ajustes de un reproductor
    3. Modificar los ajustes de un reproductor
    4. Enumera todos los reproductores asociados con el editor
    5. Publicar un reproductor para ponerlo a disposición del consumidor

    Consulte también la Referencia de API.

    URL base

    La URL base para la API es:

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

    Introducción

    El sistema de gestión de jugadores se compone de tres objetos clave. Ellos son la plantilla predeterminada, los jugadores y los niños jugadores.

    Plantilla predeterminada de Brightcove - La plantilla es un conjunto de archivos y configuraciones que se utilizan como base para crear las experiencias de visualización presentadas a los usuarios, y la base para todos los jugadores creados. Estos archivos finalmente se compilan con configuraciones personalizadas del reproductor y dan como resultado el código real que se carga en el navegador (el reproductor). Actualmente sólo hay una sola plantilla que se utiliza en todo el sistema. Como tal, no hay visibilidad en la plantilla a través de la API.

    Jugadores : los jugadores son ajustes específicos del cliente que capturan información general y personalizaciones que se aplicarán a la plantilla. Estos ajustes se envían a la API y los resultados de un objeto de reproductor. Las personalizaciones pueden incluir ajustes, estilos y complementos. Para obtener una lista completa de las posibilidades de personalización, consulte la Guía de configuración del reproductor.

    Jugadores secundarios: los jugadores secundarios, creados con las API de inserción, son el resultado de crear varias instancias de un jugador. El jugador tiene la mayor parte de las propiedades que desea que tenga su jugador y, a continuación, puede usar un reproductor secundario para personalizar subconjuntos de propiedades en diferentes instancias de jugador. Un reproductor secundario solo puede definir contenido multimedia para agregar a un reproductor determinado, o bien puede definir cualquier configuración o anulaciones de estilo que alteren el reproductor común al que pertenece. Los cambios en la configuración del jugador padre se aplicarán a todos los jugadores secundarios que aparezcan desde el jugador padre. Consulte la Guía de Incrustar API para obtener más detalles.

    Este diagrama muestra las relaciones entre la plantilla predeterminada, los jugadores y los jugadores secundarios.

    Jerarquía de entidades del jugador
    Jerarquía de entidades del jugador

    Cuando utiliza la API de administración de Player por primera vez, se genera un reproductor predeterminado de Brightcove en su cuenta. Ese objeto de jugador es para que usted pueda hacer con lo que usted elija. Puede usarlo tal cual, cambiar su configuración, cambiarlo de estilo o agregar complementos. Puede optar por utilizar únicamente el Reproductor predeterminado de Brightcove con sus personalizaciones, o bien crear otros jugadores para capturar diferentes looks y configuraciones para diferentes ubicaciones de su sitio web.

    Introducción a la publicación

    Una de las características del sistema de gestión de jugadores es la capacidad de separar los cambios que desea probar de la versión de su reproductor que se publica públicamente. Tanto en la interfaz de usuario como en la API, cuando se realizan cambios en la configuración de un reproductor, los cambios están disponibles inmediatamente a través de las versiones de previsualización del reproductor. Estas versiones de vista previa son totalmente utilizables y probables. Puede compartir la URL de vista previa para su aprobación o trabajar en la vista previa del reproductor hasta que esté satisfecho con los cambios, todo antes de publicar el reproductor para que esté disponible públicamente.

    Actualizar cascadas

    Publicar un reproductor tiene consecuencias que pueden afectar a los jugadores secundarios. A continuación se detallan los detalles sobre la publicación:

    • Una publicación de reproductor activa una nueva publicación de todas las instancias de jugador secundario creadas a partir de ese reproductor.
    • Una publicación de jugador secundario afecta sólo a ese jugador secundario.
    • Una actualización de la plantilla predeterminada de Brightcove (controlada por Brightcove) activará una nueva publicación de todos los reproductores, y la republicación del reproductor, a su vez, activará una nueva publicación de todos los jugadores secundarios creados a partir de cada jugador.

    La configuración se aplica en forma de victorias secundarias. Esto significa que la configuración en el nivel secundario tendrá prioridad sobre los cambios realizados en el nivel principal. Considere lo siguiente:

    • La plantilla predeterminada define un valor CSS como rojo.
    • Un jugador define el mismo valor CSS para ser blanco.
    • Un jugador secundario define el mismo valor CSS para ser azul.

    Dado que el niño gana, los resultados serían:

    • El valor CSS del jugador es blanco.
    • El valor CSS del jugador secundario es azul.

    Este comportamiento de herencia se puede cambiar si el tipo de datos de la propiedad es una matriz. La sección Campos de matriz de la Guía de API de incrustar describe los detalles.

    Opciones de configuración

    Para crear un reproductor más avanzado que el reproductor predeterminado, debe proporcionar una configuración de jugador. La configuración se define usando JSON.

    Limitación de la tasa

    La API de administración del reproductor tiene un límite de velocidad por cada IP única habilitada. Los siguientes son los límites de la tasa:

    Tipo de solicitud Límite
    Publicar y crear (reproductores e incrustaciones) 60 solicitudas/minuto
    Leer (GET) 600 solicitudas/minuto
    Escribir (POST, PUT, PATCH y DELETE) 300 solicitudas/minuto
    Vista previa del jugador 100 solicitudas/minuto

    Códigos de estado de respuesta

    Los códigos/mensajes de respuesta y error se basan en los definidos por W3. Algunos de los códigos más comúnmente vistos son:

    • 200 Solicitud de éxito
    • 201 Creado (un reproductor, una configuración)
    • 400 Solicitud incorrecta: la sintaxis de la llamada a la API probablemente sea incorrecta
    • 401 Autenticación no válida: compruebe si la contraseña se ha introducido correctamente o si ha seguido correctamente las instrucciones de OAuth
    • 404 No encontrado: compruebe si el recurso existe y la URL utilizada en la llamada a la API es correcta
    • 429Límite de tasa superado
    • 500 Error interno del servidor: se produjo un error al intentar cumplir la solicitud

    Última actualización de la página el 13 oct 2020