Herdado de: : Object

Definido em: : lib/opentok/session.rb

Visão geral

Representa uma sessão do OpenTok.

Use o método OpenTok.createSession() para criar uma sessão do OpenTok. Use a propriedade session_id do objeto Session para obter o ID da sessão.

Resumo dos atributos da instância

Resumo dos métodos de instância

Detalhes dos atributos da instância

#:resolução do arquivo ⇒ String (somente leitura)

A resolução dos arquivos em uma sessão com arquivamento automático.

Devoluções:

  • (String) —

    o valor atual de :archive_resolution

#archive_mode ⇒ String (somente leitura)

Se a sessão será arquivada automaticamente (:always) ou não (:manual).

Devoluções:

  • (String) —

    o valor atual de archive_mode

#nome_do_arquivo ⇒ String (somente leitura)

O nome a ser usado para os arquivos nas sessões com arquivamento automático.

Devoluções:

  • (String) —

    o valor atual de archive_name

#resolução do arquivo ⇒ Objeto (somente leitura)

Retorna o valor do atributo archive_resolution.

#e2ee ⇒ Objeto (somente leitura)

Retorna o valor do atributo e2ee.

#localização ⇒ String (somente leitura)

O endereço IP de referência de localização. Consulte o método OpenTok.createSession().

Devoluções:

  • (String) —

    o valor atual da localização

#media_mode ⇒ String (somente leitura)

Defina como :routed se a sessão utilizar o OpenTok Media Router ou como :relayed se a sessão tentar transmitir fluxos diretamente entre os clientes.

Devoluções:

  • (String) —

    o valor atual de media_mode

#session_id ⇒ String (somente leitura)

O ID da sessão.

Devoluções:

  • (String) —

    o valor atual de session_id

Detalhes do método de instância

#gerar_token(opções) ⇒ String

Gera um token.

Parâmetros:

  • opções (Hash)

Hash de opções (options):

  • :token_type (String)

    —

    O tipo de token a ser gerado. Deve ser “T1” ou “JWT”. O padrão é “JWT”.

  • :função (Símbolo)

    —

    A função do token. Defina-a como um dos seguintes valores:

    • :subscriber – Um assinante só pode se inscrever em transmissões.
    • :publisher – Um editor pode publicar fluxos, assinar fluxos e enviar sinais. (Esse é o valor padrão caso você não especifique uma função.)
    • :publisheronly – Um cliente conectado com um token exclusivo para editores pode publicar transmissões, mas não pode se inscrever em transmissões.
    • :moderator – Além dos privilégios concedidos a um editor, um moderador pode desempenhar funções de moderação, como forçar clientes a se desconectarem, interromper a publicação de transmissões ou silenciar o áudio em transmissões publicadas. Consulte o / Guia do desenvolvedor sobre moderação.

  • :expire_time (inteiro)

    —

    O tempo de validade, em segundos desde a época UNIX. Passe o valor 0 para usar o tempo de validade padrão de 24 horas após a hora de criação do token. O tempo máximo de validade é de 30 dias após a hora de criação.

  • :data (String)

    —

    Uma string contendo metadados de conexão que descrevem o usuário final. Por exemplo, é possível passar o ID do usuário, o nome ou outros dados que descrevam o usuário final. O comprimento da string é limitado a 1.000 caracteres. Esses dados não podem ser atualizados depois de definidos.

  • :initial_layout_class_list (Matriz)

    —

    Uma matriz de nomes de classes (cadeias de caracteres) a serem usadas como classes de layout iniciais para os streams publicados pelo cliente. As classes de layout são utilizadas para personalizar o layout dos vídeos em / transmissões ao vivo e arquivos organizados.

Devoluções:

  • (String) —

    A string do token.