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 "forbidden (403)", et la méthode sera complètement supprimée par la suite.

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

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

Cas d'utilisation courants

Requête

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

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 répertoriés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
`id`	`string` Le paramètre `id` spécifie l'ID de diffusion en direct de 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 ressource `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 temporel positif au moment où le changement d'écran spécifié se produit. La valeur est mesurée en millisecondes à partir du début du flux de surveillance de la diffusion, qui correspond à l'heure à laquelle la phase de test de la diffusion a commencé. Même si elle est spécifiée en millisecondes, la valeur est en réalité approximative. YouTube effectue l'action demandée le plus près possible de ce délai. Si vous ne spécifiez pas de valeur pour ce paramètre, YouTube effectue l'action dès que possible. Pour en savoir plus, consultez le guide de démarrage. Important:Vous ne devez spécifier 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 demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement 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 un grand nombre de chaînes YouTube. Il 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 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 demande autorisée correctement. Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. 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 la 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 à l'aide d'un compte CMS associé au propriétaire de contenu spécifié par le paramètre `onBehalfOfContentOwner`. Enfin, la chaîne indiqué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. 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 du paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque canal.
`walltime`	`datetime` Le paramètre `walltime` indique l'heure d'exécution du changement d'é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 "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 la documentation sur les messages d'erreur.

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, probablement parce qu'il n'est pas autorisé à diffuser du contenu en direct.
`insufficientPermissions`	`liveStreamingNotEnabled`	L'utilisateur qui a autorisé la demande n'est pas autorisé à diffuser de la vidéo en direct sur YouTube. Pour en savoir plus, l'utilisateur peut consulter 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 il ne peut être spécifié que si le flux de surveillance de la diffusion est activé.
`invalidValue (400)`	`invalidWalltime`	La valeur du paramètre `walltime` n'est pas valide.
`notFound (404)`	`liveBroadcastNotFound`	L'annonce 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 consiste à activer ou 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 et la réponse de l'API.