Um objeto que representa um arquivo do OpenTok.

Não ligue para o new() construtor. Para iniciar a gravação de um arquivo, chame o OpenTok.startArchive() método.

Características:
Nome Tipo Descrição
createdAt Número A hora em que o arquivo foi criado, em milissegundos desde a época UNIX.
duration String A duração do arquivo, em segundos.
hasAudio Booleano Se o arquivo possui uma faixa de áudio (true) ou não (false). É possível impedir que o áudio seja gravado configurando hasAudio para false no options parâmetro que você passa para o OpenTok.startArchive() método.
hasVideo Booleano Se o arquivo possui uma trilha de vídeo (true) ou não (false). É possível impedir que o vídeo seja gravado definindo hasVideo para false no options parâmetro que você passa para o OpenTok.startArchive() método.
id String O ID do arquivo.
name String O nome do arquivo. Se nenhum nome tiver sido fornecido na criação do arquivo, esse valor será definido como nulo.
streamMode String O modo de fluxo para o arquivo. Pode ser definido como uma das seguintes opções: - “auto” — os fluxos incluídos no arquivo são selecionados automaticamente (padrão). - “manual” — Especifique os fluxos a serem incluídos com base nas chamadas à função OpenTok.addArchiveStream() e OpenTok.removeArchiveStream() métodos.
outputMode String O modo de saída a ser gerado para este arquivo, que pode ser um dos seguintes: - “composto” — Todos os fluxos do arquivo são gravados em um único arquivo (composto). - “individual” — Cada fluxo do arquivo é gravado em seu próprio arquivo individual. Consulte o OpenTok.startArchive() método.
projectId String A chave de API associada ao arquivo.
reason 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.
resolution String A resolução do arquivo (seja “640x480”, “1280x720” ou “1920x1080”). Essa propriedade é definida apenas para arquivos compostos.
sessionId String O ID da sessão do OpenTok associada a este arquivo.
size Número O tamanho do arquivo MP4. Para arquivos que ainda não foram gerados, esse valor é definido como 0.
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” — A gravação do arquivo falhou. - “em pausa” — O arquivo está em andamento e nenhum cliente está publicando fluxos para a sessão. Quando um arquivo está em andamento e qualquer cliente publica um fluxo, o status passa a ser “iniciado”. Quando um arquivo está “em pausa”, nada é gravado. Quando um cliente começa a publicar um fluxo, a gravação inicia (ou é retomada). Se todos os clientes se desconectarem de uma sessão que está sendo arquivada, o status muda para “pausado” e, após 60 segundos, a gravação do arquivo é interrompida (e o status muda para “parado”). - “iniciado” — O arquivamento foi iniciado e está em andamento. - “parado” — O arquivamento parou de gravar. - “enviado” — O arquivo está disponível para download no destino de envio — o bucket do Amazon S3 ou o contêiner do Windows Azure que você configurou para o seu Projeto OpenTok.
url String A URL de download do arquivo MP4 disponível. Essa propriedade é definida apenas para um arquivo cujo status esteja definido como “disponível”; para outros arquivos (incluindo aqueles com o status “enviado”), essa propriedade é 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 a função OpenTok.getArchive() ou OpenTok.listArchives() método.
multiArchiveTag String Defina este parâmetro para permitir a gravação simultânea de vários arquivos para a mesma sessão. Defina-o como uma sequência de caracteres exclusiva para cada arquivo simultâneo de uma sessão em andamento. Você também deve definir essa opção ao iniciar manualmente um arquivo que é arquivado automaticamente. Observe que o valor de multiArchiveTag não é incluído na resposta dos métodos para listar arquivos e recuperar informações de arquivos. Se você não especificar um multiArchiveTag exclusivo, só poderá gravar um arquivo por vez para uma determinada sessão. Consulte Arquivos simultâneos.

Métodos

Nome Descrição
delete(callback) Exclui o arquivo do OpenTok.
stop(callback) Interrompe a gravação do arquivo.

excluir(callback)

Exclui o 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.

Parâmetros:
Nome Tipo Descrição
callback função A função a ser chamada ao concluir a operação. Se a exclusão do arquivo for bem-sucedida, a função será chamada sem que nenhum argumento seja passado. Em caso de falha, um objeto de erro será passado para a função.

stop(callback)

Interrompe a gravação do arquivo.

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:
Nome Tipo Descrição
callback função A função a ser chamada ao concluir a operação. Dois argumentos são passados para a função: - error — Um objeto de erro (caso a chamada ao método falhe). - archive — O objeto Archive.