Définition de marqueurs temporels avec l’API médias

Vous pouvez ajouter des marqueurs temporels à une vidéo via l’API Media Write Video Cloud. Un marqueur temporel sert à indiquer un moment précis dans une vidéo. Vous pouvez les utiliser pour déclencher des spots publicitaires mid-roll ou pour séparer des chapitres ou des scènes dans une vidéo de longue durée.

Les API Media Write sont uniquement disponibles sous Video Cloud Pro et Enterprise. Si vous désirez en savoir plus sur la mise à niveau de votre compte Video Cloud, contactez Brightcove.

• Création de marqueurs temporels
• Mise à jour ou suppression de marqueurs temporels

Vous pouvez également ajouter des marqueurs temporels avec le module Publicité Video Cloud ou le transfert FTP batch, en utilisant l’élément XML <cuepoint> dans votre manifeste de transfert batch. Pour plus d’informations sur les diverses méthodes de création de marqueurs temporels, consultez la rubrique Ajout de marqueurs temporels à des vidéos.

Création de marqueurs temporels

Pour créer un marqueur temporel, utilisez la méthode create_video de l’API médias. La méthode create_video présente la signature suivante :

create_video(token:String, video:Video, filename:String, 
   maxsize:Long, file:InputStream, file_checksum:String, 
   create_multiple_renditions:Boolean, cuePoints:List):Long

Pour utiliser la méthode create_video, transmettez :

• votre clé d’écriture d’API Médias ;
• l’ID ou l’ID de référence de la vidéo à laquelle vous désirez affecter un marqueur;
• une liste de CuePoints qui inclut les propriétés suivantes pour chaque marqueur :

Propriétés du marqueur

Par exemple, si vous voulez définir un marqueur CODE à la première seconde, un marqueur CODE à 48 secondes et un marqueur AD à 120 secondes d’une vidéo portant l’ID 123, vous pouvez implémenter la syntaxe suivante dans http://api.brightcove.com/services/ :

{"method": "create_video",
  "params": {
    "token": "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video": {
      "name": "Le nom est obligatoire.",
      "shortDescription": "la description courte également.",
      "cuePoints": [
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_2", "time": 48000, "type": 1, "metadata": "Certaines données"}, 
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}

Mise à jour de marqueurs temporels

Vous pouvez mettre à jour ou supprimer un marqueur existant avec la méthode update_video de l’API médias. L'utilisation du paramètre facultatif cuePoints avec la méthode update_video écrasera tous les marqueurs de la vidéo en question. Tout marqueur non inclus dans le paramètre cuePoints sera supprimé.

Par exemple, en supposant que vous avez déjà défini les marqueurs pour la vidéo 123 de notre exemple précédent, pour définir un marqueur CODE à 360 secondes et supprimer le marqueur à 48 secondes vous pouvez publier une syntaxe ressemblant à celle qui suit dans http://api.brightcove.com/services/ :

{"method": "update_video",
  "params": {
    "token" : "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video" : {
      "id": 123,
      "cuePoints":[
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_3", "time": 360000, "type": 1},
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}