Descripción general: API de administración de reproductores

Introducción

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

La API de administración de reproductores permite al usuario:

1. Crea un jugador
2. Ver la configuración de un jugador
3. Cambiar la configuración de un jugador
4. Enumere todos los jugadores asociados con el editor.
5. Publica un reproductor para ponerlo a disposición del consumidor.

También vea el Referencia de API.

URL base

La URL base de la API es:

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

Introducción

El sistema de gestión de jugadores se compone de tres objetos clave. Son la plantilla, los jugadores y los jugadores infantiles predeterminados.

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 que se presentan a los usuarios y la base para todos los reproductores creados. Estos archivos finalmente se compilan con configuraciones de reproductor personalizadas y dan como resultado el código real que se carga en el navegador (el reproductor). Actualmente, solo hay una plantilla que se utiliza en todo el sistema. Como tal, no hay visibilidad de la plantilla a través de la API.

Jugadores - Los reproductores son configuraciones específicas del cliente que capturan información general y personalizaciones que se aplicarán a la plantilla. Esta configuración se envía a la API y se genera un objeto de reproductor. Las personalizaciones pueden incluir configuraciones, estilos y complementos. Para obtener una lista completa de posibilidades de personalización, consulte el Guía de configuración del reproductor.

Jugadores infantiles - Los jugadores infantiles, creados con las API de inserción, son el resultado de crear varias instancias de un jugador. El reproductor tiene la mayor parte de las propiedades que desea que tenga su reproductor, y luego puede usar un reproductor secundario para personalizar subconjuntos de propiedades en diferentes instancias de reproductor. Un reproductor secundario solo puede definir medios para agregar a un reproductor determinado, o podría definir cualquier configuración o anulación de estilo que altere el reproductor común al que pertenece. Los cambios en la configuración del jugador principal se aplicarán a todos los jugadores secundarios generados por el jugador principal. Revisar la Guía de inserción de API para más detalles.

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

Cuando usa la API de administración de reproductores por primera vez, se genera un reproductor predeterminado de Brightcove en su cuenta. Ese objeto de jugador es para que usted haga lo que elija. Puede usarlo tal como está, cambiar su configuración, cambiarle el estilo o agregar complementos. Puede optar por utilizar solo el reproductor predeterminado de Brightcove con sus personalizaciones, o puede optar por crear otros reproductores para capturar diferentes apariencias y configuraciones para diferentes ubicaciones en su sitio web.

Descripción general de la publicación

Una de las características del sistema de administració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 realiza cambios en la configuración de un reproductor, los cambios están disponibles de inmediato a través de las versiones de vista previa del reproductor. Estas versiones de vista previa son completamente utilizables y comprobables. 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 jugador tiene consecuencias que pueden afectar a los jugadores infantiles. Aquí hay detalles sobre la publicación:

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

La configuración se aplica de manera que el niño gana. Esto significa que la configuración en el nivel secundario tendrá prioridad sobre los cambios realizados en el nivel principal. Considera lo siguiente:

• La plantilla predeterminada define un valor de CSS en rojo.
• Un jugador define el mismo valor CSS como blanco.
• Un jugador secundario define el mismo valor CSS como 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 Campos de matriz La sección de la Guía de API incorporadas describe los detalles.

Opciones de configuración

Para crear un reproductor más avanzado que el reproductor predeterminado, debe proporcionar un Configuración del jugador. La configuración se define mediante JSON.

Limitación de velocidad

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

Códigos de estado de respuesta

Los códigos / mensajes de respuesta y error se basan en los definido por W3. Algunos de los códigos más comunes son:

• 200 Solicitar éxito
• 201 Creado (un jugador, una configuración)
• 400 Solicitud incorrecta: es probable que la sintaxis de la llamada a la API sea incorrecta
• 401 Autenticación no válida: compruebe si la contraseña se ingresó correctamente o si ha seguido las Instrucciones de OAuth correctamente
• 404 No encontrado: compruebe si el recurso existe y la URL utilizada en la llamada a la API es correcta
• 429Excede el límite de velocidad
• 500 Error interno del servidor: se produjo un error al intentar cumplir con la solicitud.