assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Ajouter des points de repère

    Dans cet exemple, vous apprendrez comment ajouter des points de repère à une vidéo par programmation à l'aide de l'API CMS.

    Introduction

    Les points de repère sont des emplacements spécifiés sur la chronologie vidéo. Lorsque la vidéo est lue, un événement est automatiquement diffusé chaque fois qu'un point de repère est atteint - à l'aide de l'API Player, vous pouvez écouter ces événements et prendre toutes les mesures que vous souhaitez. En outre, vous pouvez lire toutes les informations de point de repère des métadonnées vidéo stockées dans l' mediainfo objet lecteur, ce qui vous permet de marquer les points de repère sur la chronologie vidéo d'une manière ou d'une autre si vous le souhaitez.

    Il existe deux types de points repères :

    • Points de repère d'annonce : ils sont utilisés pour marquer les endroits où une demande d'annonce doit être faite (si la vidéo et le lecteur sont activés pour la publicité).
    • Points de repère de code : ils sont utilisés pour effectuer des actions à l'aide de l'API Player - certaines utilisations typiques sont d'afficher une sorte d'appel à l'action (CTA) ou d'afficher une image ou du texte relatif au contenu vidéo, peut-être sous forme de superposition vidéo ou dans la page autour du lecteur.

    Vue d'ensemble de

    Vous pouvez ajouter des points de repère dans le module Media Studio. Vous pouvez également les ajouter en utilisant l'API CMS, qui est la méthode que nous allons utiliser dans cet exemple.

    Méthode HTTP

    Des points de repère peuvent être ajoutés lorsque vous créez la vidéo ou ultérieurement avec une demande de mise à jour. Dans cet exemple, nous allons les ajouter à une vidéo existante en faisant une demande de mise à jour vidéo , ce qui signifie que vous utiliserez la PATCH méthode.

    Point de terminaison

    Le point de terminaison de la demande de mise à jour vidéo est :

              https://cms.api.brightcove.com/v1/accounts/account_id/vidéos/video_id

    Corps de la requête

    Le corps de la requête est un objet JSON qui peut contenir de nombreux éléments de métadonnées vidéo. Ici, nous allons simplement regarder le cue_points champ, qui est défini sur un tableau d'objets de point de repère, comme dans l'exemple suivant :

              {
              "cue_points": [
                  {
                    "name": "Ad Cue Point",
                    "type": "AD",
                    "time": 2.0,
                    "metadata": null,
                    "force_stop": false
                  },
                  {
                    "name": "Code Cue Point",
                    "type": "CODE",
                    "time": 4.0,
                    "metadata": "The metadata might be text or the url for an image to display",
                    "force_stop": true
                  }
                ]
              }

    Champs d'objet point de repère

    Vous trouverez ci-dessous une description des champs des objets de point de repère.

    Champs d'objet Point de repère
    Champ Type Obligatoire Description
    name chaîne non Un nom arbitraire - cela peut être utile pour identifier un point de repère particulier dans votre code API Player
    type chaîne oui Doit être AD ou CODE
    time nombre oui Temps du point de repère en secondes à partir du début de la vidéo [1]
    metadata chaîne non Toute chaîne jusqu'à 128 caractères sur un octet - ceci peut être des informations utiles à votre gestionnaire d'événements de point de repère, comme le texte d'une superposition ou l'emplacement d'une image à afficher
    force_stop booléen non Si la vidéo doit être suspendue lorsque le point de repère est atteint ( force_stop est ignoré par le lecteur Brightcove et il n'est pas prévu de la prendre en charge actuellement, mais vous pouvez mettre la vidéo en pause manuellement dans votre gestionnaire d'événements de point de repère)

    Remarques

    • [ 1] Techniquement, le point de repère est actif jusqu'à ce que le point de repère suivant soit atteint - par conséquent, dans le tableau de points de repère que vous pouvez récupérer à partir du lecteur Brightcove, vous verrez un startTime et endTime ainsi qu'à un time pour le point de repère.

    Obtention des informations d'authentification

    Pour utiliser le, CMS API vous aurez besoin d'informations d'identification appropriées.

    Le moyen le plus simple d'obtenir des informations d'identification dans la plupart des cas consiste à utiliser la section Authentification de l'API d'administration Studio (nécessite des autorisations d'administrateur sur votre compte). Pour plus de détails, reportez-vous à Gestion des informations d'authentification API Dans la plupart des cas, vous voulez probablement juste obtenir des autorisations pour toutes les CMS API opérations :

    Autorisations API CMS
    Autorisations API CMS

    Si les autorisations dont vous avez besoin ne sont pas disponibles dans Studio, ou si vous préférez les obtenir directement à partir de l'API OAuth, utilisez les documents Obtenir les informations d'identification du client répertoriés ci-dessous. Quelle que soit l'option que vous choisissez, vous devrez demander les autorisations d'opération correctes. Les éléments suivants peuvent être utilisés avec cURL ou Postman pour obtenir toutes les autorisations pour l'API CMS :

              "operations": [
                "video-cloud/video/all",
                "video-cloud/playlist/all",
                "video-cloud/sharing-relationships/all",
                "video-cloud/notifications/all"
              ]

    Exemple d'application

    Trouvez tout le code associé à cet exemple dans ce dépôt GitHub.

    Voir l' exemple d'API CMS Pen : Ajoutez des points Cue par Brightcove Learning Services ( @rcrooks1969 ) sur CodePen.

    Utilisation du CodePen

    • Basculez l'affichage réel de l'application en cliquant sur le bouton Résultat .
    • Cliquez sur les boutons HTML/CSS/JS pour afficher L'UN des types de code.
    • Cliquez sur Modifier sur CodePen dans le coin supérieur droit pour incorporer ce CodePen dans votre propre compte.
    • Trouvez tout le code associé à cet exemple dans ce dépôt GitHub.

    Code proxy

    Afin de construire votre propre version de l'exemple d'application sur cette page, vous devez créer et héberger votre propre proxy. (Les proxy utilisés par Brightcove Learning Services acceptent uniquement les demandes des domaines Brightcove.) Un exemple de proxy, très similaire à celui que nous utilisons, mais sans les contrôles qui bloquent les demandes provenant de domaines non-BrightCove, peut être trouvé dans ce dépôt GitHub. Vous trouverez également des instructions de base pour l'utiliser là-bas, ainsi qu'un guide plus élaboré pour créer des applications autour du proxy dans Utilisation des API REST.