Herdado de: : Object

Definido em: : lib/opentok/renders.rb

Visão geral

Uma classe para trabalhar com renderizações do OpenTok Experience Composer. Consulte / Experience Composer.

Resumo dos métodos de instância

Detalhes do método de instância

#encontrar(render_id) ⇒ Renderizar

Obtém um objeto Render para o ID de renderização fornecido.

Parâmetros:

  • render_id (String) —

    (Obrigatório) O ID da renderização.

Devoluções:

  • (Renderizar) —

    O objeto de renderização, que inclui propriedades que definem a renderização.

Aumentos:

#lista(options = {}) ⇒ RenderList

Retorna uma RenderList, que é uma matriz de renderizações do Experience Composers associadas a um projeto.

Parâmetros:

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

    Um hash com chaves que definem qual intervalo de renderizações deve ser recuperado.

Hash de opções (options):

  • :offset (número inteiro)

    — padrão: Opcional —

    . O deslocamento inicial para a lista de renderizações do Experience Composer. O valor padrão é 0.

  • :count (inteiro)

    —

    Opcional. O número de renderizações do Experience Composer a serem recuperadas a partir do deslocamento. O valor padrão é 50 e o máximo é 1.000.

Devoluções:

  • (RenderList) —

    Um objeto RenderList, que é uma matriz de objetos Render.

Aumentos:

  • (ArgumentError)

#início(session_id, options = {}) ⇒ Renderizar

Inicia uma renderização do Experience Composer para uma sessão do OpenTok.

Parâmetros:

  • session_id (String) —

    (Obrigatório) O ID da sessão do OpenTok que incluirá a transmissão do Experience Composer.

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

    (Obrigatório) Um hash que define as opções para a renderização.

Hash de opções (options):

  • :token (String)

    — padrão: Obrigatório —

    Um token válido do OpenTok com a função de Editor e (opcionalmente) dados de conexão a serem associados ao fluxo de saída.

  • :url (String)

    — padrão: Obrigatório —

    Um URL acessível ao público, controlado pelo cliente e capaz de gerar o conteúdo a ser exibido sem a intervenção do usuário. O comprimento mínimo do URL é de 15 caracteres e o máximo é de 2.048 caracteres.

  • :max_duration (Número inteiro)

    — padrão: Opcional —

    O tempo máximo permitido para o Experience Composer, em segundos. Após esse tempo, ele é interrompido automaticamente, caso ainda esteja em execução. O valor máximo é 36.000 (10 horas), o valor mínimo é 60 (1 minuto) e o valor padrão é 7.200 (2 horas). Quando o Experience Composer é encerrado, sua transmissão é retirada do ar e um evento é enviado para a URL de retorno de chamada, caso tenha sido configurada no Portal da Conta.

  • :resolução (String)

    —

    A resolução do Experience Composer pode ser “640x480” (SD paisagem), “480x640” (SD retrato), “1280x720” (HD paisagem), “720x1280” (HD retrato), “1920x1080” (FHD paisagem) ou “1080x1920” (FHD retrato). Por padrão, essa resolução é “1280x720” (HD paisagem, a configuração padrão).

  • :propriedades (Hash)

    — padrão: Opcional —

    A configuração inicial das propriedades do Publisher para o fluxo de saída composto. O objeto de propriedades contém a chave :name (String) que serve como nome do fluxo de saída composto, o qual é publicado na sessão. O nome deve ter comprimento mínimo de 1 e máximo de 200.

Devoluções:

  • (Renderizar) —

    O objeto de renderização, que inclui propriedades que definem a renderização, incluindo o ID da renderização.

Aumentos:

#pare(render_id) ⇒ Renderizar

Interrompe a renderização do OpenTok Experience Composer.

Parâmetros:

  • render_id (String) —

    (Obrigatório) O ID da renderização.

Devoluções:

  • (Renderizar) —

    O objeto de renderização, que inclui propriedades que definem a renderização.

Aumentos: