LiveBroadcasts: transition

Modifie l'état d'une diffusion en direct YouTube et lance tous les processus associés au nouvel état. Par exemple, lorsque vous passez l'état d'une diffusion à testing, YouTube commence à transmettre la vidéo au flux de surveillance de cette diffusion. Avant d'appeler cette méthode, vous devez vérifier que la valeur de la propriété status.streamStatus du flux lié à votre diffusion est active.

Cas d'utilisation courants

Requête

Requête HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/transition

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'authentification OAuth 2.0.

Champ d'application
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
broadcastStatus string
Le paramètre broadcastStatus identifie l'état vers lequel la diffusion est en train de passer. Notez que pour passer une diffusion à l'état testing ou live, le status.streamStatus doit être active pour le flux auquel la diffusion est liée.

Les valeurs acceptables sont les suivantes :
  • complete : la diffusion est terminée. YouTube arrête de transmettre la vidéo.
  • live : la diffusion est visible par son audience. YouTube transmet la vidéo au flux de surveillance et au flux de diffusion.
  • testing : commencez à tester la diffusion. YouTube transmet la vidéo au flux de surveillance. Notez que vous ne pouvez passer une diffusion à l'état testing que si sa propriété contentDetails.monitorStream.enableMonitorStream est définie sur true.
id string
Le paramètre id spécifie l'identifiant unique de la diffusion qui passe à un autre état.
part string
Le paramètre part spécifie une liste d'une ou plusieurs propriétés de ressources liveBroadcast séparées par une virgule que la réponse de l'API inclura. Les part noms que vous pouvez inclure dans la valeur de paramètre sont id, snippet, contentDetails, et status.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.

Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube CMS qui agit au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données vidéo et de chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire du contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.

Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne YouTube à laquelle une vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre onBehalfOfContentOwner, et il ne peut être utilisé qu'avec ce paramètre. De plus, la requête doit être autorisée à l'aide d'un compte CMS associé au propriétaire du contenu spécifié par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par la valeur du paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire du contenu spécifié par le paramètre onBehalfOfContentOwner.

Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'effectuer des actions au nom de la chaîne spécifiée dans la valeur de paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie une ressource liveBroadcast dans le corps de la réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel à cette méthode. Pour en savoir plus, consultez API YouTube Live Streaming – Erreurs.

Type d'erreur Détail de l'erreur Description
backendError errorExecutingTransition Une erreur s'est produite lors de la modification de l'état de la diffusion.
forbidden (403) errorStreamInactive La transition demandée n'est pas autorisée lorsque le flux lié à la diffusion est inactif.
forbidden (403) invalidTransition La diffusion en direct ne peut pas passer de son état actuel à l'état demandé.
forbidden (403) redundantTransition La diffusion en direct est déjà dans l'état demandé ou en cours de traitement pour atteindre cet état.
insufficientPermissions insufficientLivePermissions La requête n'est pas autorisée à faire passer la diffusion en direct à un autre état.
insufficientPermissions livePermissionBlocked L'utilisateur qui a autorisé la requête ne peut pas diffuser de vidéo en direct sur YouTube pour le moment. Pour savoir pourquoi l'utilisateur ne peut pas diffuser de vidéo en direct, consultez les paramètres de sa chaîne dans Éligibilité aux fonctionnalités.
insufficientPermissions liveStreamingNotEnabled L'utilisateur qui a autorisé la requête n'est pas autorisé à diffuser de vidéo en direct sur YouTube. Pour en savoir plus, consultez Éligibilité aux fonctionnalités.
notFound (404) liveBroadcastNotFound La diffusion spécifiée par le paramètre id n'existe pas.
rateLimitExceeded (403) userRequestsExceedRateLimit L'utilisateur a envoyé trop de requêtes dans un délai donné.
rateLimitExceeded (403) concurrentBroadcastsExceedLimit La chaîne a déjà atteint le nombre maximal de diffusions en direct simultanées. Une ou plusieurs diffusions déjà en direct doivent être arrêtées avant qu'une autre diffusion puisse démarrer sur la chaîne.
rateLimitExceeded (403) sharedIngestionBroadcastsExceedLimit La chaîne a déjà atteint le nombre maximal de diffusions en direct partageant la source d'ingestion. Une ou plusieurs de ces diffusions doivent être arrêtées pour démarrer la diffusion demandée.
required (400) idRequired Le paramètre id obligatoire doit identifier la diffusion dont vous souhaitez modifier l'état.
required (400) statusRequired La requête API doit spécifier une valeur pour le paramètre status.

Essayer

Utilisez le APIs Explorer pour appeler cette API et afficher la requête et la réponse.