Ajouter des points de repère

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.

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.

Exemple d'application

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