Introduction
Les propriétés que vous pouvez définir dans le player La configuration est détaillée ci-dessous (et répertoriée dans la navigation de gauche) en commençant par identifiant de compte. Ce document contient également des informations sur l'affichage et la configuration des valeurs de propriété.
Voir la configuration
Il existe de nombreuses façons de visualiser playerconfiguration, détaillée dans cette section.
Utiliser Studio
Vous pouvez utiliser Studio pour afficher le playerde la configuration JSON. L'étape suivante détaille le processus:
- Ouvrez le PLAYERS module et localiser le player dont vous souhaitez visualiser la configuration.
- Cliquez sur le lien pour le player ouvrir le playerpropriétés de.
- Cliquez Éditeur JSON dans le menu de navigation de gauche.
- Vous pouvez voir la playerla configuration de, similaire à la suivante:
Parcourir en utilisant config.json
Une instance du nouveau Brightcove playerLa configuration de est stockée dans un fichier JSON. Vous pouvez voir ce fichier JSON, ou des parties de celui-ci, de plusieurs manières.
Une façon de voir le player la configuration est en changeant la playerl'URL de se terminant par index.html
à config.json
. Par exemple:
http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/config.json
Certaines des propriétés du player La configuration définit les éléments suivants:
- Le nom et la version du player
- La ou les vidéos player jouera
- Le compte auquel le player appartient
- La playerID de
- Tous les plugins player peut utiliser, ainsi que les URL des emplacements du code du plugin
- Une affiche à afficher avant la lecture de la vidéo
Un exemple player fichier de configuration, pour un player de l'étape par étape: Player La gestion est la suivante:
{
"player": {
"template": {
"version": "0.9.5",
"name": "single-video-template"
}
},
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
"scripts": [
"http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"
],
"stylesheets": [
"http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
],
"plugins": [{
"name": "firstPlugin"
}],
"account_id": "1507807800001",
"player_id": "54ade2f3-3b51-4a6b-bc87-32b9a0b81384",
"embed_id": "default"
}
{
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
Être avec $PLAYER_ID/configuration
point final
Vous pouvez récupérer la même information que celle affichée en utilisant le HTTP GET
méthode. En utilisant GET
des /$PLAYER_ID/configuration
point de terminaison, vous pouvez récupérer le publié player's informations de configuration. Un exemple d'instruction curl, et le JSON récupéré est montré ici:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request GET \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
{
"player": {
"template": {
"version": "0.9.5",
"name": "single-video-template"
}
},
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
{
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
GET méthode $PLAYER_ID
point final
Le HTTP GET
méthode utilisée avec /$PLAYER_ID
point de terminaison est le moyen de récupérer complète player information. Cette approche donne un surensemble de player configuration que vous venez de voir. Vous pouvez penser à ce point de terminaison vous montrant les informations de configuration "un niveau plus haut" et inclut les informations de configuration actuelles pour l'aperçu et la publication player versions. Un exemple d'instruction curl, et le JSON récupéré est montré ici:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request GET \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID
{
"id": "HJyMlHiuZ",
"name": "Video Cloud CURL 10 March",
"branches": {
"preview": {
"configuration": {
"plugins": [{
"name": "firstPlugin"
}],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"player": {
"template": {
"version": "6.5.0",
"name": "single-video-template"
}
},
"video_cloud": {
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT",
"video": "4093372393001"
},
"media": {
"sources": [{
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8",
"type": "application/x-mpegURL"
}, {
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
"type": "video/mp4"
}],
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
}
}
},
"video_cloud": {
"aspect_ratio_height": "9",
"aspect_ratio_width": "16",
"video_id": "4093372393001",
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001"
},
"updated_at": "2017-08-23T18:09:52.590Z",
"template_updated_at": "2017-08-23T17:48:55.615Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/preview/embeds/default/master/index.html"
},
"master": {
"configuration": {
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
},
"video_cloud": {
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001",
"video_id": "4093372393001",
"aspect_ratio_width": "16",
"aspect_ratio_height": "9"
},
"updated_at": "2017-08-23T18:10:11.843Z",
"template_updated_at": "2017-08-23T17:48:55.622Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/master/embeds/default/master/index.html"
}
},
"created_at": "2017-08-23T17:48:55.615Z",
"accountId": "1507807800001",
"embed_count": 1,
"url": "http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/index.html"
}
{
"account_id": "1507807800001",
"branches": {
"preview": {
"configuration": {
"plugins": [{
"name": "firstPlugin"
}],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"player": {
"template": {
"version": "1.5.0",
"name": "single-video-template"
}
},
"video_cloud": {
"policy_key": "BCpkADawqM3ClR-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-BH",
"video": "3495887198001"
}
},
"video_cloud": {
"aspect_ratio_height": "14",
"aspect_ratio_width": "25",
"video_id": "3495887198001",
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001"
},
"updated_at": "2014-10-23T14:33:21.107Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/preview/embeds/default/master/index.html"
},
"master": {
"configuration": {
"video_cloud": {
"video": "3495887198001",
"policy_key": "BCpkADawqM3ClR-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-BH"
},
"player": {
"template": {
"name": "single-video-template",
"version": "1.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
},
"video_cloud": {
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001",
"video_id": "3495887198001",
"aspect_ratio_width": "25",
"aspect_ratio_height": "14"
},
"updated_at": "2014-10-23T14:33:41.201Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/master/embeds/default/master/index.html"
}
},
"id": "a90a8479-9831-46f6-9eab-90efc7fb9c6b",
"name": "1031+on+Oct+23",
"created_at": "2014-10-23T14:32:21.384Z",
"embed_count": 1,
"url": "http://players.brightcove.net/1507807800001/a90a8479-9831-46f6-9eab-90efc7fb9c6b_default/index.html"
}
Définir le nom / la description
Pour modifier le player configuration que vous utilisez /$ACCOUNT_ID/players/$PLAYER_ID/configuration
point final, et c'est l'accent de ce document. Il y a, cependant, deux propriétés que vous changez en utilisant seulement /$ACCOUNT_ID/players/$PLAYER_ID
point final. Ces deux propriétés sont name
et description
.
Noter la name
vous entrez pour le player est retourné comme player_name
quand vous obtenez la configuration en mettant config.json
à la fin de la player URL d'aperçu (elle est renvoyée sous la forme name
quand vous obtenez la configuration via le Player Management API. Mais vous devez utiliser name
lorsque vous créez ou mettez à jour le player.
Le premier bloc de code montre un exemple d'instruction curl qui modifie un player's name
et description
. Notez que la réponse JSON affiche des versions d'aperçu du player sont générés par la méthode PATCH, vous devrez donc publier le player pour obtenir les versions optimisées.
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"name": "My New Player Name",
"description": "My new player description"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
{
"id": "62da9b4d-b8aa-45d5-ba46-f77eac9c9059",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html",
"preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
}
Définir des valeurs
Vous pouvez définir le player les valeurs de configuration à l'aide de tout outil qui émet des appels de méthode HTTP OU à l'aide de la Éditeur JSON qui fait partie de Studio PLAYERS module. L’outil Curl peut être utilisé et des exemples d’instructions apparaissent dans Pas à pas: Player Direction et l'utilisation AJAX expliqué dans beaucoup de Brightcove Player exemples.
Un exemple de changement utilisant le Éditeur JSON est montré ici:

Veillez à enregistrer vos modifications après avoir modifié le playerde la configuration JSON.
Configuration des propriétés
Certaines propriétés de configuration sont définies par le Player Service de gestion et ne sont pas modifiables. Ce sont:
- identifiant de compte
- player_id
- embed_id
Toutes les autres propriétés détaillées ci-dessous sont modifiables.
Les détails sur les propriétés suivent. Vous pouvez utiliser la liste ci-dessous pour accéder rapidement à des propriétés spécifiques.
- identifiant de compte
- ad_config_id
- ad_failover
- application_id
- autoadvance
- autoplay
- base_url
- des points d'arrêt
- crossorigin
- css
- débogueur
- quai
- embed_id
- erreurs
- flash
- fullscreenControl
- hls
- inactif
- la langue
- langues
- boucle
- Médias
- sourdine
- picture_in_picture_control
- taux de lecture
- player
- Bouton jouer
- player_id
- player_nom
- playsinline
- listes de lecture
- plugins
- pré-charge
- query_string_to_window
- répéter
- sensible
- scripts
- sans cellulite
- feuilles de style
- technicien
- version
- video_cloud
- volume_orientation
- vttjs
- wait_for_ad_block_detect
identifiant de compte
La Video Cloud ID de compte associé au player. Cette valeur ne peut pas être modifié.
ad_config_id
ad_config_id
informations:
- Type de données: chaîne
- Valeur par défaut:
undefined
- Un De DynamiqueliveID de configuration d'annonce SSAI. En plus d'être réglé sur le player configuration, il peut être défini au moment de l'exécution via le paramètre de chaîne de requête adConfigId pour iframe players ou l'attribut data-ad-config-id pour l'encart players. L'un ou l'autre remplacera toute valeur dans le player configuration.
ad_failover
ad_failover
informations:
- Type de données: booléen
- Valeur par défaut:
undefined
- Définissez sur true pour activer le comportement de basculement des annonces. Il s'agit d'une configuration en plusieurs parties qui dépend de:
- Les plug-ins IMA3 et SSAI doivent être configurés sur le player.
- An
ad_config_id
devrait être disponible, sinon les publicités SSAI ne sont pas disponibles.
application_id
application_id
informations:
- Type de données: chaîne
- Valeur par défaut:
undefined
- L'ID d'application est utilisé pour différencier plusieurs utilisations d'un même player en métriques. Il est invisible pour l'utilisateur.
autoadvance
autoadvance
informations:
- Type de données: chaîne
- Par défaut: pas initialement activé
- Utilisé avec les playlists et définit le comportement d'autoadvance de la playlist.
Pour de plus amples renseignements, consultez le Playlists section ci-dessous, ainsi que API Playlist document.
autoplay
autoplay
informations:
- Type de données: booléen ou chaîne
- Valeur par défaut:
false
- Indique que le player devrait commencer à jouer immédiatement, sur les plateformes où cela est autorisé.
If autoplay
est défini sur une valeur booléenne, le comportement de lecture automatique natif du navigateur est utilisé. S'il est défini sur l'une des trois valeurs de chaîne valides suivantes, les événements suivants se produisent:
play
: Le player essaiera manuellement d'appeler play.muted
: Le player coupera manuellement le son player et appelez play.any
: Le player va d'abord essayer d'appeler play. Si cela échoue, coupez le son player et appelez play.
Si l'une des situations ci-dessus échoue, le player affichera le "Big Play Button" comme si la lecture automatique était définie sur false.
Ce qui suit montre une déclaration curl pour définir le autoplay
valeur:
Exemple utilisant des valeurs booléennes
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"autoplay": true
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Exemple d'utilisation de valeurs de chaîne
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"autoplay": "muted"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Envoyer une vidéo en lecture automatique peut être une situation complexe. Voir le Considérations de lecture automatique document pour plus de détails.
base_url (pour les problèmes de restriction IP)
Des problèmes peuvent survenir lors de l’utilisation de restrictions IP avec Brightcove Players utilisé en dehors de l’Amérique du Nord. Lorsqu'un Brightcove Player est invité à charger une vidéo à partir d'un Video Cloud compte, il se connecte au catalogue à cette adressehttps://edge.api.brightcove.com/playback/v1/.
Ce point de terminaison Edge se comporte d'une manière qui peut causer des problèmes de restriction IP:
- Lorsque vous appuyez sur Edge à partir de WITHIN North America, Edge touche directement Edge et Edge voit l'adresse IP de l'utilisateur. Il peut soit autoriser, soit interdire l'accès au catalogue conformément à la liste blanche IP Restriction. Ceci est la fonctionnalité souhaitée.
- Lorsque vous appuyez sur Edge depuis OUTSIDE North America, il passe par Cloudfront pour des raisons CDN d'équilibrage de charge et de mise en cache locale. C'est important, parce que Edge voit l'IP Cloudfront au lieu de l'IP de l'utilisateur, et refuse tout le monde, parce que Cloudfront n'est pas sur la liste blanche (et ne devrait jamais l'être, car quiconque utilisant Cloudfront aurait accès).
Pour résoudre ce problème, vous pouvez configurer le player d'utiliser un autre point de terminaison Edge, edge-elb.api.brightcove.com. Cette modification doit être apportée à chaque player qui doit accéder au compte IP restreint depuis l'extérieur de l'Amérique du Nord.
Le changement de configuration actuel implique la définition d’une valeur pour Video Cloud base_url
. Rappelez-vous, ceci devrait UNIQUEMENT être changé si les restrictions IP sont utilisées avec Brightcove Players en dehors de l'Amérique du Nord. Pour un existant player, vous utiliseriez la commande curl suivante qui utilise le PATCH
Méthode HTTP (vous devez remplacer vos données pour les variables d'environnement $EMAIL
, $ACCOUNT_ID
et $PLAYER_ID
):
curl
--header "Content-Type: application/json"
--user $EMAIL
--request PATCH
--data '{
"video_cloud": {
"base_url": "https://edge-elb.api.brightcove.com/playback/v1/"
}
}'
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Si vous êtes nouveau à curl, les documents suivants seront utiles:
des points d'arrêt
breakpoints
informations:
- Type de données: Objet
- Par défaut: Les points d'arrêt par défaut sont les suivants:
- Lorsqu'il est utilisé avec sensible , définit des points d'arrêt qui configureront le basculement des noms de classe sur le player pour ajuster l'interface utilisateur en fonction de la playerdimensions de.
Nom du cours width Plage vjs-layout-tiny 0-210 vjs-layout-x-small 211-320 vjs-layout-small 321-425 vjs-layout-medium 426-768 vjs-layout-large 769-1440 vjs-layout-x-large 1441-2560 vjs-layout-énorme 2561
Bien que les noms de classe ne puissent pas être modifiés, les plages de largeur peuvent être configurées via un objet comme celui-ci:
breakpoints: {
tiny: 300,
xsmall: 400,
small: 500,
medium: 600,
large: 700,
xlarge: 800,
huge: 900
}
- Les clés de l’objet points de rupture sont dérivées des noms de classe associés en supprimant la
vjs-layout-
préfixe et tout-
caractères. - Les valeurs de l'objet points d'arrêt définissent la largeur maximale d'une plage.
- Il n'est pas nécessaire de définir toutes les clés. Vous pouvez facilement remplacer un seul point d'arrêt en passant un objet avec une paire clé / valeur. Les points d'arrêt personnalisés seront fusionnés avec les points d'arrêt par défaut lorsque le player est créé.
When the playerSi la taille change, les points d'arrêt fusionnés seront inspectés dans l'ordre de taille jusqu'à ce qu'un point d'arrêt correspondant soit trouvé. Le nom de classe associé à ce point d'arrêt sera ajouté en tant que classe au player. La classe du point d'arrêt précédent sera supprimée.
crossorigin
crossorigin
informations:
- Type de données: booléen
- Par défaut: false
- If vrai, le sous-jacent élément aura crossorigin = "anonyme". Cela signifie que toutes les vidéos ou pistes de texte player doit avoir des en-têtes CORS.
Remplacements de couleurs CSS
Trois propriétés peuvent être utilisées pour remplacer les couleurs player. Ils sont les suivants:
controlColor
: La couleur des boutons et du texte (par exemple, la position de la tête de lecture et la durée de la vidéo)controlBarColor
: La couleur de fond de la barre de contrôle et le gros bouton LectureprogressColor
: La couleur de la barre de progression
Toute couleur CSS valide (y compris les couleurs hexadécimales, par exemple) sont des valeurs acceptables pour ces propriétés.
Voici une instruction curl pour mettre en vert les trois propriétés CSS, suivie d'une capture d'écran affichant les résultats:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"css": {
"controlColor": "green",
"controlBarColor": "green",
"progressColor": "green"
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

débogueur
Le débogueur montre player informations dans une fenêtre modale. Voir le Player Information modale document pour des informations complètes.
quai
dock
informations:
- Type de données: booléen
- Par défaut: true
- Si explicitement
false
, player ne comprendra pas le soi-disant quai où le titre et la description de la vidéo peuvent être affichés.
embed_id
embed_id
informations:
- Type de données: chaîne
- Valeur par défaut:
undefined
- La Video Cloud ID d'intégration associé à ce player. Si la valeur est
default
cela signifie que player n'est pas un enfant player. Si la valeur n'est pasdefault
, il s'agit d'une valeur représentant le parent du player.
erreurs
errors
informations:
- Type de données: objet ou booléen
- Par défaut: true
- Réglage explicite
false
empêchera la player d'inclure videojs-erreurs, qui est le plugin des messages d'erreur. Rendre cette valeur fausse provoquera la player pour ne pas afficher de messages d'erreur détaillés aux téléspectateurs lorsqu'une erreur se produit. Les erreurs qui empêchent la lecture apparaîtront toujours dans la console du développeur Web.
flash
flash
informations:
- Type de données: Objet
- Valeur par défaut:
undefined
- Peut être utilisé pour fournir des options Flash personnalisées à Video.js.
fullscreenControl
fullscreenControl
informations:
- Type de données: booléen
- Par défaut: true
- Indique si le contrôle en plein écran doit être affiché dans la barre de contrôle
Ce qui suit montre une déclaration curl pour définir le fullscreenControl
valeur:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"autoplay": true,
"fullscreenControl": false
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Les deux captures d'écran suivantes montrent le player avec et sans le contrôle plein écran:


hls
hls
informations:
- Type de données: objet ou booléen
- Valeur par défaut:
{}
- If
false
, player ne comprendra pas videojs-http-streaming. Sinon, un objet sera transmis en tant qu'options pour videojs-http-streaming.
Inactif player
Il est possible de faire players inactif. Vous voudrez peut-être le faire pour avoir un player cesser de diffuser du contenu, mais aucune erreur 404 n'apparaît si un élément supprimé player est parcouru.
Pour désactiver un player définir la player
des champs inactive
propriété à true
, comme suit :
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"player": {
"inactive": true
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Bien sûr, si vous souhaitez activer le player, vous pouvez définir le inactive
propriété à false
.
Une fois que le player est désactivé, si un utilisateur parcourt le player le message suivant apparaîtra:

la langue
language
informations:
- Type de données: chaîne
- Valeur par défaut:
undefined
- Peut être fourni pour définir le
lang
attribut de la<html>
élément.
langues
languages
informations:
- Type de données: tableau de chaîne
- Valeur par défaut:
undefined
- Peut être un tableau de chaînes qui entraînera l'inclusion des langues spécifiées dans le player. Les seules langues valides sont celles incluses dans Video.js. Voir le Localisation Brightcove Player document pour plus d'informations.
boucle
loop
informations:
- Provoque le redémarrage de la vidéo dès qu'elle se termine.
Médias
La media
La propriété possède des propriétés enfant, comme indiqué dans le tableau suivant.
Propriété | Type de données | Description |
---|---|---|
src | un magnifique |
|
sources | tableau d'objets |
|
titre | un magnifique |
|
poster.highres | un magnifique |
|
la taille | un magnifique |
|
largeur | un magnifique |
|
vos titres | tableau |
|
Dans le JSON suivant, vous pouvez voir un media
propriété contenant:
- A poster.highres propriété
- A sources propriété contenant deux objets source, un pour une vidéo HLS et un pour une vidéo MP4
"media": {
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
},
"sources": [{
"type": "application/x-mpegURL",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
}, {
"type": "video/mp4",
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
}]
},
La source sélectionnée pour la lecture est déterminée par l'ordre vidéo que vous avez configuré et les capacités du navigateur et de l'appareil sur lequel le player est chargé. Si vous n'avez pas modifié les valeurs par défaut et que HLS est pris en charge nativement, le player vérifiera si l'une des sources pointe vers des vidéos HLS et sélectionne la première qu'elle trouve. Si HLS n'est pas pris en charge nativement ou qu'aucune source vidéo HLS n'a été spécifiée, la lecture HTML sera tentée ensuite. Comme précédemment, la première source jouable sera sélectionnée. Si les deux premières tentatives de lecture de la vidéo échouent, la solution de secours Flash sera tentée.
Pour récapituler, l'ordre de lecture spécifie votre support de lecture préféré, puis chaque option configurée essaie toutes les sources disponibles et utilise la première qu'elle sait lire.
Vous pouvez voir quelle source joue en utilisant le currentSrc()
fonction. La capture d'écran suivante montre l'utilisation de la fonction dans une console de navigateur.

sourdine
muted
informations:
- Type de données: booléen
- Par défaut: false
- Détermine si le son est coupé lorsque le player charges.
picture_in_picture_control
picture_in_picture_control
informations:
- Type de données: booléen
- Par défaut: true
- Indique si le contrôle d'image dans l'image intégré doit être affiché dans la barre de contrôle.
taux de lecture
playback_rates
informations:
- Type de données: Array
- Par défaut: aucun
- Tableau de vitesses de lecture à afficher dans le contrôle de la vitesse de lecture.
Les valeurs sont lues puis présentées dans un contrôle de taux de lecture dans le playerde la barre de contrôle.

Vous pouvez utiliser Studio ou curl pour modifier la valeur de la propriété:

curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"playback_rates": [0.1,1,2.5,6]
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
player
player
informations:
- Type de données: Objet
- Par défaut: remplir avec player information spécifique
- Contient diverses métadonnées à ce sujet player, par exemple
inactive
ettemplate.version
.
Bouton jouer
play_button
informations:
- Type de données: Objet
- Les propriétés suivantes peuvent être modifiées via player configuration:
Propriété Type Effet flotter un magnifique glow
ordarken
; le défaut est rose / couleur de progressionforme un magnifique square
orrectangle
; le défaut est un cercleposition un magnifique topLeft
ortopRight
; le défaut est le centre
player_id
player_id
informations:
- Type de données: chaîne
- La Video Cloud player ID associé à un player
player_nom
player_name
informations:
- Type de données: chaîne
- La Video Cloud player nom associé à un player - noter la
name
vous entrez pour le player est retourné commeplayer_name
quand vous obtenez la configuration en mettantconfig.json
à la fin de la player URL d'aperçu (elle est renvoyée sous la formename
quand vous obtenez la configuration via le Player Management API. Mais vous devez utilisername
lorsque vous créez ou mettez à jour le player.
playsinline
playsinline
informations:
- Type de données: booléen
- Par défaut: false
- Active la player pour la lecture en ligne (nécessaire pour la lecture sur certains appareils).
Playlists
Il existe maintenant deux implémentations de playlist différentes, détaillées dans le Utilisation de listes de lecture document. La valeur par défaut est la version 3. Les informations pour la configuration des deux versions sont détaillées ici.
Les deux configurations montreront comment définir les éléments suivants:
autoadvance
: Nombre entier assigné en secondes à retarder avant de charger la vidéo suivante dans la playlist; valeur de0
assigné ne causera pas d'attente entre les vidéos; valeur denull
assigné ne provoquera aucune avance automatique.playOnSelect
: Attribuétrue
Ainsi, lorsque vous cliquez sur un élément du menu de la liste de lecture, la vidéo est lue lors du chargement, même si la vidéo précédente du player a été interrompu.
Version de la playlist 3 (par défaut)
Pour configurer les playlists en utilisant le plugin 3 version, vous utilisez le Registre Plugin. Voici une instruction curl pour configurer l'utilisation du plugin 3 de la version Playlist:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Plugin Registry Test Player",
"configuration": {
"video_cloud": {
"video": "4093372393001"
},
"plugins": [
{
"registry_id": "@brightcove/videojs-bc-playlist-ui",
"version": "3.x"
}
]
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
Voir le Registre des plugins document d'information sur son utilisation et ses avantages.
Pour définir le playOnSelect
et autoadvance
options lors de la création du player utilisez le suivant:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Plugin Registry Test Player",
"configuration": {
"video_cloud": {
"video": "4093372393001"
},
"plugins": [
{
"registry_id": "@brightcove/videojs-bc-playlist-ui",
"version": "3.x",
"options": {
"playOnSelect": true
}
}
],
"autoadvance": 2
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
Playlist Version 1 (Legacy)
En plus de autoadvance
et playOnSelect
deux autres propriétés qui sont utilisées pour configurer l'utilisation des playlists version 1. Elles sont:
playlist
: Attribuétrue
avoir un player utiliser des listes de lecture.adjusted
: Attribuétrue
avoir le player régler player dimensions pour la playlist.
Voici une instruction curl pour définir trois des propriétés liées à la playlist:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"playlist": true,
"autoadvance": 2,
"studio_configuration": {
"player": {
"adjusted": true,
"height": "",
"width": ""
}
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Mettre en place playOnSelect
pour les playlists version 1, utilisez l'instruction curl suivante:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
{"playOnSelect": true}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
Déterminer par programme si player contient une playlist
Si vous utilisez JavaScript dans une page qui contient un player et souhaitez vérifier si un plugin de playlist est utilisé, vous pouvez utiliser les éléments suivants:
player.hasPlugin('playlist')
Si vous recherchez la présence d'un plugin de playlist, et non dans une page avec un player (par exemple lors de la vérification d'une liste de players pour une utilisation avec un connecteur), vous devez utiliser un processus un peu plus compliqué. Vous liriez le playerconfiguration, puis vérifiez si le plugins l'article de l' playerJSON contient "nom": "bcPlaylistUi". Une solution pour cette tâche est la suivante:
var theJSON = {},
pluginAra = [],
ifFound = [],
theJSONString =
'{"account_id":"1507807800001","autoadvance":0,"autoplay":false,"embed_id":"default","fullscreenControl":true,"id":"r1fbqySRZ","player":{"inactive":false,"template":{"locked":false,"name":"single-video-template","version":"6.8.3","version_alias":null}},"player_id":"r1fbqySRZ","player_name":"playlist v2 junk","playlist":true,"plugins":[{"injected_version":"2.1.2","name":"bcPlaylistUi","options":{"playOnSelect":true},"registry_id":"@brightcove/videojs-bc-playlist-ui","version":"2.x"}],"preload":"metadata","scripts":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.min.js"],"studio_configuration":{"player":{"adjusted":true,"height":150,"width":300}},"stylesheets":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.css"],"updated_at":"2017-10-30T18:06:07.800Z","video_cloud":{"policy_key":"BCpkADawqM2_X3Xxh3xln23EqlR3BETHrfycIPT-a7kqhBi6q8g3XOmTr3tEJiFoi_YmI7vfbJzS4mY0Un5RACc3jC8cLVqyvmfWFLI-tG5oJYGXNUrvOwRJYQEt2eVpMZnBd0FH22i7Mtk3","video":null}}';
theJSON = JSON.parse(theJSONString);
pluginAra = theJSON.plugins;
ifFound = pluginAra.filter(function(pluginAra) {
return pluginAra.name === "bcPlaylistUi"
});
if (ifFound.length === 1) {
console.log('Contains playlist plugin');
} else {
console.log('No playlist');
}
plugins
La plugins
property spécifie l'ordre d'initialisation des plugins video.js et tous les paramètres personnalisés à leur appliquer. Le plugin doit être supporté par un correspondant scripts
entrée d'URL de propriété, et si nécessaire un support stylesheets
URL Chaque élément de la plugins
tableau est un objet avec un name
propriété, et peut également contenir une option options
propriété:
name
: Le nom du plugin video.js, extrait du code JavaScript de prise en chargeoptions
: Un hachage d'objets de paramètres redéfinit pour fournir au plugin au moment de l'initialisation
Options enfant
Dans ce options
propriété enfant, vous transmettez des données à utiliser au moment de l'initialisation. Le JSON suivant passe dans un seul objet dans le options
.
"plugins": [{
"name": "navigateOnVideoEnd",
"options" : {"redirectURL": "http://docs.brightcove.com"}
}]
Cela vous donne la possibilité de transmettre des données à un plugin via le player configuration. Par exemple, pour utiliser le redirectURL
objet montré ci-dessus, vous feriez ce qui suit dans le plugin lui-même:
videojs.registerPlugin('navigateOnVideoEnd', function (options) {
var myPlayer = this;
myPlayer.on("ended", function () {
window.location.href = options.redirectURL;
});
});
Note: vous utilisez l'implémentation du plugin standard, mais utilisez options
en tant que paramètre dans la fonction anonyme. Vous pouvez ensuite accéder à la valeur en utilisant options.propertyName
notation.
Certains plug-ins fournis par Brightcove utilisent le registre des plug-ins et la configuration est différente de celle illustrée ici. Voir le Vue d'ensemble: Registre des plugins document pour des informations détaillées.
pré-charge
preload
informations:
- Type de données: chaîne
- Valeur par défaut:
none
- L'attribut preload informe le navigateur que les données vidéo doivent ou non commencer à être téléchargées dès que la balise vidéo est chargée. Les options sont auto, métadonnées aucun.
-
auto: Indique que le fichier vidéo entier peut être téléchargé, même si l'utilisateur ne regarde pas la vidéo. Du côté positif, si le spectateur lit la vidéo, il peut commencer à jouer immédiatement. Du côté négatif, cette option augmentera la consommation de bande passante car la précharge / chargement se produit même si le spectateur ne lit pas la vidéo.
-
métadonnées (par défaut): Chargez les métadonnées de la vidéo, qui incluent des informations telles que la durée et les dimensions de la vidéo. Ce paramètre charge également plusieurs secondes de données vidéo.
-
aucun: Ne préchargez aucune des données vidéo. Cela attendra jusqu'à ce que l'utilisateur clique sur lecture pour commencer le téléchargement.
<video-js preload ...>
or
{ "preload": "auto" }
query_string_to_window
query_string_to_window
informations:
-
- Nom:
query_string_to_window.target
- Type de données: chaîne
- Description: Objet de destination à créer sur la fenêtre, qui sera rempli avec la totalité de la chaîne de requête analysée. Par exemple, une utilisation de
query_string_to_window.target
étant donné ce qui suit dans un player configuration:{ "query_string_to_window": {"target": "queryStringParams"} }
?foo=bar&nums=1&nums=2
window.queryStringParams
objet global serait disponible pour le player et plugins:{ foo: 'bar', nums: ['1', '2'] }
- Nom:
-
- Nom:
query_string_to_window.globals
- Type de données: Array
- Description: Un tableau de noms de propriétés de l'objet window, qui sera rempli à partir des valeurs trouvées dans la chaîne de requête. Toutes les propriétés correspondantes qui existent déjà sur le
window
objet ou sa chaîne prototype ne sera pas définie. Par exemple, une utilisation dequery_string_to_window.globals
étant donné ce qui suit dans un player configuration:{ "query_string_to_window": { "globals": [ "foo", "nums", "self" ] } }
?foo=bar&nums=1&nums=2&self=not-allowed
window
objet global avec les propriétés suivantes ajoutées:window.foo; // 'bar' window.nums; // ['1', '2'] // Because `self` already exists on the `window` object, it will not be set // and a warning will be logged to the browser console. window.self; // window
- Nom:
répéter
repeat
informations:
- Le type de données est
boolean
- Fera répéter la lecture d'une liste de lecture SI le player est une playlist player. Situé au niveau supérieur du player configuration.
sensible
responsive
informations:
- Type de données: booléen
- Valeur par défaut:
true
- Définir cette option sur
true
provoque l' player pour se personnaliser en fonction des points d'arrêt réactifs (voir: des points d'arrêt option).
Pour plus de détails sur l'activation de cette fonctionnalité, voir les notes de publication de Brightcove Player 6.29.2.
scripts
scripts
informations:
- Le type de données est un tableau de chaînes faisant référence à des fichiers JavaScript inclus avec le player
- Pas de valeur par défaut
- Au moment où le player est construit, ces fichiers seront téléchargés et intégrés dans la sortie résultante afin qu'ils n'aient pas besoin d'être récupérés ultérieurement au moment de l'exécution
- Les scripts sont insérés dans l'ordre dans lequel ils sont spécifiés afin que vous puissiez inclure des scripts qui dépendent les uns des autres
sans cellulite
skin
informations:
- Type de données: booléen ou chaîne
- Par défaut: undefined
- Détermine la variante de style visuel que le player utilisera. Cette valeur se reflète également dans le
bc.SKIN
propriété dans le navigateur. Il reconnaît les valeurs suivantes:Valeur bc.SKIN Description "graphite" "graphite" Utilise l'ancien Brightcove Player style, ainsi que des astuces de compatibilité. faux "aucun" Désactive tout Brightcove Player coiffant. C'est l'option à utiliser pour une interface utilisateur hautement personnalisée à partir de la base. indéfini "luna" Laissant cette undefined
provoque l' player pour utiliser le skin par défaut (aka Luna).
feuilles de style
stylesheets
informations:
- Un tableau de chaînes URL faisant référence à des fichiers CSS qui devraient être inclus avec le player
- Au moment où le player est construit, les feuilles de style supplémentaires sont téléchargées et intégrées dans le player afin qu'ils n'aient pas besoin d'être récupérés lors de l'exécution
- Les feuilles de style sont incluses dans l'ordre dans lequel vous les spécifiez
technicien
techOrder
informations:
- Type de données: Array
- Par défaut: ['html5', 'flash']
- Par défaut Brightcove Player effectue première technologie commande lorsqu'il recherche une combinaison source / technologie pour lire des vidéos. Cela signifie que si vous avez deux sources et deux techniciens, le player va essayer de lire chaque vidéo avec la première technologie du
techOrder
propriété d'option avant de passer à essayer la prochaine technologie de lecture. Voir le Guide: Technologie de lecture document pour plus d'informations.
Vous pouvez utiliser l'instruction curl suivante pour modifier le techOrder
du défaut de ['html5','flash']
à ['flash','html5']
:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"techOrder": "['flash','html']"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
version
Vous pouvez définir manuellement player version utilisant le PLAYERS E/S, contrôle PID ou de communication Éditeur JSON.

video_cloud
Avec cette propriété, vous pouvez créer un player en utilisant une vidéo de votre Video Cloud bibliothèque. La déclaration curl ci-dessous montre player création à l'aide d'un Video Cloud ID de la vidéo.
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Video Cloud CURL 10 March",
"configuration": {
"video_cloud": {
"video": "4093372393001"
}
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
Notez que dans l'objet corps de la requête, name
et description
sont des propriétés de haut niveau, et toutes les autres propriétés du configuration
objet. N'importe lequel des propriétés de configuration peut être inclus dans le configuration
lorsque vous créez le player.
volume_orientation
volume_orientation
informations:
- Type de données: chaîne
- Par défaut: horizontal
- La
volume_orientation
Cette propriété détermine si le curseur de niveau de volume est orienté horizontalement ou verticalement.
Vous pouvez utiliser Studio ou curl pour modifier la valeur de la propriété:

curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"volume_orientation": "vertical"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
vttjs
vttjs
informations:
- Type de données: chaîne
- Par défaut: vjs.zencdn.net CDN
- Définit l'URL à partir de laquelle charger vtt.js. C’est la même chose que l’option standard Video.js
vtt.js
. le Brightcove Player Usagesvttjs
à la place, un nom de propriété en pointillé n’est pas possible à utiliser dans le Player Management API, et peut être problématique ailleurs. L'option peut être définie commedata-vttjs
attribut, unvttjs
paramètre de requête iframe, unvttjs
option d'installation ouvttjs
de player configuration.
wait_for_ad_block_detect
wait_for_ad_block_detect
informations:
- Type de données: booléen
- Par défaut: undefined
- Lorsqu'il est configuré pour
true
, player retardera son processus d'auto-initialisation jusqu'à ce que la détection du bloc d'annonces ait pris une décision. Cela peut retarder player initialisation jusqu'à 100 millisecondes environ. Cela n'a pas besoin d'être réglé surtrue
lors de l'utilisationad_failover
car le comportement de retard se produit dans les deux cas.