Avançar para o conteúdo principal

Usar a API do Vimeo Live

Este recurso requer um plano Vimeo Enterprise.

Este artigo contém informações sobre como recuperar detalhes sobre Eventos ao vivo, usando a API do Vimeo Live. Mais detalhes estão disponíveis na Referência da API.

Neste artigo:

Recuperar detalhes de um Evento Recorrente

Durante um evento ao vivo, recomendamos incorporar o contêiner do evento em vez do clipe individual subjacente para garantir que o mesmo código incorporado continue a funcionar ao desconectar/reconectar.

Use a API para recuperar o contêiner de eventos por ID:

https://api.vimeo.com/live_events/{event_id}

A partir da resposta, em seguida, recuperar o código iframe incorporável de embed:html

O chat está ativado? "chat_enabled" verdadeiro/falso

Se verdadeiro, "chat_embed_code" contém  o código iframe incorporável.

Se você não receber uma resposta por ID, o ID poderá estar associado a um evento único. Consulte “Recuperar detalhes para clipe de vídeo individual ou evento único”.

Alguns detalhes do contêiner de eventos que você pode precisar saber para sua aplicação:

  • "stream privacy" reflete o nível de privacidade
  • "embed": "pública","whitelist", ou "privada". Privada não será incorporável por parceiros
  • "stream_password" reflete a senha para a transmissão
  • "badges" contém informações sobre o clipe para informar o player:
    • "live" nos diz "transmissão":verdadeiro/falso ou arquivado verdadeiro/falso
    • "vod" nos diz que é vod ou não.

A documentação detalhada está disponível na Referência da API.

Após o evento - Clipes dentro de Eventos Recorrentes

Após o evento, o player incorporado exibirá uma das três coisas:

  • O clipe VOD mais recente da sessão anterior
  • Uma mensagem informando que a (próxima) transmissão ainda não foi iniciada
  • Um novo evento, se o evento recorrente for usado para transmitir novamente.

A exibição confiável do clipe do VOD apropriado exigirá a incorporação do clipe individual versus o evento. Obtenha o ID e os dados do clipe individual a partir da resposta da API de eventos.

O Evento Recorrente contém dois objetos relevantes. O objeto a ser referenciado depende de quando você está recuperando os dados.

  • live_clips - (após a transmissão). Uma matriz de todos os clipes de vídeo concluídos do evento, contendo o ID do vídeo e o carimbo de data e hora do período para quando o evento foi transmitido. 
  • streamable_clip - (antes/durante a transmissão). Este é o clipe ativo antes/durante uma transmissão. O código id e embed correspondem ao clipe individual durante a transmissão, bem como para o VOD resultante.

Depois que uma transmissão é interrompida, suas informações do clipe se movem para a matriz live_clips, e streamable_clip será alterado, contendo as informações para o próximo clipe que será transmitido.

Recuperar detalhes de videoclipes individuais ou de um evento único

Você pode acessar um clipe de vídeo diretamente pelo ID. Este método é usado para acessar detalhes de um evento único ou VOD individual. O ID e a incorporação não serão alterados quando o Ao Vivo for convertido em VOD.

Detalhes de um clipe de vídeo individual:

https://api.vimeo.com/videos/{video_id}
  • “link” é o url
  • "embed" contém propriedades de incorporação para o clipe
  •  "html" é a fonte iframe para o clipe
  • "badges" contém informações sobre o clipe para informar o player:
  • "live" nos diz "transmissão":verdadeiro/falso ou arquivado verdadeiro/falso
  • "vod" nos diz que é vod ou não.
  • "chat_embed_code" é um código incorporado para bate-papo. Pode ser herdado se evento ao vivo recorrente (RLE).
  • "chat_enabled" é verdadeiro/falso. Pode ser herdado se evento ao vivo recorrente (RLE).
  • "live" contém informações para transmissão e incluirá informações sobre o contêiner de eventos pai, se houver

Os detalhes estão disponíveis na Referência da API.

Artigos relacionados