LiveBroadcasts: control

Observação: o método liveBroadcasts.control foi descontinuado e deixará de funcionar em 1o de outubro de 2020 ou após essa data. Após essa data, todas as chamadas para esse método retornarão um erro "403" proibido, e o método será completamente removido.

Os clientes ainda podem implementar a própria mudança adicionando uma sobreposição ao vídeo enviado aos servidores de processamento do YouTube. Veja o anúncio de descontinuação.

Controla as configurações de uma barreira que pode ser exibida no stream de transmissão.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
id	string O parâmetro id especifica o ID de transmissão ao vivo do YouTube que identifica de forma exclusiva a transmissão em que a barreira está sendo atualizada.
part	string O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso liveBroadcast que serão incluídas pela resposta da API. Os nomes de part que podem ser incluídos no valor do parâmetro são id, snippet, contentDetails e status.
Parâmetros opcionais
displaySlate	boolean O parâmetro displaySlate especifica se a barreira está ativada ou desativada.
offsetTimeMs	unsigned long O parâmetro offsetTimeMs especifica um ajuste de horário positivo quando a mudança de barreira especificada ocorrerá. O valor é medido em milissegundos desde o início do stream de monitoramento da transmissão, que é o horário em que a fase de testes da transmissão começou. Embora seja especificado em milissegundos, o valor é uma aproximação, e o YouTube conclui a ação solicitada da melhor forma possível até esse momento. Se você não especificar um valor para esse parâmetro, o YouTube executará a ação o mais rápido possível. Consulte o guia Primeiros passos para ver mais detalhes. Importante:só especifique um valor para esse parâmetro se o stream de transmissão estiver atrasado.
onBehalfOfContentOwner	string Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube. O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que atua em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.
onBehalfOfContentOwnerChannel	string Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Esse parâmetro só pode ser usado em uma solicitação autorizada adequadamente. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube. O parâmetro onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube ao qual um vídeo está sendo adicionado. Esse parâmetro é necessário quando uma solicitação especifica um valor para o parâmetro onBehalfOfContentOwner e só pode ser usado com ele. Além disso, a solicitação precisa ser autorizada usando uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. Por fim, o canal especificado pelo valor do parâmetro onBehalfOfContentOwnerChannel precisa estar vinculado ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. Este parâmetro é destinado a parceiros de conteúdo do YouTube que têm e gerenciam muitos canais diferentes. Ele permite que os proprietários do conteúdo autentiquem uma vez e executem ações em nome do canal especificado no valor do parâmetro sem ter que fornecer credenciais de autenticação para cada canal separado.
walltime	datetime O parâmetro walltime especifica o horário em que a alteração de barreira especificada ocorrerá. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, este método retornará um recurso liveBroadcast no corpo da resposta.

Erros

A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro	Detalhe do erro	Descrição
backendError	errorDisplaySlate	Ocorreu um erro ao executar a ação solicitada.
forbidden (403)	liveBroadcastControlNotAllowed	A ação solicitada só será permitida se o status da transmissão for live.
insufficientPermissions	insufficientLivePermissions	O usuário não está autorizado a realizar a operação solicitada, possivelmente porque não tem permissão para transmitir ao vivo.
insufficientPermissions	liveStreamingNotEnabled	O usuário que autorizou a solicitação não está habilitado para fazer streaming de vídeo ao vivo no YouTube. Para ver mais informações, acesse https://www.youtube.com/features.
invalidValue (400)	conflictingTimeFields	Somente uma entre offsetTimeMs e walltime pode ser especificada.
invalidValue (400)	invalidOffsetTimeMs	O valor do parâmetro offsetTimeMs é inválido. O valor do parâmetro precisa ser positivo, mas o parâmetro só poderá ser especificado se o stream do monitor da transmissão estiver ativado.
invalidValue (400)	invalidWalltime	O valor do parâmetro walltime é inválido.
notFound (404)	liveBroadcastNotFound	A transmissão especificada pelo parâmetro id não existe.
required (400)	actionRequired	A solicitação de API precisa especificar pelo menos uma ação. Neste momento, a única ação suportada é ativar ou desativar a barreira.
required (400)	idRequired	O parâmetro id obrigatório precisa identificar a transmissão que está sendo atualizada.

Confira!

Use o APIs Explorer para chamar a API e ver a solicitação e a resposta da API.