LiveBroadcasts: control

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

Os clientes ainda podem implementar um orçamento próprio ao adicionar uma sobreposição ao vídeo enviado aos servidores de processamento do YouTube. Confira 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 da transmissão ao vivo do YouTube que identifica exclusivamente 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á sendo ativada ou desativada.
offsetTimeMs unsigned long
O parâmetro offsetTimeMs especifica um deslocamento de horário positivo quando a mudança especificada na barreira vai ocorrer. O valor é medido em milissegundos a partir do início do fluxo do monitor da transmissão, que é o momento em que a fase de teste da transmissão começou. Mesmo que ele seja especificado em milissegundos, o valor é, na verdade, uma aproximação, e o YouTube conclui a ação solicitada o mais próximo possível desse período.

Se você não especificar um valor para esse parâmetro, o YouTube vai executar a ação assim que possível. Consulte o guia Como começar para saber mais detalhes.

Importante:especifique um valor para esse parâmetro somente 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 está agindo 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. Este 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 onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube ao qual um vídeo está sendo adicionado. Esse parâmetro é obrigatório quando uma solicitação especifica um valor para o parâmetro onBehalfOfContentOwner e só pode ser usado com esse parâmetro. 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 de parâmetro onBehalfOfContentOwnerChannel precisa estar vinculado ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner.

Esse parâmetro é destinado a parceiros de conteúdo do YouTube que têm e gerenciam muitos canais diferentes do YouTube. 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 real em que a mudança da barreira vai 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, esse 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ó é permitida se o status da transmissão for live.
insufficientPermissions insufficientLivePermissions O usuário não está autorizado para 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 transmitir vídeo ao vivo no YouTube. Para mais informações, acesse https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Somente offsetTimeMs ou walltime pode ser especificado.
invalidValue (400) invalidOffsetTimeMs O valor do parâmetro offsetTimeMs é inválido. O valor do parâmetro precisa ser positivo, mas o parâmetro só pode 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. No momento, a única ação compatível é 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 essa API e conferir a solicitação e a resposta da API.