Guide de configuration du lecteur

Cette rubrique décrit comment afficher et modifier la configuration du lecteur. La syntaxe JSON est également documentée.

Introduction

Les propriétés que vous pouvez définir dans la configuration du lecteur sont détaillées ci-dessous (et répertoriées dans la navigation de gauche) en commençant par identifiant de compte. Ce document contient également des informations sur la façon d'afficher et de configurer les valeurs de propriété.

Voir la configuration

Il existe de nombreuses façons d'afficher la configuration du lecteur, détaillées dans cette section.

Utilisation de Studio

Vous pouvez utiliser Studio pour afficher la configuration JSON du lecteur. L'étape suivante détaille le processus :

  1. Ouvrez le JOUEURS module et localisez le lecteur dont vous souhaitez visualiser la configuration.
  2. Cliquez sur le lien correspondant au lecteur pour ouvrir ses propriétés.
  3. Cliquez sur JSON Editor dans le menu de navigation de gauche.
  4. Vous pouvez afficher la configuration du lecteur, semblable à ce qui suit :
    Editeur JSON

Parcourir à l'aide config.json

Une instance de la configuration du nouveau lecteur Brightcove 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 d'afficher la configuration du lecteur consiste à modifier l'URL du lecteur qui ne se termine pas par index.html à config.json. Par exemple :

  http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/config.json

Certaines propriétés de la configuration du lecteur définissent les éléments suivants :

  • Le nom et la version du joueur
  • La ou les vidéos que le lecteur va lire
  • Le compte auquel appartient le joueur
  • L'identifiant du joueur
  • Tous les plugins que le joueur peut utiliser, ainsi que les URL pour les emplacements du code du plugin
  • Une affiche à afficher avant la lecture vidéo

Un exemple de fichier de configuration de lecteur, pour un lecteur de l'étape par étape : Gestion des joueurs, 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": "BCpkADawqM2FnBS3Inxz...ZzHMB6hT"
      },
      "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 les mêmes informations que celles affichées en utilisant le HTTP GET méthode. En utilisant GET avec le /$PLAYER_ID/configuration point de terminaison, vous pouvez récupérer les informations de configuration du lecteur publié . 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": "BCpkADawqM2FnBS3InxzDx...HMB6hT"
      },
      "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

La GET méthode HTTP utilisée avec le /$PLAYER_ID point de terminaison est le moyen de récupérer des informations complètes sur le lecteur. Cette approche donne un surensemble de configuration de joueur que vous venez de voir. Vous pouvez penser à ce point de terminaison qui vous montre des informations de configuration "au niveau supérieur" et inclut des informations de configuration actuelles pour les versions de prévisualisation et de lecteur publié. 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": "BCpkADawqM2FnBS3Inx...N44i24jZzHMB6hT",
              "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": "BCpkADawqM2FnBS3InxzD...4i24jZzHMB6hT"
            },
            "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-sni6...AdvTpTb29d4S-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-sn...tHcAdvTpTb29d4S-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/description

Pour modifier la configuration du lecteur, vous utilisez le /$ACCOUNT_ID/players/$PLAYER_ID/configuration point de terminaison, et c'est l'accent mis sur ce document. Il y a cependant deux propriétés que vous modifiez en utilisant uniquement le /$ACCOUNT_ID/players/$PLAYER_ID point de terminaison. Ces deux propriétés sont name et description.

Noter la name vous entrez pour le joueur est retourné comme player_name quand vous obtenez la configuration en mettant config.json à la fin de l'URL d'aperçu du lecteur (elle est renvoyée sous la forme name lorsque vous obtenez la configuration via l'API Player Management. Mais vous devez utiliser name lorsque vous créez ou mettez à jour le lecteur.

Le premier bloc de code montre un exemple d'instruction curl qui modifie le comportement d'un joueur name et description. Notez que la réponse JSON montre que les versions d'aperçu du lecteur sont générées par la méthode PATCH, vous devrez donc publier le lecteur 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 allow='encrypted-media'></iframe>"
  }

Définition des valeurs

Vous pouvez définir les valeurs de configuration du lecteur en utilisant n'importe quel outil qui émet des appels de méthode HTTP OU en utilisant le Éditeur JSON qui fait partie de Studio's JOUEURS module. L'outil curl peut être utilisé, et des exemples d'instructions affichés dans l' étape étape par étape : Gestion des joueurs et l'utilisation d'AJAX expliquée dans de nombreux Exemples de lecteur Brightcove.

Un exemple de changement en utilisant le Éditeur JSON est montré ici :

JSON Editor pas de marque Brightcove Player

Assurez-vous d'enregistrer vos modifications après avoir modifié la configuration JSON du lecteur.

Configuration des propriétés

Certaines propriétés de configuration sont définies par le service de gestion des lecteurs et ne sont pas modifiables. Ce sont:

  • identifiant de compte
  • player_id
  • id_embed

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

L'identifiant du compte Video Cloud associé au lecteur. Cette valeur ne peut pas être modifié.

ad_config_id

ad_config_id informations:

  • Type de données : chaîne
  • Défaut : undefined
  • ID de configuration d'annonce SSAI de livraison dynamique. En plus d'être défini dans la configuration du lecteur, il peut être défini au moment de l'exécution via le paramètre de chaîne de requête adConfigId pour les lecteurs iframe ou l'attribut data-ad-config-id pour les lecteurs intégrés. L'un ou l'autre remplacera toute valeur dans la configuration du lecteur.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
data-ad-config-id attribut HTML dans la page Remplace la configuration
adConfigId Paramètre de requête iframe Remplace la configuration

ad_failover

ad_failover informations:

  • Type de données : booléen
  • Défaut : undefined
  • Définissez sur true pour activer le comportement de basculement publicitaire. Il s'agit d'une configuration en plusieurs parties qui dépend de :
    • Les plugins IMA3 et SSAI doivent être configurés sur le lecteur.
    • Un ad_config_id devrait être disponible, sinon les annonces SSAI ne sont pas disponibles.

Lorsqu'il est réglé sur vrai , le lecteur retardera son processus d'initialisation automatique jusqu'à ce que la détection de bloc d'annonces ait pris une décision. Cela peut retarder l'initialisation du lecteur d'environ 100 millisecondes.

ID d'application

application_id informations:

  • Type de données : chaîne
  • Défaut : undefined
  • L'ID d'application est utilisé pour différencier les utilisations multiples d'un seul joueur dans les métriques. Il est invisible pour l'utilisateur.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
id-application-de-données attribut HTML dans la page Remplace la configuration
ID d'application Paramètre de requête iframe Remplace la configuration

lecture audio uniquement

Lorsque vous utilisez des ressources audio avec le lecteur Brightcove, vous disposez de deux options pour personnaliser le lecteur :

  • Mode audio uniquement

    Dans ce mode, toute l'interface utilisateur du joueur est masquée, à l'exception de la barre de contrôle.

  • Mode Poster Audio

    Dans ce mode, l'image du poster est affichée en permanence pendant la lecture. Les dimensions du lecteur restent les mêmes que celles d'un lecteur vidéo dans ce mode.

Les deux modes ne peuvent pas être activés en même temps.

  • Si audio_only_mode les deux audio_poster_mode sont définis sur true dans la configuration du lecteur, le mode audio uniquement aura la priorité.
  • L'activation d'un mode par programmation via player.audioOnlyMode(true) ou player.audioPosterMode(true) désactivera l'autre mode s'il est activé.

Pour plus de détails sur la mise en œuvre, consultez le document Audio Only with Brightcove Player .

avance automatique

autoadvance informations:

  • Type de données : chaîne
  • Par défaut : Non activé initialement
  • Utilisé avec les listes de lecture et définit le comportement d'avance automatique de la liste de lecture.

Pour plus d'informations, consultez le Listes de lecture section ci-dessous, ainsi que les API de liste de lecture document.

lecture automatique

autoplay informations:

  • Type de données : booléen ou chaîne
  • Par défaut : false
  • Indique que le joueur doit commencer à jouer immédiatement, sur les plates-formes où cela est autorisé.

Si 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, ce qui suit se produit :

  • play: Le joueur essaiera manuellement d'appeler la lecture.
  • muted: Le joueur éteindra manuellement le joueur et appelle la lecture.
  • any: Le joueur essaiera d'abord d'appeler le jeu. Si cela échoue, coupez le lecteur et appelez la lecture.

Si l'un des éléments ci-dessus échoue, le joueur affiche le « Big Play Button » comme si la lecture automatique était définie sur false.

Ce qui suit montre une instruction curl pour définir le autoplay valeur:

Exemple d'utilisation de 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

La lecture automatique d'une vidéo peut être une situation complexe. Voir le Considérations sur la lecture automatique document pour plus de détails.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
lecture automatique attribut HTML dans la page Il s'agit uniquement d'un attribut booléen. Toutes les valeurs sont considérées comme vraies.
lecture automatique Paramètre de requête iframe
obsolète: encart
Remplace la configuration
#lecture automatique Hachage d'URL Obsolète: iframe et encart Remplace la configuration
lecture automatique Option joueur dans la page Remplace toutes les autres méthodes de configuration de la lecture automatique.

bloc_robots

block_robots informations:

  • Type de données : booléen
  • Défaut : undefined
  • Uniquement disponible dans Brightcove Player 6.51.0 et plus récent.
  • Si vrai, ajoute un <meta> tag au code HTML d'intégration iframe pour empêcher les robots comme le robot d'exploration de Google d'indexer le contenu du code HTML d'intégration iframe.

Les éléments suivants seront ajoutés lorsqu'ils seront vrais:

<meta name="robots" content="noindex,nofollow">

domaine_proxy_chine

china_proxy_domain informations:

  • Type de données : chaîne
  • Défaut : undefined
  • S'il est fourni, ce domaine sera utilisé pour acheminer les demandes du joueur aux services Brightcove via un autre nom d'hôte. Un exemple est:
    "china_proxy_domain": "china.example.com"

menu contextuel

context_menu informations:

  • Type de données: booléen ou objet
  • Par défaut : true
  • Si vrai ou un objet, le lecteur inclura un menu contextuel activé à chaque autre clic droit ou appui long. Ce menu contextuel peut ouvrir un modal d'informations sur le joueur ou un lien vers le site Web de l'entreprise Brightcove. Pour plus d'informations sur l'utilisation du menu contextuel, consultez le Modal d'informations sur le joueur Brightcove document.

    S'il s'agit d'un objet, la propriété suivante est prise en charge:

    Propriété Effet
    brightcove_branding Peut être réglé sur faux explicitement pour supprimer le À propos de Brightcove lien dans le menu contextuel personnalisé.

    Exemple :

    "context_menu": {
      "brightcove_branding": false
    }

origine croisée

crossorigin informations:

  • Type de données : booléen
  • Valeur par défaut : false
  • Si vrai , le sous-jacent < vidéo> élément aura crossorigin="anonyme". Cela signifie que toutes les vidéos ou pistes de texte insérées dans le lecteur doivent comporter des en-têtes CORS.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
crossorigin = "anonyme" attribut HTML dans la page Remplace la configuration
origine croisée Paramètre de requête iframe Remplace la configuration

Remplacements de couleur CSS

Il existe trois propriétés qui peuvent être utilisées pour remplacer les couleurs dans le lecteur. Il s'agit de :

  • :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 Play
  • :progressColor La couleur de la barre de progression

Toute couleur CSS valide (y compris les couleurs hexadécimales, par exemple) est une valeur acceptable pour ces propriétés.

Voici une instruction curl pour définir les trois propriétés CSS sur vert, 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
Lecteur avec remplacements CSS
Lecteur avec remplacements CSS

débogage

debug informations:

  • Type de données : booléen
  • Par défaut : false
  • Si vrai , le joueur sera placé en mode débogage. Cela peut être utilisé pour activer la journalisation pour divers composants du lecteur, tels que le moteur de lecture et les analyses.

débogueur

Cette propriété est obsolète, voir menu contextuel.

delivery_config_id

delivery_config_id informations:

  • Type de données : chaîne
  • Défaut : undefined
  • Un ID de configuration de règles de livraison dynamique.

Autres moyens de définir la valeur :

Prénom type Type (s) d'intégration Comportement
ID de configuration de livraison de données attribut HTML dans la page Remplace la configuration
ID de configuration de livraison Paramètre de requête iframe Remplace la configuration

quai

dock informations:

  • Type de données : booléen
  • Valeur par défaut : true
  • Si explicitement false , le joueur n'inclura pas le soi-disant quai où le titre et la description de la vidéo peuvent être affichés.

id_embed

embed_id informations:

  • Type de données : chaîne
  • Défaut : undefined
  • L'ID d'intégration de Video Cloud associé à ce lecteur. Si la valeur est default cela signifie que le joueur n'est pas un enfant joueur. Si la valeur n'est pas default , c'est une valeur représentant le parent du joueur.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
intégration de données attribut HTML dans la page Utilisé principalement pour identifier les joueurs au moment de l'initialisation. Impossible de remplacer le embed_id trouvé dans le fichier config.

les erreurs

errors informations:

  • Type de données : Objet ou booléen
  • Valeur par défaut : true
  • Réglage explicite false empêchera le joueur d'inclure videojs-erreurs , qui est le plugin de messages d'erreur. Si cette valeur est fausse, le lecteur n'affichera pas de messages d'erreur détaillés aux téléspectateurs lorsqu'une erreur se produit. Les erreurs qui empêchent la lecture apparaissent toujours dans la console du développeur web.

fullscreen_control (ou fullscreenControl)

fullscreen_control informations:

  • Type de données : booléen
  • Valeur par défaut : true
  • Indique si le contrôle plein écran doit être affiché dans la barre de contrôle. Si faux , l'action du double-clic pour le plein écran sera également désactivée.

Ce qui suit montre une instruction curl pour définir le fullscreen_control valeur:

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
    "autoplay": true,
    "fullscreen_control": false
    }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Les deux captures d'écran suivantes montrent le lecteur avec et sans le contrôle plein écran :

Lecteur avec contrôle plein écran
Lecteur avec contrôle plein écran
Lecteur sans contrôle plein écran
Lecteur sans contrôle plein écran

hls

hls informations:

  • Type de données : Objet ou booléen
  • Défaut : {}
  • Si false , le lecteur n'inclura pas videojs-http-streaming. Sinon, un objet sera passé comme options pour videojs-http-streaming.

bande passante_initiale

initial_bandwidth informations:

  • Type de données: nombre
  • Défaut : undefined
  • Uniquement disponible dans la version 6.53.0 et plus récente
  • Définit une valeur initiale de bits par seconde qui est utilisée pour amorcer la sélection de rendu du moteur de lecture afin de favoriser les scénarios de bande passante faible ou élevée

langue

language informations:

  • Type de données : chaîne
  • Défaut : undefined
  • Peut être fourni pour régler le lang attribut du <html> élément dans une intégration iframe et, par conséquent, la langue du lecteur.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
langue attribut HTML dans la page Remplace la configuration
langue Paramètre de requête iframe Remplace la configuration

langues

languages informations:

  • Type de données : Tableau de chaîne
  • Défaut : undefined
  • Peut être un tableau de chaînes qui entraînera l'inclusion des langues spécifiées dans le lecteur. Les seules langues valides sont celles incluses dans Video.js. Voir le Localisation de Brightcove Player document pour plus d'informations.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
langues option joueur dans la page Remplace la configuration

boucle

loop informations:

  • Si vrai , provoque le redémarrage de la vidéo dès qu'elle se termine.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
boucle attribut HTML dans la page Il s'agit uniquement d'un attribut booléen. Toutes les valeurs sont considérées comme vraies.
boucle Paramètre de requête iframe Remplace la configuration
boucle option joueur dans la page Remplace la configuration

médias

le media property peut être un objet ou un tableau d'objets et a des propriétés enfants comme indiqué dans le tableau suivant.

Propriété Type de données Description
hauteur chaîne
  • La hauteur de la vidéo
  • La valeur par défaut est relative à la largeur et est appropriée pour une vidéo avec un rapport hauteur/largeur 2:1
affiche objet
  • Contient des URL vers des images d'affiche
poster.highres chaîne
  • Le chemin du fichier vers l'image d'affiche haute résolution, par rapport au répertoire racine du skin
affiche.lowres chaîne
  • Le chemin du fichier vers l'image d'affiche basse résolution, par rapport au répertoire racine du skin
affiche.orig chaîne
  • URL de l'image originale de l'affiche non dimensionnée
sources tableau d'objets
  • Un tableau d'objets sources, par ordre de préférence
  • Les éléments de ce tableau sont traduits directement en source éléments
  • Un objet source doit avoir deux propriétés : src et type
  • Les type l'attribut est le type MIME de la vidéo, tel que spécifié dans la norme HTML5
sources []. src chaîne
  • L'URL d'une ressource multimédia pour cette source
sources. []. type
  • Le type MIME de ressource multimédia tel que spécifié dans la norme HTML5 pour cette source (par exemple vidéo / mp4).
src chaîne
  • Lorsqu'une seule source est nécessaire, l'URL de la ressource multimédia
titre chaîne
  • Contenu de la <title> élément de la page
des pistes[] déployer
piste objet
  • Un objet de piste deux propriétés requises: src & srclang et une propriété facultative étiqueter)
pistes []. label fort
  • Quelque optionnel texte décrivant le srclang et la légende
pistes []. src fort
  • Une URL qui pointe vers un fichier VTT à charger
pistes []. srclang fort
  • Le code à deux lettres pour le type de langue de la légende, comme spécifié dans BCP47
largeur chaîne
  • La largeur de la vidéo
  • La valeur par défaut est relative à la hauteur et est appropriée pour une vidéo avec un rapport hauteur/largeur 2:1

Exemples

Un exemple de source unique:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}

Exemple de sources multiples:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}

Exemple d'objets multimédias multiples:

"media": [{
  "height": "300px",
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}, {
  "height": "300px",
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}]

Pour plus d'informations sur la source qui sera réellement lue, consultez Déterminer quel rendu jouera document.

Vous pouvez voir quelle source joue en utilisant la currentSrc() fonction. La capture d'écran suivante montre l'utilisation de la fonction dans une console de navigateur.

Source actuelle
Source actuelle

Objet multimédia avec exemple de pistes:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "tracks": [{
    "src": "//path/to/captions.vtt",
    "srclang": "en",
    "label": "English"
  }],
  "width": "600px"
}

Dans le JSON suivant, vous pouvez voir un media propriété contenant :

  • Une propriété poster.highres
  • Propriété sources contenant deux objets source, l'un pour une vidéo HLS et l'autre 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"
    }]
  },

en sourdine

muted informations:

  • Type de données : booléen
  • Valeur par défaut : false
  • Détermine si le son est coupé lorsque le lecteur se charge.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
en sourdine attribut HTML dans la page Il s'agit uniquement d'un attribut booléen. Toutes les valeurs sont considérées comme vraies.
en sourdine Paramètre de requête iframe Remplace la configuration
en sourdine Option joueur dans la page Remplace la configuration

picture_in_picture_control

picture_in_picture_control informations:

  • Type de données : booléen
  • Valeur 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.

Bouton jouer

play_button informations:

  • Type de données : objet
  • Défaut : undefined
  • Ajoute des classes CSS pour les styles de boutons de lecteur personnalisés, Brightcove Player versions 5+ uniquement

Propriétés de l'objet:

Propriété Type Effet
flotter chaîne lueur ou alors assombrir , la valeur par défaut est rose / le progrès Couleur
façonner chaîne carré ou alors rectangle , la valeur par défaut est un cercle
position chaîne en haut à gauche ou alors en haut à droite , la valeur par défaut est centre

taux_de_lecture

playback_rates informations:

  • Type de données : baie
  • Par défaut : Aucune
  • Tableau des taux de lecture à afficher dans le contrôle du taux de lecture.

Les valeurs sont lues puis présentées dans un contrôle de vitesse de lecture dans la barre de contrôle du lecteur.

taux de lecture ui

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

taux de lecture éditeur json
  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

joueur

player informations:

  • Type de données : Objet
  • Par défaut : Remplir avec des informations spécifiques au joueur
  • Contient diverses méta-données sur ce lecteur, les plus pertinentes répertoriées dans le tableau suivant.
Propriété Type Effet
inactif booléen Lorsque vrai , le lecteur sera affiché sous la forme d'une boîte grise avec un message d'erreur expliquant que le propriétaire du contenu a désactivé le lecteur. Voir le détails inactifs contenu sous ce tableau pour plus d'informations.
modèle.version chaîne Le numéro de version du modèle à partir duquel le lecteur est construit. Vous pouvez définir manuellement la version du lecteur à l'aide du JOUEURS module Éditeur JSON.
version
in_page_embed_url chaîne URL de base utilisée pour l'intégration sur la page

détails inactifs

Il est possible de rendre les joueurs inactifs. Vous souhaiterez peut-être faire cela pour qu'un lecteur arrête de diffuser du contenu, mais qu'une erreur 404 n'apparaisse pas si un lecteur supprimé est parcouru.

Pour désactiver un lecteur, réglez le 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 joueur, vous pouvez définir la inactive propriété sur false.

Une fois le lecteur désactivé, si un utilisateur parcourt le lecteur, le message suivant apparaîtra :

Lecteur désactivé
Lecteur désactivé

player_id

player_id informations:

  • Type de données : chaîne
  • L'identifiant du lecteur Video Cloud associé à un lecteur

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
lecteur de données attribut HTML dans la page Utilisé principalement pour identifier les joueurs au moment de l'initialisation; Impossible de remplacer le player_id trouvé dans la config

player_name

player_name informations:

  • Type de données : chaîne
  • Le nom du lecteur Video Cloud associé à un lecteur

joue en ligne

playsinline informations:

  • Type de données : booléen
  • Valeur par défaut : false
  • Détermine si le lecteur doit autoriser la lecture en ligne sur les plates-formes qui nécessitent un joue en ligne attribut pour la lecture en ligne/non natif (par exemple, iOS).

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
joue en ligne attribut HTML dans la page Il s'agit uniquement d'un attribut booléen. Toutes les valeurs sont considérées comme vraies.
joue en ligne Paramètre de requête iframe Remplace la configuration
joue en ligne Option joueur dans la page Remplace la configuration

plugins

Les plugins array 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 de l'URL de la propriété, et si nécessaire un support stylesheets URL. Chaque élément de la plugins tableau est un objet avec un name biens.

Propriété Type Effet
nom chaîne Le nom de la méthode du plugin
options objet Un objet options à passer à la méthode du plugin
scripts déployer Scripts pour ce plugin
feuilles de style déployer Feuilles de style pour ce plugin

Par exemple, si votre propriété plugins s'affiche comme suit :

"plugins": [{
  "name": "foo",
  "options": {
    "bar": true
  }
}]

Au moment de l'exécution, le foo plugin serait initialisé avec les options fournies :

player.foo({bar: true});

Tous les scripts ou feuilles de style inclus dans un objet plugin seront soulignés de la même manière que les scripts ou feuilles de style de niveau supérieur ; ils seront soulignés avant les actifs de niveau supérieur.

options Détails de la propriété

Dans ce options propriété enfant, vous transmettez les données à utiliser au moment de l'initialisation. Le JSON suivant transmet 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 la configuration du lecteur. Par exemple, pour utiliser l' redirectURL objet ci-dessus, vous devez effectuer les opérations suivantes dans le plugin lui-même :

  videojs.registerPlugin('navigateOnVideoEnd', function (options) {
    var myPlayer = this;
    myPlayer.on("ended", function () {
      window.location.href = options.redirectURL;
    });
  });

Remarque : vous utilisez l'implémentation standard du plugin, mais vous l'utilisez options comme paramètre dans la fonction anonyme. Vous pouvez ensuite accéder à la valeur à l'aide de la 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 Aperçu: Registre des plugins document pour des informations détaillées.

précharge

preload informations:

  • Type de données : chaîne
  • Défaut : none
  • L'attribut de préchargement indique au navigateur si les données vidéo doivent commencer ou non le téléchargement dès que la balise vidéo est chargée. Les options sont automatique, métadonnées et aucune.

Détails des options

  • auto: Indique que l'intégralité du fichier vidéo peut être téléchargée, même si l'utilisateur ne regarde finalement pas la vidéo. Du côté positif, si le spectateur lit la vidéo, elle peut commencer à jouer immédiatement. Du côté négatif, cette option augmentera la consommation de bande passante car le préchargement/chargement se produit même si le spectateur ne lit pas la vidéo.

  • métadonnées (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 chargera également plusieurs secondes de données vidéo.

  • aucun: Ne préchargez aucune des données vidéo. Cela attendra que l'utilisateur clique sur Lecture pour commencer le téléchargement.

Autres moyens de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
précharge attribut HTML dans la page Remplace la configuration
précharge Paramètre de requête iframe Remplace la configuration
précharge Option joueur iframe Remplace la configuration et l'attribut ou le paramètre de requête
  <video-js preload ...>
  or
  { "preload": "auto" }

query_string_to_window

query_string_to_window informations:

Utilisé pour contrôler le remplissage de l'espace de noms global (fenêtre) à partir des paramètres de chaîne de requête. Ceci est particulièrement utile dans les cas de lecteurs intégrés, tels que les composants AMP de Google ou les articles instantanés de Facebook. L'analyse des chaînes de requête est effectuée à l'aide du Module de chaîne de requête Node.js. L'utilisation de cet objet de configuration requiert au moins une des sous-propriétés suivantes. Les deux peuvent être utilisés simultanément.
    • Nom: query_string_to_window.target
    • Type de données : chaîne
    • Description : Un objet de destination à créer sur la fenêtre, qui sera renseigné avec l'intégralité de la chaîne de requête analysée. Par exemple, une utilisation de query_string_to_window.target donné ce qui suit dans une configuration de lecteur :
        {
        "query_string_to_window": {"target": "queryStringParams"}
        }
      et donné la chaîne de requête suivante :
        ?foo=bar&nums=1&nums=2
      donnerait l'objet window.queryStringParams global suivant serait disponible pour le joueur et les plugins :
        {
        foo: 'bar',
        nums: ['1', '2']
        }
    • Nom: query_string_to_window.globals
    • Type de données : baie
    • Description : Un tableau de noms de propriétés de l'objet window, qui sera renseigné à 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 l'objet ou sa chaîne de prototypes ne sera pas défini. Par exemple, une utilisation de query_string_to_window.globals donné ce qui suit dans une configuration de lecteur :
        {
        "query_string_to_window": {
          "globals": [
            "foo",
            "nums",
            "self"
          ]
        }
        }
      et donnez la chaîne de requête suivante :
        ?foo=bar&nums=1&nums=2&self=not-allowed
      donnerait l'objet window global suivant 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

répéter

repeat informations:

  • Le type de données est boolean
  • Provoquera la répétition de la lecture d'une liste de lecture SI le lecteur est un lecteur de liste de lecture. C'est-à-dire que si le playlist la propriété est utilisée.
  • Situé au niveau supérieur de la configuration du lecteur.

scripts

scripts informations:

  • Le type de données est un tableau de chaînes référençant les fichiers JavaScript inclus avec le lecteur
  • Aucune valeur par défaut
  • Au moment où le lecteur 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 par la suite lors de l'exécution
  • Les scripts sont alignés dans l'ordre dans lequel ils sont spécifiés dans le scripts déployer:
    "scripts": [
      "https://example.com/script.js",
      "https://example.com/depends-on-script.js"
    ]
  • Étant donné que les scripts sont alignés dans un ordre spécifié, vous pouvez inclure en toute sécurité des scripts qui dépendent les uns des autres

peau

skin informations:

  • Type de données : booléen ou chaîne
  • Par défaut : non défini
  • Détermine la variante de style visuel que le joueur utilisera. Cette valeur se reflète également dans l'accessibilité mondiale bc.SKIN propriété dans le navigateur. Il reconnaît les valeurs suivantes :
    Montant bc.SKIN Description
    « graphite » « graphite » Utilise l'ancien style Brightcove Player ainsi que quelques hacks de compatibilité.
    faux "rien" Désactive tous les styles de Brightcove Player. C'est l'option à utiliser pour une interface utilisateur hautement personnalisée à partir de zéro.
    indéfini "Lune" Laissant ça undefined le joueur utilisera le skin par défaut (aka Lune).
    "saphir "saphir L'habillage par défaut lors de l'utilisation de Video Cloud Studio pour créer des lecteurs, mais pas l'habillage par défaut du lecteur lui-même.

feuilles de style

stylesheets informations:

  • Un tableau de chaînes d'URL référençant des fichiers CSS qui devraient être inclus avec le lecteur
  • Au moment où le lecteur est construit, les feuilles de style supplémentaires sont téléchargées et intégrées dans le lecteur afin qu'elles n'aient pas besoin d'être récupérées au moment de l'exécution
  • Les feuilles de style sont incluses dans l'ordre dans lequel vous les spécifiez dans le feuilles de style déployer:
    "stylesheets": [
      "https://example.com/layout.css",
      "https://example.com/skin.css"
    ]

suppress_not_supported_error

suppress_not_supported_error informations:

  • Type de données : booléen
  • Par défaut : non défini
  • Si vrai , une erreur initiale indiquant qu'une source ne peut pas être lue est différée jusqu'à la première interaction de l'utilisateur. Utile pour masquer l'erreur des navigateurs qui ne peuvent pas lire la vidéo, par exemple Googlebot.

tech_order (ou techOrder)

tech_order informations:

  • Type de données : baie
  • Par défaut : ['html5','flash']
  • Par défaut, Brightcove Player exécute avant tout la 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 lecteur essaiera de lire chaque vidéo avec le premier technicien du tech_order option avant de passer à la prochaine technologie de lecture. Voir le Guider: Technologie de lecture document pour plus d'informations.

Vous pouvez utiliser l'instruction curl suivante pour modifier le tech_order du défaut de ['html5','flash'] à ['flash','html5']:

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "tech_order": "['flash','html']"
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

Une autre façon de définir la valeur :

Prénom Type Type (s) d'intégration Comportement
tech_order Option joueur dans la page Remplace la configuration

umd

umd (Universal Module Definition) informations:

  • Type de données : booléen
  • Valeur par défaut : true
  • Uniquement disponible dans Brightcove Player 6.53.0 et versions ultérieures
  • Lorsque vrai , ajoute un passe-partout UMD (Universal Module Definition) autour du lecteur pour une utilisation avec des systèmes de modules tels que RequireJS. Si défini explicitement sur faux , le lecteur ne fonctionnera pas avec les chargeurs de modules et exposera simplement la variable globale bc.

Video_Cloud

  • Type de données : objet
  • Défaut : undefined
  • Configure ce lecteur pour interagir avec Video Cloud

Un exemple d'utilisation de l'objet est de créer un lecteur à l'aide d'une vidéo de votre bibliothèque Video Cloud. L'instruction curl ci-dessous montre la création d'un lecteur à l'aide d'un ID vidéo Video Cloud.

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 requête, name et description sont des propriétés de niveau supérieur, et tous les autres sont des propriétés de l' configuration objet. N'importe lequel des propriétés de configuration peut être inclus dans le configuration lorsque vous créez le lecteur.

Le tableau suivant présente les propriétés contenues dans le video_cloud objet.

Propriété Effet
allow_playready_in_chromium_edge Contrôlez la sélection de la source DRM sur Chromium Edge.
  • Si vrai , ne supprimez aucune source ou système clé PlayReady.
  • Si faux , supprimez les sources PlayReady et les systèmes clés dans tous les cas.
  • Si indéfini , supprimez les sources PlayReady et les systèmes clés uniquement pour les sources EPA!
base_url Réglage du base_url est un changement de configuration qui doit être changé UNIQUEMENT si des restrictions IP sont utilisées avec les lecteurs Brightcove en dehors de l'Amérique du Nord. Voir le détails base_url contenu sous ce tableau pour plus d'informations.
interval_retry Pour Generic Stream Concurrency, l'intervalle en millisecondes entre les tentatives lorsque le lecteur ne parvient pas à se connecter au serveur.
max_retry Pour Generic Stream Concurrency, le nombre de fois que le lecteur doit essayer de se connecter au serveur pour vérifier les limites de la concurrence.
playlist Un ID de playlist Video Cloud à charger. Voir le Détails de la playlist contenu sous ce tableau pour plus d'informations.
policy_key Une clé de stratégie d'API Video Cloud. Voir le Clés de stratégie document pour plus d'informations.
source_selection_rules Un objet qui contient des règles pour contrôler le filtrage et le tri du tableau de sources renvoyé dans la réponse de l'API Playback. Le résultat de l'application de ces règles dicte quelle source sera transmise à Video.js.
vidéo Un ID vidéo Video Cloud à charger. Voir l'exemple de curl en haut de cette section pour un exemple.

base_url des détails

Des problèmes peuvent survenir lors de l'utilisation de restrictions IP avec les joueurs Brightcove utilisés en dehors de l'Amérique du Nord. Lorsqu'un Brightcove Player est invité à charger une vidéo depuis un compte Video Cloud, 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 frappez Edge depuis l'intérieur de l'Amérique du Nord, il frappe directement Edge et Edge voit l'adresse IP de l'utilisateur. Il peut autoriser ou refuser l'accès au catalogue conformément à la liste blanche Restriction IP. Il s'agit de la fonctionnalité souhaitée.
  • Lorsque vous frappez Edge depuis l'EXTÉRIEUR de l'Amérique du Nord, il passe par Cloudfront pour des raisons d'équilibrage de charge/mise en cache locale CDN. C'est important, car à la suite de cela, Edge voit l'adresse IP de Cloudfront au lieu de l'adresse IP de l'utilisateur et refuse tout le monde, car Cloudfront ne figure pas sur la liste blanche (et ne devrait jamais l'être, car toute personne utilisant Cloudfront y aurait accès).

Pour résoudre ce problème, vous pouvez configurer le lecteur pour utiliser un autre point de terminaison Edge, edge-elb.api.brightcove.com. Cette modification doit être apportée à chaque joueur qui doit accéder au compte IP restreint depuis l'extérieur de l'Amérique du Nord.

Le changement de configuration réel implique la définition d'une valeur pour le Video Cloud base_url. N'oubliez pas que cela ne devrait être modifié que si des restrictions IP sont utilisées avec les joueurs Brightcove en dehors de l'Amérique du Nord. Pour un lecteur existant, vous devez utiliser la commande curl suivante qui utilise la méthode PATCH HTTP (vous devez remplacer vos données par 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

Détails de la playlist

Il existe maintenant deux implémentations de listes de lecture différentes, détaillées dans le document Utilisation des listes de lecture . La valeur par défaut est la version 3. Les informations de 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 le chargement de la vidéo suivante dans la liste de lecture ; valeur de 0 attribué ne causera aucune attente entre les vidéos ; valeur de null attribué n'entraînera aucune avance automatique.
  • playOnSelect: Attribué true Ainsi, lorsque vous cliquez sur un élément du menu de la liste de lecture, la vidéo sera lue lorsqu'elle sera chargée, même si la vidéo précédente dans le lecteur a été mise en pause.

Liste de lecture version 3 (par défaut)

Pour configurer des listes de lecture à l'aide du plugin version 3, vous utilisez le registre des plugins. Voici une instruction curl pour configurer l'utilisation du plugin Playlist version 3 :

  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

Consultez le document Greffe de Plugin pour plus d'informations sur son utilisation et ses avantages.

Pour régler le playOnSelect et autoadvance Les options lors de la création du lecteur utilisent les éléments suivants:

  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 (Héritage)

En plus de autoadvance et playOnSelect deux autres propriétés qui permettent de paramétrer l'utilisation des playlists version 1. Il s'agit de :

  • playlist: Attribué true pour qu'un joueur utilise des listes de lecture.
  • :adjusted Attribué true pour que le lecteur ajuste les dimensions du lecteur pour la liste de lecture.

Voici une instruction curl pour définir trois des propriétés liées à la liste de lecture :

  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 listes de lecture 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 le joueur contient une liste de lecture

Si vous utilisez JavaScript dans une page contenant un lecteur et que vous souhaitez vérifier si un plug-in de liste de lecture est utilisé, vous pouvez utiliser les éléments suivants :

  player.hasPlugin('playlist')

Si vous vérifiez la présence d'un plugin de playlist, et non dans une page avec un lecteur (par exemple lors de la vérification d'une liste de lecteurs à utiliser avec un connecteur), vous devez utiliser un processus un peu plus compliqué. Vous devez lire la configuration du lecteur, puis vérifier si le plug-ins section du JSON du lecteur 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');
  }

source_selection_rules des détails

  • Type de données : objet
  • Cette propriété, qui contient des règles qui décident quelle source est jouée, contient elle-même une propriété prefer_mp4.
  • Uniquement disponible dans Brightcove Player 6.55.0 et versions ultérieures.

Les prefer_mp4 La propriété peut contenir une valeur booléenne ou un tableau. La propriété est utilisée pour filtrer le tableau des sources jusqu'aux seules sources MP4. En d'autres termes, cela supprimera les médias de diffusion HLS ou DASH du tableau des sources. L'utilisation de cette configuration est assez inhabituelle car le streaming multimédia offre une meilleure expérience utilisateur dans la plupart des cas, mais il existe des cas valables où les éditeurs voudront que certains lecteurs ne lisent que des MP4. Dans ces cas, un profil d'ingestion personnalisé est généralement l'approche préférée, mais peut ne pas toujours être réalisable. Par exemple, si un éditeur a des vidéos qu'il souhaite ingérer une fois, mais qui peuvent être lues dans des contextes différents, cette configuration peut être utile. Lorsque

"prefer_mp4": true
est utilisé, toutes les sources multimédias non MP4 seront filtrées du tableau des sources avant d'être transmises au lecteur comme si elles n'avaient jamais été renvoyées par l'API de lecture.

Les éditeurs peuvent également contrôler le tri de cette liste filtrée de sources en fournissant un tableau. Cela ne prend en charge que les propriétés numériques (telles que la taille, la hauteur, la largeur, etc.) qui sont renvoyées par l'API de lecture. Dans ce cas, le premier élément du tableau doit être la propriété sur laquelle trier, et le deuxième élément, facultatif, doit être la direction du tri, soit "asc" ou "desc". La valeur par défaut est "desc". Par exemple, pour filtrer les sources multimédias non MP4 et les trier par taille du plus petit au plus grand, vous utiliseriez :

"video_cloud": {
  "source_selection_rules": {
    "prefer_mp4": ["size", "asc"]
  }
}

orientation_volume

volume_orientation informations:

  • Type de données : chaîne
  • Par défaut : horizontal
  • Uniquement disponible dans Brightcove Player 6.32.0 et versions ultérieures
  • Les volume_orientation La propriété détermine si le curseur de niveau de volume est orienté horizontalement ou verticalement.
    volume horizontal
    volume vertical

Les valeurs valides sont :

Montant Description
"verticale" Affiche le panneau de volume vertical (cela équivaut à passer l'objet d'options avec controlBar.volumePanel.inline=false et controlBar.volumePanel.vertical=true à avant JC() méthode ou configuration des données attribut).
"horizontal" Afficher le panneau de volume horizontal (direction du panneau de volume par défaut dans les skins graphite, luna et saphir)
indéfini En laissant ce paramètre indéfini, le panneau de volume horizontal sera affiché (direction par défaut du panneau de volume dans les skins graphite, luna et saphir)

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

définir l'orientation du volume
  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
  • C'est la même chose que l'option standard Video.js vtt.js. Le Brightcove Player utilise vttjs au lieu de cela, un nom de propriété en pointillé n'est pas possible dans l'API de gestion des lecteurs et peut être problématique ailleurs.
  • Peut être défini comme un data-vttjs attribut, un vttjs paramètre de requête iframe, un vttjs option de configuration ou vttjs dans la configuration du lecteur.

wait_for_ad_block_detect

wait_for_ad_block_detect informations:

  • Type de données : booléen
  • Par défaut : non défini
  • Lorsqu'il est réglé sur true , le lecteur retardera son processus d'auto-initialisation jusqu'à ce que la détection du bloc publicitaire ait pris une décision. Cela peut retarder l'initialisation du lecteur d'environ 100 millisecondes. Cela n'a pas besoin d'être réglé sur true lors de l'utilisation ad_failover car le comportement retardateur se produit dans les deux cas.