LiveBroadcasts: transition

Modifie l'état d'une diffusion en direct YouTube et lance les processus associés au nouvel état. Par exemple, lorsque vous définissez l'état d'une diffusion sur 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 pour le flux associé à 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.

Portée
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant présente 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 auquel la diffusion change. Notez que pour qu'une diffusion passe à l'état testing ou live, status.streamStatus doit être défini sur active pour le flux auquel la diffusion est liée.

Les valeurs acceptées sont les suivantes :
  • complete : la diffusion est terminée. YouTube cesse de transmettre la vidéo.
  • live : la diffusion est visible par son audience. YouTube transmet la vidéo au flux de diffusion du moniteur et au flux de diffusion.
  • testing : commencez à tester la diffusion. YouTube transmet la vidéo au flux de surveillance de la diffusion. Notez que vous ne pouvez passer un broadcast à 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'ID 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 noms part que vous pouvez inclure dans la valeur du 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 autorisée appropriée.

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

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube agissant au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenus YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenus 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 de contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une requête autorisée.

Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus 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. Il ne peut être utilisé qu'avec ce paramètre. De plus, la demande 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 contenus 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 du canal spécifié dans la valeur du paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque canal distinct.

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 de 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 associé à la diffusion est inactif.
forbidden (403) invalidTransition La diffusion en direct ne peut pas passer de l'état actuel à l'état demandé.
forbidden (403) redundantTransition La diffusion en direct est déjà dans l'état demandé ou est en cours de traitement pour atteindre cet état.
insufficientPermissions insufficientLivePermissions La demande n'est pas autorisée à effectuer la transition de la diffusion en direct.
insufficientPermissions livePermissionBlocked L'utilisateur qui a autorisé la demande ne peut pas diffuser de vidéos 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 sous Éligibilité à la fonctionnalité.
insufficientPermissions liveStreamingNotEnabled L'utilisateur qui a autorisé la requête n'est pas autorisé à diffuser des vidéos en direct sur YouTube. Pour en savoir plus, consultez la section É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 au cours d'une période donné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 APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.