LiveBroadcasts: transition

Altera o status de uma transmissão ao vivo do YouTube e inicia todos os processos associados ao novo status. Por exemplo, quando você faz a transição do status de uma transmissão para testing, o YouTube começa a transmitir vídeos para o stream de monitor dessa transmissão. Antes de chamar esse método, confirme se o valor da propriedade status.streamStatus para o stream vinculado à sua transmissão é active.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

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
broadcastStatus string
O parâmetro broadcastStatus identifica o estado para o qual a transmissão está mudando. Para fazer a transição de uma transmissão para o estado testing ou live, o valor status.streamStatus precisa ser active para o stream a que a transmissão está vinculada.

Os valores aceitáveis são:
  • complete – A transmissão foi encerrada. O YouTube interrompe a transmissão do vídeo.
  • live: a transmissão é visível para o público. O YouTube transmite vídeo para o fluxo de monitoramento da transmissão e seu stream de transmissão.
  • testing: começa a testar a transmissão. O YouTube transmite vídeo para o stream do monitor da transmissão. Só é possível fazer a transição de uma transmissão para o estado testing se a propriedade contentDetails.monitorStream.enableMonitorStream estiver definida como true.
id string
O parâmetro id especifica o ID exclusivo da transmissão que está em transição para outro status.
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
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.

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 errorExecutingTransition Ocorreu um erro ao alterar o status da transmissão.
forbidden (403) errorStreamInactive A transição solicitada não é permitida quando o stream vinculado à transmissão está inativo.
forbidden (403) invalidTransition Não é possível fazer a transição da transmissão ao vivo do status atual para o solicitado.
forbidden (403) redundantTransition A transmissão ao vivo já está com o status solicitado ou sendo processada para o status solicitado.
insufficientPermissions insufficientLivePermissions A solicitação não está autorizada a fazer a transição da transmissão ao vivo.
insufficientPermissions livePermissionBlocked O usuário que autorizou a solicitação não pode fazer streaming de vídeo ao vivo no YouTube no momento. Detalhes explicando por que o usuário não consegue fazer streaming de vídeo ao vivo podem estar disponíveis nas configurações do canal do usuário em https://www.youtube.com/features.
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.
notFound (404) liveBroadcastNotFound A transmissão especificada pelo parâmetro id não existe.
rateLimitExceeded (403) userRequestsExceedRateLimit O usuário enviou muitas solicitações em um determinado período.
required (400) idRequired O parâmetro id obrigatório precisa identificar a transmissão com o status que você quer transferir.
required (400) statusRequired A solicitação de API precisa especificar um valor para o parâmetro status.

Confira!

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