Introduction
La création et la mise à jour des joueurs se font selon une approche en deux phases. Plutôt que d'appliquer automatiquement toutes les modifications aux lecteurs de production, les modifications sont séparées en aperçu et publiées. Vous pouvez désormais effectuer toutes les mises à jour que vous souhaitez sur votre lecteur de prévisualisation sans affecter ce que voient vos utilisateurs finaux. Vous pouvez choisir de publier les modifications quand vous le souhaitez.
L'API de gestion des joueurs permet à un utilisateur de :
- Créer un joueur
- Afficher les paramètres d'un lecteur
- Modifier les paramètres d'un lecteur
- Lister tous les joueurs associés à l'éditeur
- Publier un player pour le mettre à disposition du consommateur
Voir aussi le Référence API.
URL de base
L'URL de base de l'API est :
https://players.api.brightcove.com/v2
Introduction
Le système de gestion des joueurs est composé de trois objets clés. Ils sont le modèle par défaut, les joueurs et les enfants joueurs.
Modèle par défaut de Brightcove : le modèle est un ensemble de fichiers et de paramètres utilisés comme base pour créer les expériences de visionnage présentées aux utilisateurs et comme base pour tous les joueurs créés. Ces fichiers sont finalement compilés avec des paramètres de lecteur personnalisés et génèrent le code réel qui est chargé dans le navigateur (le lecteur). Il n'y a actuellement qu'un seul modèle qui est utilisé à l'échelle du système. En tant que tel, il n'y a aucune visibilité sur le modèle via l'API.
Joueurs - Les joueurs sont des paramètres spécifiques au client qui capturent des informations générales et des personnalisations à appliquer au modèle. Ces paramètres sont envoyés à l'API et un objet joueur en résulte. Les personnalisations peuvent inclure des paramètres, des styles et des plugins. Pour une liste complète des possibilités de personnalisation, voir le Guide de configuration du lecteur.
Enfants joueurs : les joueurs enfants, créés à l'aide des API Embed, sont le résultat de la création de plusieurs instances d'un joueur. Le lecteur possède la majeure partie des propriétés que vous souhaitez que votre lecteur ait, puis vous pouvez utiliser un lecteur enfant pour personnaliser des sous-ensembles de propriétés sur différentes instances de lecteur. Un lecteur enfant peut uniquement définir des médias à ajouter à un lecteur donné, ou il peut définir n'importe quel paramètre ou style qui modifie le lecteur commun auquel il appartient. Les modifications apportées aux paramètres du joueur parent s'appliqueront à tous les joueurs enfants générés par le joueur parent. Vérifiez Guide d'intégration des API pour plus de détails.
Ce diagramme montre les relations entre le modèle par défaut, les joueurs et les joueurs enfants.
Lorsque vous utilisez l'API de gestion des lecteurs pour la première fois, un lecteur par défaut Brightcove est généré dans votre compte. Cet objet joueur est pour vous de faire comme vous le souhaitez. Vous pouvez l'utiliser tel quel, modifier ses paramètres, le relooker ou ajouter des plugins. Vous pouvez choisir d'utiliser uniquement le Brightcove Default Player avec vos personnalisations, ou vous pouvez choisir de créer d'autres lecteurs pour capturer différentes apparences et paramètres pour différents emplacements sur votre site Web.
Présentation de la publication
L'une des fonctionnalités du système de gestion des lecteurs est la possibilité de séparer les modifications que vous souhaitez tester de la version de votre lecteur qui est publiée publiquement. Dans l'interface utilisateur et l'API, lorsque vous apportez des modifications à la configuration d'un lecteur, les modifications sont immédiatement disponibles via les versions d'aperçu du lecteur. Ces versions d'aperçu sont entièrement utilisables et testables. Vous pouvez partager l'URL d'aperçu pour approbation ou travailler sur l'aperçu du lecteur jusqu'à ce que vous soyez satisfait des modifications, le tout avant de publier le lecteur pour le rendre accessible au public.
Mettre à jour les cascades
La publication d'un joueur a des conséquences qui peuvent affecter les enfants joueurs. Voici des informations sur la publication :
- Une publication de lecteur déclenche une re-publication de toutes les instances de lecteur enfant créées à partir de ce lecteur.
- La publication d'un lecteur enfant n'affecte que ce lecteur enfant.
- Une mise à jour du modèle par défaut de Brightcove (contrôlée par Brightcove) déclenchera une re-publication de tous les joueurs, et la re-publication du joueur déclenchera à son tour une re-publication de tous les joueurs enfants créés à partir de chaque joueur.
Les paramètres sont appliqués de manière à ce que l'enfant gagne. Cela signifie que les paramètres au niveau enfant prévaudront sur les modifications apportées au niveau parent. Tenez compte des points suivants :
- Le modèle par défaut définit une valeur CSS en rouge.
- Un joueur définit la même valeur CSS comme étant blanche.
- Un enfant joueur définit la même valeur CSS en bleu.
Puisque l'enfant gagne, les résultats seraient les suivants :
- La valeur CSS du joueur est blanche.
- La valeur CSS du joueur enfant est bleue.
Ce comportement d'héritage peut être modifié si le type de données de la propriété est un tableau. La section Champs de la baie du Guide d'intégration des API décrit les détails.
Options de configuration
Afin de créer un lecteur plus avancé que le lecteur par défaut, vous devez fournir un Configuration du lecteur. La configuration est définie à l'aide de JSON.
Limitation de débit
L'API de gestion des joueurs a une limitation de débit pour chaque IP unique activée. Voici les limites de taux :
| Type de demande | Limite |
|---|---|
| Publier et créer (lecteurs et intégrations) | 60 requêtes/minute |
| Lire (GET) | 600 requêtes/minute |
| Écrire (POSTER, PUT, PATCH et DELETE) | 300 requêtes/minute |
| Aperçu du lecteur | 100 requêtes/minute |
Codes d'état de réponse
Les codes/messages de réponse et d'erreur sont basés sur ceux défini par W3. Certains des codes les plus courants sont les suivants :
- 200 Demander le succès
- 201 Créé (un joueur, une configuration)
- 400 Mauvaise requête : la syntaxe de l'appel d'API est probablement incorrecte
- 401 Authentification invalide - vérifiez si le mot de passe a été saisi correctement ou si vous avez suivi les Instructions OAuth correctement
- 404 Introuvable : vérifiez si la ressource existe et si l'URL utilisée dans l'appel d'API est correcte
- 429Limite de débit dépassée
- 500 Erreur interne au serveur : une erreur s'est produite lors de la tentative de traitement de la demande