Herdado de: : Object

Definido em: : lib/opentok/archive.rb

Visão geral

Representa um arquivo de uma sessão do OpenTok.

"1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
 You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio).
 This property is only set for composed archives.

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

#created_at ⇒ int

A hora em que o arquivo foi criado, em milissegundos desde a época UNIX.

Devoluções:

  • (int) —

    o valor atual de created_at

#duração ⇒ string

A duração do arquivo, em segundos.

Devoluções:

  • (string) —

    o valor atual da duração

#tem_áudio ⇒ verdadeiro, falso

Se o arquivo possui uma faixa de áudio (verdadeiro) ou não (falso).

Devoluções:

  • (verdadeiro, falso) —

    o valor atual de has_audio

#has_video ⇒ verdadeiro, falso

Se o arquivo possui uma trilha de vídeo (verdadeiro) ou não (falso).

Devoluções:

  • (verdadeiro, falso) —

    o valor atual de has_video

#id ⇒ string

O ID do arquivo.

Devoluções:

  • (string) —

    o valor atual do id

#multi_archive_tag ⇒ Objeto (somente leitura)

Retorna o valor do atributo multi_archive_tag.

#nome ⇒ string

O nome do arquivo. Se nenhum nome tiver sido fornecido na criação do arquivo, esse valor será definido como nulo.

Devoluções:

  • (string) —

    o valor atual de nome

#modo_de_saída ⇒ String

Se todos os fluxos do arquivo são gravados em um único arquivo (:composed) ou a arquivos individuais (:individual).

Devoluções:

  • (String) —

    o valor atual de output_mode

#projectId ⇒ string

A chave de API associada ao arquivo.

Devoluções:

  • (string) —

    o valor atual de projectId

#motivo ⇒ string

Para arquivos com o status “interrompido” ou “falha”, essa string descreve o motivo pelo qual o arquivo foi interrompido (como “duração máxima excedida”) ou apresentou falha.

Devoluções:

  • (string) —

    o valor atual da razão

#resolução ⇒ string

A resolução do arquivo, seja “640x480” (SD na orientação horizontal, padrão), “1280x720” (HD na orientação horizontal),

Devoluções:

  • (string) —

    o valor atual da resolução

#session_id ⇒ string

O ID da sessão do OpenTok associada a este arquivo.

Devoluções:

  • (string) —

    o valor atual de session_id

#tamanho ⇒ float

O tamanho do arquivo MP4. Para arquivos que ainda não foram gerados, esse valor é definido como 0.

Devoluções:

  • (float) —

    o valor atual do tamanho

#status ⇒ string

O status do arquivo, que pode ser um dos seguintes:

  • “disponível” – O arquivo está disponível para download na nuvem da OpenTok.
  • “expirado” – O arquivo não está mais disponível para download na nuvem da OpenTok.
  • “falha” – O arquivamento da gravação falhou.
  • “em pausa” – O arquivamento está em andamento e nenhum cliente está publicando fluxos na sessão. Quando um arquivamento está em andamento e algum cliente publica um fluxo, o status passa a ser “iniciado”. Quando um arquivamento está em pausa, nada é gravado. Quando um cliente começa a publicar um fluxo, a gravação é iniciada (ou retomada). Se todos os clientes se desconectarem de uma sessão que está sendo arquivada, o status muda para “em pausa” e, após 60 segundos, a gravação do arquivo é interrompida (e o status muda para “interrompido”).
  • “iniciado” – O arquivo foi iniciado e está em processo de gravação.
  • “parou” – O arquivo parou de gravar.
  • “enviado” – O arquivo está disponível para download no bucket do Amazon S3 ou no contêiner do Windows Azure de destino que você definiu para o seu Projeto OpenTok.

Devoluções:

  • (string) —

    o valor atual do status

#stream_mode ⇒ Objeto (somente leitura)

Retorna o valor do atributo stream_mode.

#streamMode ⇒ string

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

Devoluções:

  • (string) —

    o valor atual de streamMode

#url ⇒ string

A URL de download do arquivo MP4 disponível. Essa propriedade é definida apenas para um arquivo com o status “disponível”; para outros arquivos (incluindo aqueles com o status “enviado”), ela é definida como nula. A URL de download é ofuscada, e o arquivo fica disponível nessa URL por apenas 10 minutos. Para gerar uma nova URL, chame o método Archive.listArchives() ou OpenTok.getArchive().

Devoluções:

  • (string) —

    o valor atual da URL

Detalhes do método de instância

#add_stream(stream_id, opts = {}) ⇒ 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:

  • stream_id (String) —

    O ID do stream a ser adicionado ao arquivo

  • 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 o arquivo gerado deve incluir o áudio do stream (true, valor padrão) ou não (false).

  • :has_video (true, false)

    — padrão: Booleano, opcional —

    — Se o arquivo gerado deve incluir o vídeo do stream (true, valor padrão) ou não (false).

Aumentos:

#excluir ⇒ Objeto

Exclui um arquivo do OpenTok.

Só é possível excluir um arquivo cujo status seja “disponível” ou “carregado”. 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.

#layout(opts = {}) ⇒ 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:

  • opções (Hash) —

    um conjunto de opções personalizáveis

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(stream_id) ⇒ Objeto

Remove um fluxo do 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:

  • stream_id (String) —

    O ID do stream a ser removido do arquivo

Aumentos:

#pare ⇒ Objeto

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.

#to_json ⇒ Objeto

Uma representação do arquivo na forma de uma string codificada em JSON.