Heredan de: : Object

Definido en: : lib/opentok/archive.rb

Visión general

Representa un archivo de una sesión de 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.

Resumen de atributos de instancia

Resumen de los métodos de instancia

Manejo dinámico de métodos

Esta clase gestiona los métodos dinámicos a través del método `method_missing`.

#method_missing(método, *args, &block) ⇒ Objeto

Detalles de los atributos de la instancia

#fecha_de_creación ⇒ int

La hora en la que se creó el archivo, en milisegundos desde la época UNIX.

Devoluciones:

  • (int) —

    el valor actual de «created_at»

#duración ⇒ cadena

La duración del archivo, en segundos.

Devoluciones:

  • (cadena) —

    el valor actual de la duración

#has_audio ⇒ verdadero, falso

Si el archivo tiene pista de audio (verdadero) o no (falso).

Devoluciones:

  • (verdadero, falso) —

    el valor actual de «has_audio»

#has_video ⇒ verdadero, falso

Si el archivo tiene una pista de vídeo (verdadero) o no (falso).

Devoluciones:

  • (verdadero, falso) —

    el valor actual de «has_video»

#id ⇒ cadena

El identificador del archivo.

Devoluciones:

  • (cadena) —

    el valor actual de id

#multi_archive_tag ⇒ Objeto (solo lectura)

Devuelve el valor del atributo «multi_archive_tag».

#nombre ⇒ cadena

El nombre del archivo. Si no se especificó ningún nombre al crear el archivo, este valor se establece en nulo.

Devoluciones:

  • (cadena) —

    el valor actual de «nombre»

#modo_de_salida ⇒ Cadena

Si todas las secuencias del archivo se graban en un único archivo (:composed) o a archivos concretos (:individual).

Devoluciones:

  • (Cadena) —

    el valor actual de output_mode

#projectId ⇒ cadena

La clave API asociada al archivo.

Devoluciones:

  • (cadena) —

    el valor actual de projectId

#razón ⇒ 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ó.

Devoluciones:

  • (cadena) —

    el valor actual de la razón

#resolución ⇒ cadena

La resolución del archivo, ya sea «640x480» (SD horizontal, la predeterminada), «1280x720» (HD horizontal),

Devoluciones:

  • (cadena) —

    el valor actual de la resolución

#session_id ⇒ cadena

El identificador de la sesión de OpenTok asociada a este archivo.

Devoluciones:

  • (cadena) —

    el valor actual de session_id

#tamaño ⇒ flotante

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.

Devoluciones:

  • (float) —

    el valor actual de «size»

#estado ⇒ cadena

El estado del archivo, que puede ser uno de los siguientes:

  • «disponible»: el archivo se puede descargar desde la nube de OpenTok.
  • «caducado»: el archivo ya no está disponible para su descarga desde la nube de OpenTok.
  • «falló»: el proceso de grabación del archivo ha fallado.
  • «en pausa»: el archivo está en curso y ningún cliente está publicando flujos en la sesión. Cuando un archivo está en curso 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.
  • «detuvo»: el archivo dejó de grabar.
  • «subido»: el archivo está disponible para su descarga desde el depósito de Amazon S3 o el contenedor de Windows Azure de destino que hayas configurado para tu Proyecto OpenTok.

Devoluciones:

  • (cadena) —

    el valor actual del estado

#modo_de_transmisión ⇒ Objeto (solo lectura)

Devuelve el valor del atributo stream_mode.

#streamMode ⇒ cadena

Si las transmisiones incluidas en el archivo se seleccionan automáticamente («auto», la opción predeterminada) o manualmente («manual»).

Devoluciones:

  • (cadena) —

    el valor actual de streamMode

#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 al método Archive.listArchives() u OpenTok.getArchive().

Devoluciones:

  • (cadena) —

    el valor actual de la URL

Detalles del método de instancia

#add_stream(stream_id, opts = {}) ⇒ Objeto

Añade un flujo al archivo compuesto que se está ejecutando actualmente y que se inició con el parámetro `streamMode` establecido en «manual». Para obtener una descripción de esta función, consulta <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Puedes llamar al método varias veces con `add_stream` establecido en el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión en el archivo. Si estableces tanto `has_audio` como `has_video` en `false`, recibirás una respuesta de error.

Parámetros:

  • stream_id (Cadena) —

    El ID de la transmisión que se va a añadir al archivo

  • opts (Hash) (valor por defecto: {}) —

    un conjunto de opciones personalizables

Hash de opciones (opts):

  • :has_audio (verdadero, falso)

    — por defecto: Booleano, opcional —

    — Si el archivo generado debe incluir el audio de la transmisión (verdadero, valor por defecto) o no (falso).

  • :has_video (verdadero, falso)

    — por defecto: Booleano, opcional —

    — Si el archivo generado debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso).

Aumentos:

  • (OpenTokArchiveError) —

    El parámetro «streamMode» del archivo no está configurado en «manual».

#eliminar ⇒ Objeto

Elimina un archivo de OpenTok.

Solo puedes eliminar un archivo que tenga el estado «disponible» o «subido». Al eliminar un archivo, se borra 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.

#diseño(opts = {}) ⇒ Objeto

Establece el tipo de diseño de un archivo compuesto. Para obtener una descripción de los tipos de diseño, consulta Personalización del diseño de vídeo para los archivos compuestos.

Parámetros:

  • opciones (Hash) —

    un conjunto de opciones personalizables

Aumentos:

  • (ArgumentError) —

    El parámetro «archive_id» u «options» está vacío. O bien se ha especificado el tipo «custom» sin una opción de hoja de estilo. O bien se ha pasado una hoja de estilo para un tipo distinto de «custom». O bien se ha pasado un tipo no válido.

  • (OpenTokAuthenticationError) —

    Error de autenticación.

  • (ArgumentError) —

    El parámetro «archive_id» u «options» está vacío.

  • (ArgumentError) —

    Se ha especificado el tipo «personalizado» sin ninguna opción de hoja de estilo.

  • (ArgumentError) —

    Se ha pasado una hoja de estilo para un tipo distinto de «custom». O bien se ha pasado un tipo no válido.

  • (ArgumentError) —

    Se ha introducido un tipo de diseño no válido.

  • (OpenTokError) —

    Error del servidor de OpenTok.

  • (OpenTokArchiveError) —

    No se ha podido configurar el diseño.

#eliminar_flujo(stream_id) ⇒ Objeto

Elimina un flujo del archivo compuesto que se está ejecutando actualmente y que se inició con el parámetro `streamMode` establecido en «manual». Para obtener una descripción de esta función, consulta <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Parámetros:

  • stream_id (Cadena) —

    El ID de la transmisión que se va a eliminar del archivo

Aumentos:

  • (OpenTokArchiveError) —

    El parámetro «streamMode» del archivo no está configurado en «manual».

#stop ⇒ Objeto

Detiene una grabación de OpenTok que se está realizando.

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.

#to_json ⇒ Objeto

Una representación en forma de cadena codificada en JSON del archivo.