Archivo

Un objeto que representa un archivo de OpenTok.

No llames al new() constructor. Para iniciar la grabación de un archivo, llama a la función OpenTok.startArchive() método.

Características:

Nombre	Tipo	Descripción
`createdAt`	Numbers	La hora en la que se creó el archivo, en milisegundos desde la época UNIX.
`duration`	Cadena	La duración del archivo, en segundos.
`hasAudio`	Booleano	Si el archivo tiene una pista de audio (`true`) o no (`false`). Puedes evitar que se grabe el audio configurando `hasAudio` a `false` en el `options` que se pasa al parámetro OpenTok.startArchive() método.
`hasVideo`	Booleano	Si el archivo contiene una pista de vídeo (`true`) o no (`false`). Puedes evitar que se grabe vídeo configurando `hasVideo` a `false` en el `options` que se pasa al parámetro OpenTok.startArchive() método.
`id`	Cadena	El identificador del archivo.
`name`	Cadena	El nombre del archivo. Si no se especificó ningún nombre al crear el archivo, este valor se establece en nulo.
`streamMode`	Cadena	El modo de transmisión del archivo. Se puede configurar en una de las siguientes opciones: - «auto»: las transmisiones incluidas en el archivo se seleccionan automáticamente (valor predeterminado). - «manual»: especifica las transmisiones que se van a incluir mediante llamadas a la función OpenTok.addArchiveStream() y OpenTok.removeArchiveStream() métodos.
`outputMode`	Cadena	El modo de salida que se generará para este archivo, que puede ser uno de los siguientes: - «composed»: todas las secuencias del archivo se graban en un único archivo (compuesto). - «individual»: cada secuencia del archivo se graba en su propio archivo individual. Consulte el OpenTok.startArchive() método.
`projectId`	Cadena	La clave API asociada al archivo.
`reason`	Cadena	En el caso de los archivos con el estado «detener» o «fallo», esta cadena describe el motivo por el que el archivo se detuvo (por ejemplo, «se ha superado la duración máxima») o falló.
`resolution`	Cadena	La resolución del archivo (ya sea «640x480», «1280x720» o «1920x1080»). Esta propiedad solo se establece para los archivos compuestos.
`sessionId`	Cadena	El identificador de la sesión de OpenTok asociada a este archivo.
`size`	Numbers	El tamaño del archivo MP4. En el caso de los archivos comprimidos que aún no se han generado, este valor se establece en 0.
`status`	Cadena	El estado del archivo, que puede ser uno de los siguientes: - «disponible»: el archivo está disponible para su descarga desde la nube de OpenTok. - «caducado»: el archivo ya no está disponible para su descarga desde la nube de OpenTok. - «fallido»: la grabación del archivo ha fallado. - «en pausa»: el archivo se está creando y ningún cliente está publicando flujos en la sesión. Cuando se está creando un archivo y algún cliente publica un flujo, el estado pasa a ser «iniciado». Cuando un archivo está «en pausa», no se graba nada. Cuando un cliente empieza a publicar un flujo, la grabación comienza (o se reanuda). Si todos los clientes se desconectan de una sesión que se está archivando, el estado cambia a «en pausa», y tras 60 segundos la grabación del archivo se detiene (y el estado cambia a «detener»). - «iniciado»: el archivo se ha iniciado y se está grabando. - «detenido»: el archivo ha dejado de grabarse. - «cargado»: el archivo está disponible para su descarga desde el destino de carga, el depósito de Amazon S3 o el contenedor de Windows Azure que hayas configurado para tu Proyecto OpenTok.
`url`	Cadena	La URL de descarga del archivo MP4 disponible. Solo se establece para un archivo cuyo estado sea «disponible»; para el resto de archivos (incluidos los que tienen el estado «subido»), esta propiedad se establece en nulo. La URL de descarga está enmascarada y el archivo solo está disponible desde dicha URL durante 10 minutos. Para generar una nueva URL, llama a la función OpenTok.getArchive() o OpenTok.listArchives() método.
`multiArchiveTag`	Cadena	Configura este parámetro para permitir la grabación simultánea de varios archivos de la misma sesión. Asigna una cadena única a cada archivo simultáneo de una sesión en curso. También debe configurar esta opción al iniciar manualmente un archivo que se archiva automáticamente. Tenga en cuenta que el valor de multiArchiveTag no se incluye en la respuesta de los métodos para enumerar archivos y recuperar información de los mismos. Si no especifica un multiArchiveTag único, solo podrá grabar un archivo a la vez para una sesión determinada. Véase Archivos simultáneos.

Métodos

Nombre	Descripción
`delete(callback)`	Elimina el archivo de OpenTok.
`stop(callback)`	Detiene la grabación del archivo.

eliminar(callback)

Elimina el archivo de OpenTok.

Solo se puede eliminar un archivo que tenga el estado «disponible» o «subido». Al eliminar un archivo, se elimina su entrada de la lista de archivos. En el caso de un archivo «disponible», también se elimina el archivo propiamente dicho, por lo que ya no estará disponible para su descarga.

Parámetros:

Nombre	Tipo	Descripción
`callback`	función	La función que se debe llamar al finalizar la operación. Si se elimina correctamente el archivo, la función se llama sin pasarle ningún argumento. En caso de error, se pasa un objeto de error a la función.

stop(callback)

Detiene la grabación del archivo.

Los archivos dejan de grabarse automáticamente tras 120 minutos o cuando todos los clientes se han desconectado de la sesión que se está archivando.

Parámetros:

Nombre	Tipo	Descripción
`callback`	función	La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - `error` — Un objeto de error (si la llamada al método falla). - `archive` — El objeto «Archivo».