Herdado de: : Object

Definido em: : lib/opentok/streams.rb

Visão geral

Uma classe para trabalhar com transmissões do OpenTok. Ela inclui métodos para obter informações sobre transmissões do OpenTok, para definir classes de layout para transmissões e para silenciar transmissões.

Resumo dos métodos de instância

Detalhes do método de instância

#todos(session_id) ⇒ Lista de transmissões

Use este método para obter informações sobre todas as transmissões do OpenTok em uma sessão.

Por exemplo, você pode chamar esse método para obter informações sobre as classes de layout utilizadas pelas transmissões do OpenTok. As classes de layout definem como a transmissão é exibida no layout de uma transmissão ao vivo ou de um arquivo montado. Para obter mais informações, consulte Atribuição de classes de layout a streams em transmissões ao vivo e Personalização do layout do vídeo para arquivos compostos.

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok.

Devoluções:

Aumentos:

  • (ArgumentError) —

    O stream_id ou session_id é inválido.

  • (Erro de autenticação do OpenTok) —

    Você não está autorizado a acessar as informações do stream. Verifique suas credenciais de autenticação.

  • (Erro do OpenTok) —

    Um erro no servidor OpenTok.

#desativar_silenciamento_forçado(session_id) ⇒ Objeto

Desativa o estado de mudo ativo da sessão. Após chamar esse método, os novos streams publicados na sessão não terão mais o áudio silenciado.

Depois de chamar o método force_mute_all(), todos os streams publicados após a chamada serão publicados com o áudio silenciado. Chame o método disable_force_mute() para remover o estado de silêncio de uma sessão, de modo que os novos streams publicados não sejam automaticamente silenciados.

Parâmetros:

  • session_id (String) —

    O ID da sessão.

#encontrar(session_id, stream_id) ⇒ Transmissão

Use este método para obter informações sobre uma transmissão do OpenTok.

Por exemplo, você pode chamar esse método para obter informações sobre as classes de layout utilizadas por uma transmissão do OpenTok. As classes de layout definem como a transmissão é exibida no layout de uma transmissão ao vivo. Para obter mais informações, consulte Atribuição de classes de layout a streams em transmissões ao vivo e Personalização do layout do vídeo para arquivos compostos.

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok.

  • stream_id (String) —

    O ID do stream dentro da sessão.

Devoluções:

Aumentos:

  • (ArgumentError) —

    O stream_id ou o session_id é inválido.

  • (Erro de autenticação do OpenTok) —

    Você não está autorizado a acessar as informações do stream. Verifique suas credenciais de autenticação.

  • (Erro do OpenTok) —

    Um erro no servidor OpenTok.

#force_mute(session_id, stream_id) ⇒ Objeto

Forçar um stream específico conectado a uma sessão do OpenTok a se silenciar.

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok.

  • stream_id (String) —

    O ID do stream da sessão.

#force_mute_all(session_id, opts = {}) ⇒ Objeto

Forçar todos os streams conectados a uma sessão do OpenTok (exceto uma lista opcional de streams) a silenciar o áudio publicado.

Além das transmissões existentes, todas as transmissões publicadas após a chamada a este método são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando o método disable_force_mute().

Esta é uma propriedade opcional. Se você omitir essa propriedade, todos os streams da sessão ficarão sem som.

Parâmetros:

  • session_id (String) —

    O ID da sessão.

  • opts (Hash) (valor padrão: {}) —

    Um hash opcional que define as opções para a ação de silenciamento. Por exemplo:

    "excluded_streams" => [
  "excludedStreamId1",
  "excludedStreamId2"
]

Hash de opções (opts):

  • :excluded_streams (Matriz)

    —

    Os IDs das transmissões que não devem ser silenciadas.

#layout(session_id, opts) ⇒ Objeto

Use este método para definir o layout de uma transmissão OpenTok composta (arquivo ou transmissão ao vivo).

Por exemplo, você pode chamar esse método para definir as classes de layout de uma transmissão do OpenTok. As classes de layout definem como a transmissão é exibida no layout de uma transmissão ao vivo ou de um arquivo montado. Para obter mais informações, consulte Atribuição de classes de layout a streams em transmissões ao vivo e Personalização do layout do vídeo para arquivos compostos.

Para obter mais informações, consulte Layout<https://tokbox.com/developer/rest/#change-stream-layout-classes-composed>

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok.

  • opts (Hash) —

    Um hash com uma chave items e o valor como uma matriz de objetos que contém stream_id e layoutClassList propriedades.

Aumentos: