Herdado de: : Object

Definido em: : lib/opentok/archives.rb

Visão geral

Uma classe para trabalhar com arquivos do OpenTok.

Resumo dos métodos de instância

Detalhes do método de instância

#add_stream(archive_id, stream_id, options) ⇒ Objeto

Adiciona um fluxo ao arquivo composto atualmente em execução que foi iniciado com o parâmetro streamMode definido como “manual”. Para obter uma descrição do recurso, consulte <https://tokbox.com/developer/rest/#selecting-archive-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 no arquivo. Se você definir tanto `has_audio` quanto `has_video` como `false`, receberá uma resposta de erro.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo.

  • stream_id (String) —

    O ID do stream a ser adicionado ao arquivo

  • opts (Hash) —

    um conjunto de opções personalizáveis

Aumentos:

  • (ArgumentError) —

    O parâmetro `archive_id` está vazio.

  • (ArgumentError) —

    O parâmetro stream_id está vazio.

  • (ArgumentError) —

    As propriedades has_audio e has_video do parâmetro options estão ambas definidas como “false”

#todos(options = {}) ⇒ Lista de arquivos

Retorna uma ArchiveList, que é uma matriz de arquivos concluídos e em andamento, para a sua chave de API.

Parâmetros:

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

    Um hash com chaves que definem qual intervalo de arquivos deve ser recuperado.

Hash de opções (options):

  • :offset (número inteiro)

    —

    Opcional. O deslocamento no índice do primeiro arquivo. 0 corresponde ao deslocamento do arquivo iniciado mais recentemente. 1 corresponde ao deslocamento do arquivo iniciado antes do mais recente. Se você não especificar um deslocamento, será usado o valor 0.

  • :count (inteiro)

    —

    Opcional. O número de arquivos a serem retornados. O número máximo de arquivos retornados é 1.000.

  • :session_id (String)

    —

    Opcional. O ID da sessão à qual os arquivos pertencem. Isso é útil ao listar vários arquivos para um sessão arquivada automaticamente.

Devoluções:

  • (Lista de arquivos) —

    Um objeto ArchiveList, que é uma matriz de objetos Archive.

Aumentos:

  • (ArgumentError)

#criar(session_id, options = {}) ⇒ Arquivo

Inicia o arquivamento de uma sessão do OpenTok.

Os clientes devem estar ativamente conectados à sessão do OpenTok para que você consiga iniciar a gravação de um arquivo.

É possível gravar apenas um arquivo por vez para uma determinada sessão. Só é possível gravar arquivos de sessões que utilizem o OpenTok Media Router (sessões com o modo de mídia definido como “routed”); não é possível arquivar sessões com o modo de mídia definido como “relayed”.

Para obter mais informações sobre arquivamento, consulte o Arquivamento do OpenTok guia de programação.

Parâmetros:

  • session_id (String) —

    O ID da sessão do OpenTok a ser arquivada.

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

    Um hash com as chaves “name”, “has_audio”, “has_video” e “output_mode”.

Hash de opções (options):

  • :nome (String)

    —

    Este é o nome do arquivo. Você pode usar esse nome para identificar o arquivo. Trata-se de uma propriedade do objeto Archive e também de uma propriedade dos eventos relacionados a arquivos nos SDKs do cliente OpenTok.

  • :has_audio (true, false)

    —

    Se o arquivo incluirá uma faixa de áudio (true) ou não false). O valor padrão é true (há uma faixa de áudio incluída). Se você definir ambas has_audio e has_video para false, a chamada para o create() O método gera um erro.

  • :has_video (true, false)

    —

    Se o arquivo incluirá uma faixa de vídeo (true) ou não false). O valor padrão é true (está incluída uma faixa de vídeo). Se você definir ambas has_audio e has_video para false, a chamada para o create() O método gera um erro.

  • :multi_archive_tag (String)

    — padrão: Opcional —

    Defina esta opção para permitir a gravação simultânea de vários arquivos para a mesma sessão. Defina aqui uma sequência de caracteres exclusiva para cada arquivo simultâneo de uma sessão em andamento. Você também deve definir esta opção ao iniciar manualmente um arquivo que esteja arquivado automaticamente. Observe que a tag ‘multiArchiveTag’value is not included in the response for the methods to [list archives](https://tokbox.com/developer/rest/#listing_archives) and [retrieve archive information](https://tokbox.com/developer/rest/#retrieve_archive_info). If you do not specify a unique`multi_archive_tag`: é possível gravar apenas um arquivo por vez em uma determinada sessão. Veja os arquivos simultâneos.

  • :output_mode (String)

    —

    Se todos os fluxos do arquivo são gravados em um único arquivo (:composed, o padrão) ou a arquivos específicos (:individual). Para obter mais informações sobre arquivamento e os formatos de arquivo de arquivamento, consulte o Arquivamento do OpenTok guia de programação.

  • :resolução (String)

    —

    A resolução do arquivo pode ser “640x480” (SD horizontal, padrão), “1280x720” (HD horizontal), “1920x1080” (FHD paisagem), “480x640” (SD retrato), “720x1280” (HD retrato) ou “1080x1920” (FHD retrato). Essa propriedade se aplica apenas a arquivos compostos. Se você definir essa propriedade e definir a propriedade outputMode como “individual”, uma chamada ao método resultará em um erro.

  • :stream_mode (String)

    — padrão: Opcional —

    Se os fluxos incluídos no arquivo são selecionados automaticamente (“auto”, a configuração padrão) ou manualmente (“manual”). Quando os fluxos são selecionados automaticamente (“auto”), todos os fluxos da sessão podem ser incluídos no arquivo. Quando os fluxos são selecionados manualmente (“manual”), você especifica os fluxos a serem incluídos com base nas chamadas para o #adicionar_stream método. É possível especificar se o áudio, o vídeo ou ambos de um fluxo serão incluídos no arquivo. Em arquivos compostos, tanto no modo automático quanto no manual, o compositor de arquivos inclui os fluxos com base em regras de priorização de fluxos. Importante: no momento, esse recurso está disponível apenas no ambiente Padrão.

  • :layout (Hash)

    —

    Especifique isso para atribuir o tipo de layout inicial ao arquivo. Isso se aplica apenas a arquivos compostos. Trata-se de um hash contendo três chaves: :type, :stylesheet&lt;code&gt; and &lt;code&gt;:screenshare_type. Valores válidos para :type são “bestFit” (melhor ajuste), “custom” (personalizado),

    "horizontalPresentation" (horizontal presentation),

    “pip” (imagem na imagem) e “verticalPresentation” (apresentação vertical)). Se você especificar um tipo de layout “personalizado”, defina o :stylesheet chave da folha de estilo (CSS). (Para outros tipos de layout, não defina a :stylesheet chave.) Valores válidos para :screenshare_type são “bestFit”, “pip”, “verticalPresentation” e “horizontalPresentation”. Essa propriedade é opcional. Se for especificada, então o :type propriedade deve deve ser definido como “bestFit”. Se você não especificar um tipo de layout inicial, o arquivo utilizará o tipo de layout mais adequado. Para obter mais informações, consulte Personalização do layout do vídeo para arquivos compostos.

  • :max_bitrate (Número inteiro)

    — padrão: Opcional —

    A taxa de bits máxima de vídeo para o arquivo, em bits por segundo. O valor mínimo é 100.000 e o máximo é 6.000.000. Essa opção é válida apenas para arquivos compostos. Defina a taxa de bits máxima de vídeo para controlar o tamanho do arquivo composto. Essa taxa de bits máxima se aplica apenas à taxa de bits de vídeo. Se o arquivo de saída contiver áudio, esses bits serão excluídos do limite.

Devoluções:

  • (Arquivo) —

    O objeto “Arquivo”, que inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

Aumentos:

#excluir_por_id(archive_id) ⇒ Objeto

Exclui um arquivo do OpenTok.

Você só pode excluir um arquivo cujo status seja “disponível”, “enviado” ou “excluído”. A exclusão de um arquivo remove seu registro da lista de arquivos. No caso de um arquivo “disponível”, isso também remove o arquivo em si, tornando-o indisponível para download. No caso de um arquivo “excluído”, ele permanece excluído.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo que você deseja excluir.

Aumentos:

#encontrar(archive_id) ⇒ Arquivo

Obtém um objeto Archive para o ID de arquivo fornecido.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo.

Devoluções:

Aumentos:

#layout(archive_id, options = {}) ⇒ Objeto

Define o tipo de layout para um arquivo composto. Para obter uma descrição dos tipos de layout, consulte Personalização do layout do vídeo para arquivos compostos.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo.

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

    um conjunto de opções personalizáveis

Hash de opções (options):

  • :tipo (String)

    —

    O tipo de layout. Defina-o como “bestFit”, “pip”, “verticalPresentation”, “horizontalPresentation”, “focus” ou “custom”.

  • :folha de estilo (String)

    —

    A folha de estilo para um layout personalizado. Defina este parâmetro se você definir type para "custom". Caso contrário, deixe-o sem definir.

  • :screenshare_type (String)

    —

    O tipo de layout do compartilhamento de tela. Defina-o como “bestFit”, “pip”, “verticalPresentation” ou “horizonalPresentation”. Se essa opção for definida, então o type O parâmetro deve ser definido como "bestFit".

Aumentos:

  • (ArgumentError) —

    O parâmetro `archive_id` ou `options` está vazio. Ou o tipo “custom” foi especificado sem uma opção de folha de estilo. Ou foi passada uma folha de estilo para um tipo diferente de “custom”. Ou foi passado um tipo inválido.

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

    Falha na autenticação.

  • (ArgumentError) —

    O parâmetro `archive_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.

  • (Erro do OpenTok) —

    Erro no servidor OpenTok.

  • (Erro ao abrir o arquivo do OpenTok) —

    Não foi possível definir o layout.

#remove_stream(archive_id, stream_id) ⇒ Objeto

Remove um fluxo de um arquivo composto atualmente em execução que foi iniciado com o parâmetro `streamMode` definido como “manual”. Para obter uma descrição do recurso, consulte <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo.

  • stream_id (String) —

    O ID do stream a ser removido do arquivo

Aumentos:

  • (ArgumentError) —

    O parâmetro `archive_id` está vazio.

  • (ArgumentError) —

    O parâmetro stream_id está vazio.

#stop_by_id(archive_id) ⇒ Arquivo

Interrompe um arquivo do OpenTok que está sendo gravado.

Os arquivos param automaticamente de gravar após 120 minutos ou quando todos os clientes se desconectarem da sessão que está sendo arquivada.

Parâmetros:

  • archive_id (String) —

    O ID do arquivo cuja gravação você deseja interromper.

Devoluções:

  • (Arquivo) —

    O objeto Archive correspondente ao arquivo que está sendo interrompido.

Aumentos: