Herdado de: : Object

Definido em: : lib/opentok/signals.rb

Visão geral

Uma classe para trabalhar com sinais do OpenTok.

Resumo dos métodos de instância

Detalhes do método de instância

#enviar(session_id, connectionId = "", options = {}) ⇒ Objeto

Envia um sinal aos clientes conectados a uma sessão do OpenTok.

É possível enviar um sinal para todas as conexões válidas de uma sessão ou para uma conexão específica dessa sessão.

Para obter mais informações sobre sinalização, consulte <https://tokbox.com/developer/rest/#send_signal>.

campo para agrupar e filtrar sinais. Trata-se de uma propriedade do objeto Signal recebido pelo(s) cliente(s).

Contém as principais informações a serem enviadas no sinal. É uma propriedade do objeto Signal recebido pelo(s) cliente(s).

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok.

  • connection_id (String) —

    Quando um connection_id é especificado, apenas essa conexão recebe o sinal. Caso contrário, o sinal é enviado a todos os clientes conectados à sessão.

  • opções (Hash) (valor padrão: {}) —

    um conjunto de opções personalizáveis

Hash de opções (options):

  • :tipo (String)

    —

    Este é o tipo do sinal. Você pode usar isso

  • :data (String)

    —

    Esses são os dados contidos no sinal ou na carga útil.

Aumentos:

  • (ArgumentError) —

    Uma das propriedades do sinal — dados, tipo, session_id ou connection_id — está inválida.

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

    Você não está autorizado a enviar o sinal. Verifique suas credenciais de autenticação.

  • (Erro do OpenTok) —

    O cliente especificado pela propriedade connection_id não está conectado à sessão.

  • (Erro do OpenTok) —

    A sequência de caracteres do tipo excede o comprimento máximo (128 bytes) ou a sequência de dados excede o tamanho máximo (8 kB).