LiveBroadcasts: transition

Permet de modifier l'état d'une diffusion en direct YouTube et de lancer tous les processus associés au nouvel état. Par exemple, lorsque vous faites passer l'état d'une diffusion à testing, YouTube commence à transmettre son flux vidéo au moniteur. Avant d'appeler cette méthode, vous devez confirmer que la valeur de la propriété status.streamStatus pour le flux associé à votre diffusion est active.

Cas d'utilisation courants

Demande

Requête HTTP :

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Portée
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
Réglages obligatoires
broadcastStatus string
Le paramètre broadcastStatus identifie l'état de la diffusion. Notez que pour qu'une diffusion passe à l'état testing ou live, le champ status.streamStatus doit être défini sur active pour le flux auquel la diffusion est associée.

Les valeurs autorisées sont les suivantes :
  • complete : la diffusion est terminée. YouTube arrête de transmettre des vidéos.
  • live : l'audience peut voir la diffusion. YouTube transmet la vidéo au flux du moniteur et au flux de diffusion de la diffusion.
  • testing : commencez à tester la diffusion. YouTube transmet la vidéo au flux du moniteur de la diffusion. Notez que vous ne pouvez faire 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'ID unique de la diffusion qui passe à un autre état.
part string
Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressources liveBroadcast, séparées par une virgule, qui seront incluses dans la réponse de l'API. 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 correctement autorisée. Remarque : Ce paramètre est réservé aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire de 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 différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants 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 correctement autorisée. Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque : Ce paramètre est réservé aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne à 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. En outre, la demande doit être autorisée via un compte CMS associé au propriétaire de contenu indiqué par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par le paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire de contenu indiqué 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. Elle permet aux propriétaires de contenu de s'authentifier une fois et d'effectuer des actions pour le compte de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants 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

Lorsque cette méthode fonctionne, elle renvoie une ressource "livelive" dans le corps de réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur Détails 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 Impossible de faire passer la diffusion en direct de son état actuel à l'état demandé.
forbidden (403) redundantTransition La diffusion en direct est déjà à l'état demandé ou en cours de traitement.
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éo en direct sur YouTube pour le moment. Des informations expliquant pourquoi l'utilisateur ne peut pas diffuser de vidéo en direct peuvent être disponibles dans les paramètres de chaîne de l'utilisateur à l'adresse https://www.youtube.com/features.
insufficientPermissions liveStreamingNotEnabled L'utilisateur qui a autorisé la demande n'est pas autorisé à diffuser des vidéos en direct sur YouTube. Pour en savoir plus, consultez la page https://www.youtube.com/features.
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 sur une période donnée.
required (400) idRequired Le paramètre obligatoire id doit identifier la diffusion dont vous souhaitez faire passer 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 API et la réponse.