Herdado de: : Object

Definido em: : lib/opentok/broadcast.rb

Visão geral

Representa uma transmissão ao vivo de uma sessão do OpenTok. Consulte / Transmissões ao vivo.

Resumo dos atributos da instância

Resumo dos métodos de instância

Tratamento dinâmico de métodos

Essa classe lida com métodos dinâmicos por meio do método `method_missing`

#method_missing(método, *args, &bloco) ⇒ Objeto

Detalhes dos atributos da instância

#broadcastUrls ⇒ Hash

é definido da seguinte forma: Este objeto define os tipos de fluxos de transmissão que você deseja iniciar (tanto HLS quanto RTMP). Você pode incluir HLS, RTMP ou ambos como fluxos de transmissão. Se incluir a transmissão por RTMP, é possível especificar até cinco fluxos RTMP de destino (ou apenas um). O (:hls) é definida como um objeto [Hash] vazio. A URL HLS é retornada na resposta. A propriedade ‘hlsStatus’ é definida como um dos seguintes valores:

- "connecting" — The OpenTok server is in the process of starting transcoders. This is the initial state.
- "ready" — The OpenTok server has succesfully initialized but the CDN is not consuming media.
- "live" — The OpenTok server has succesfully initialized and the CDN is consuming media.
- "ended" — The source stream has ended. If DVR is enabled and pre-recorded media is requested, then the status will transition to "live".
- "error" — There is an error in the OpenTok platform.

O (:rtmp) está definida como um [Array] de propriedades Rtmp [Hash]. Para cada fluxo RTMP, especifique (:serverUrl) para a URL do servidor RTMP, (:streamName) como o nome da transmissão ao vivo no YouTube ou a chave da transmissão no Facebook), e (opcionalmente) (:id), um identificador único para o fluxo.

Devoluções:

  • (Hash) —

    o valor atual de broadcastUrls

#created_at ⇒ int

A hora em que a transmissão foi criada, em milissegundos desde a época UNIX.

Devoluções:

  • (int) —

    o valor atual de created_at

#hasAudio ⇒ booleano

A transmissão está com o áudio ativado

Devoluções:

  • (booleano) —

    o valor atual de hasAudio

#hasVideo ⇒ booleano

A transmissão está habilitada para vídeo

Devoluções:

  • (booleano) —

    o valor atual de hasVideo

#id ⇒ string

O ID da transmissão.

Devoluções:

  • (string) —

    o valor atual do id

#maxBitRate ⇒ int

A taxa de bits máxima para o(s) fluxo(s) de transmissão, em bits por segundo.

Devoluções:

  • (int) —

    o valor atual de maxBitRate

#multi_broadcast_tag ⇒ Objeto (somente leitura)

Retorna o valor do atributo multi_broadcast_tag.

#id_do_projeto ⇒ string

A chave de API associada à transmissão.

Devoluções:

  • (string) —

    o valor atual de project_id

#resolução ⇒ string

A resolução da transmissão: “640x480” (SD horizontal, padrão), “1280x720” (HD horizontal), “1920x1080” (FHD paisagem), “480x640” (SD retrato), “720x1280” (HD retrato) ou “1080x1920” (FHD retrato). Pode ser recomendável usar uma proporção retrato para transmissões que incluam fluxos de vídeo de dispositivos móveis (que geralmente usam a proporção retrato). Essa propriedade é opcional.

Devoluções:

  • (string) —

    o valor atual da resolução

#session_id ⇒ string

O ID da sessão do OpenTok associada a esta transmissão.

Devoluções:

  • (string) —

    o valor atual de session_id

#status ⇒ string

O status da transmissão RTMP.

  • “conectando” – A plataforma OpenTok está se conectando ao servidor RTMP remoto.

    This is the initial state, and it is the status if you start when there are no streams published in the session.
It changes to "live" when there are streams (or it changes to one of the other states).

  • “ao vivo – A plataforma OpenTok se conectou com sucesso ao servidor RTMP remoto, e a transmissão de mídia está em andamento.

  • “offline” – A plataforma OpenTok não conseguiu se conectar ao servidor RTMP remoto. Isso ocorre devido a um servidor inacessível ou a um erro no handshake RTMP. As causas incluem conexões RTMP rejeitadas, Applications RTMP inexistentes, nomes de stream rejeitados, erros de autenticação etc. Verifique se o servidor está online e se você forneceu a URL correta do servidor e o nome do stream.

  • “erro” – Ocorreu um erro na plataforma OpenTok.

Devoluções:

  • (string) —

    o valor atual do status

#streamMode ⇒ string

Se os streams incluídos na transmissão são selecionados automaticamente (“auto”, a configuração padrão) ou manualmente (“manual”).

Devoluções:

  • (string) —

    o valor atual de streamMode

#atualizado_em ⇒ int

Para esse método de inicialização, esse carimbo de data e hora corresponde ao carimbo de data e hora “createdAt”.

Devoluções:

  • (int) —

    o valor atual de updated_at

Detalhes do método de instância

#add_stream(stream_id, opts = {}) ⇒ Objeto

Adiciona um stream à transmissão atualmente em andamento que foi iniciada com o streamMode definido como “manual”. Para obter uma descrição do recurso, consulte <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Você pode chamar o método repetidamente com `add_stream` definido com o mesmo ID de stream para ativar ou desativar o áudio ou o vídeo do stream na transmissão. Se você definir tanto `has_audio` quanto `has_video` como `false`, receberá uma resposta de erro.

Parâmetros:

  • stream_id (String) —

    O ID da transmissão a ser adicionada à transmissão ao vivo

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

    um conjunto de opções personalizáveis

Hash de opções (opts):

  • :has_audio (true, false)

    — padrão: Booleano, opcional —

    — Se a transmissão deve incluir o áudio do stream (true, valor padrão) ou não (false).

  • :has_video (true, false)

    — padrão: Booleano, opcional —

    — Se a transmissão deve incluir o vídeo da transmissão (true, valor padrão) ou não (false).

Aumentos:

#layout(opts = {}) ⇒ Objeto

Define o layout da transmissão do OpenTok.

É possível alterar dinamicamente o tipo de layout de uma transmissão enquanto ela estiver no ar. Para obter mais informações, consulte Configuração do layout de vídeo para transmissões ao vivo no OpenTok.

Consulte <https://tokbox.com/developer/rest/#change_composed_archive_layout>

Parâmetros:

  • opções (Hash) —

    um conjunto de opções personalizáveis

Aumentos:

  • (OpenTokBroadcastError) —

    Não foi possível atualizar o layout da transmissão.

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

    Falha na autenticação. Chave ou segredo da API inválido.

  • (Erro do OpenTok) —

    Erro no servidor OpenTok.

  • (ArgumentError) —

    O parâmetro broadcast_id ou options está vazio.

  • (ArgumentError) —

    O tipo “custom” foi especificado sem uma opção de folha de estilo.

  • (ArgumentError) —

    Foi passada uma folha de estilo para um tipo diferente de “custom”. Ou foi passado um tipo inválido.

  • (ArgumentError) —

    Foi passado um tipo de layout inválido.

#remove_stream(stream_id) ⇒ Objeto

Remove uma transmissão da transmissão em andamento que foi iniciada com o parâmetro streamMode definido como “manual”. Para obter uma descrição do recurso, consulte <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Parâmetros:

  • stream_id (String) —

    O ID da transmissão a ser removida da programação

Aumentos:

#pare ⇒ Objeto

Interrompe a transmissão do OpenTok.

#to_json ⇒ Objeto

Uma representação da transmissão na forma de uma string codificada em JSON.