Cette page a été traduite par l'API Cloud Translation.

LiveBroadcasts: control

Remarque:La méthode liveBroadcasts.control est obsolète et cessera de fonctionner à compter du 1er octobre 2020. Après cette date, tous les appels à cette méthode renverront une erreur interdite (403), puis la méthode sera complètement supprimée.

Les clients peuvent toujours implémenter leur propre écran en ajoutant une superposition à la vidéo envoyée aux serveurs d'ingestion de YouTube. Voir l'annonce de l'abandon

Contrôle les paramètres d'un écran qui peut être affiché dans le flux de diffusion.

Cas d'utilisation courants

Demande

Requête HTTP :

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

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
`id`	`string` Le paramètre `id` spécifie l'ID de diffusion en direct YouTube qui identifie de manière unique la diffusion dans laquelle l'écran est mis à jour.
`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
`displaySlate`	`boolean` Le paramètre `displaySlate` indique si l'écran est activé ou désactivé.
`offsetTimeMs`	`unsigned long` Le paramètre `offsetTimeMs` spécifie un décalage horaire positif lorsque l'écran spécifié se produit. La valeur se mesure en millisecondes à partir du début du flux de surveillance de la diffusion, qui correspond au début de la phase de test de la diffusion. Bien qu'elle soit spécifiée en millisecondes, la valeur est en fait une approximation, et YouTube effectue l'action demandée le plus près possible de ce moment. Si vous ne spécifiez pas de valeur pour ce paramètre, YouTube exécute l'action dès que possible. Pour en savoir plus, consultez le guide de démarrage. Important : Ne spécifiez une valeur pour ce paramètre que si votre flux de diffusion est retardé.
`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.
`walltime`	`datetime` Le paramètre `walltime` spécifie la durée d'exécution de la modification de l'écran. La valeur est spécifiée au format ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`).

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`	`errorDisplaySlate`	Une erreur s'est produite lors de l'exécution de l'action demandée.
`forbidden (403)`	`liveBroadcastControlNotAllowed`	L'action demandée n'est autorisée que si l'état de la diffusion est `live`.
`insufficientPermissions`	`insufficientLivePermissions`	L'utilisateur n'est pas autorisé à effectuer l'opération demandée, peut-être parce qu'il n'est pas autorisé à diffuser en direct.
`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.
`invalidValue (400)`	`conflictingTimeFields`	Vous ne pouvez spécifier qu'un seul élément `offsetTimeMs` ou `walltime`.
`invalidValue (400)`	`invalidOffsetTimeMs`	La valeur du paramètre `offsetTimeMs` n'est pas valide. La valeur du paramètre doit être positive, mais le paramètre ne peut être spécifié que si le flux de contrôle de la diffusion est activé.
`invalidValue (400)`	`invalidWalltime`	La valeur du paramètre `walltime` n'est pas valide.
`notFound (404)`	`liveBroadcastNotFound`	La diffusion spécifiée par le paramètre `id` n'existe pas.
`required (400)`	`actionRequired`	La requête API doit spécifier au moins une action. Pour le moment, la seule action possible est d'activer ou de désactiver l'écran.
`required (400)`	`idRequired`	Le paramètre obligatoire `id` doit identifier la diffusion en cours de mise à jour.

Essayer

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