La ressource liveCuepoint
et la méthode liveCuepoints.insert
sont obsolètes et ont été remplacées par la méthode liveBroadcasts.cuepoint
.
Une ressource liveCuepoint
insère un point de repère dans le flux vidéo de diffusion, ce qui peut déclencher une coupure publicitaire.
Remarque:Cette commande fait partie de l'API YouTube Content ID et a des exigences d'autorisation différentes de celles des requêtes de gestion des ressources liveBroadcast
et liveStream
.
Méthodes
L'API accepte les méthodes suivantes pour les ressources liveCuepoints
:
Représentation des ressources
La structure JSON suivante montre le format d'une ressource liveCuepoints
:
{ "id": string, "kind": "youtubePartner#liveCuepoint", "broadcastId": string, "settings": { "offsetTimeMs": long, "walltime": datetime, "cueType": string, "durationSecs": unsigned integer } }
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés | |
---|---|
id |
string Valeur attribuée par YouTube pour identifier le point de repère de manière unique. |
kind |
string Type de la ressource API. Pour les ressources liveCuepoint , la valeur est youtubePartner#liveCuepoint . |
broadcastId |
string ID attribué par YouTube pour identifier de manière unique la diffusion dans laquelle le point de repère est inséré. |
settings |
object L'objet settings définit les paramètres du point de repère. |
settings.offsetTimeMs |
long Cette valeur spécifie un moment précis de la vidéo où les spectateurs doivent voir une annonce ou un écran InStream. La valeur de la propriété identifie un décalage temporel, en millisecondes, depuis le début du flux de surveillance. Bien qu'elle soit mesurée en millisecondes, la valeur est en fait une approximation, et YouTube insère le point de repère le plus près possible de ce moment. Vous ne devez pas spécifier de valeur pour ce paramètre si votre diffusion ne comporte pas de flux de surveillance. La valeur par défaut de cette propriété est 0 , ce qui indique que le point de repère doit être inséré dès que possible. Si votre flux de diffusion n'est pas retardé, 0 est également la seule valeur valide. Toutefois, si votre flux de diffusion est retardé, la valeur de la propriété peut spécifier l'heure à laquelle le point de repère doit être inséré. Pour en savoir plus, consultez le guide Premiers pas.Remarque : Si votre diffusion comportait une phase de test, le décalage est mesuré à partir du début de la phase de test. |
settings.walltime |
datetime Cette valeur indique la durée d'exécution à laquelle le point de repère doit être inséré. La valeur est spécifiée au format ISO 8601 ( YYYY-MM-DDThh:mm:ss.sssZ ).L'API renvoie une erreur si une requête tente d'insérer un point de repère qui spécifie une valeur pour cette propriété et pour la propriété settings.offsetTimeMs . |
settings.cueType |
string Type de point de repère. Pour en savoir plus sur les différents types de points de repère, consultez le guide Premiers pas. Consultez également le document Déroulement d'une diffusion pour connaître les bonnes pratiques d'insertion de points de repère au cours de la diffusion. Les valeurs valides pour cette propriété sont les suivantes :
|
settings.durationSecs |
unsigned integer Durée du point de repère, en secondes. Cette valeur doit être spécifiée si cueType est défini sur ad et est ignoré dans les autres cas. |