Heredan de: : Object

Definido en: : lib/opentok/archives.rb

Visión general

Una clase para trabajar con archivos de OpenTok.

Resumen de los métodos de instancia

Detalles del método de instancia

#add_stream(archive_id, stream_id, options) ⇒ 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:

  • archive_id (Cadena) —

    El identificador del archivo.

  • stream_id (Cadena) —

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

  • opts (Hash) —

    un conjunto de opciones personalizables

Aumentos:

  • (ArgumentError) —

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

  • (ArgumentError) —

    El parámetro «stream_id» está vacío.

  • (ArgumentError) —

    Las propiedades «has_audio» y «has_video» del parámetro «options» están ambas establecidas en «false».

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

Devuelve una ArchiveList, que es una lista de archivos finalizados y en curso, para tu clave de API.

Parámetros:

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

    Un hash con claves que definen qué rango de archivos se deben recuperar.

Hash de opciones (options):

  • :offset (entero)

    -

    Opcional. El desplazamiento en el índice del primer archivo. 0 corresponde al desplazamiento del archivo iniciado más recientemente. 1 corresponde al desplazamiento del archivo iniciado antes que el más reciente. Si no se especifica ningún desplazamiento, se utiliza 0.

  • :count (entero)

    -

    Opcional. El número de archivos que se van a devolver. El número máximo de archivos que se devuelven es 1000.

  • :session_id (Cadena)

    -

    Opcional. El ID de sesión al que pertenecen los archivos. Esto resulta útil a la hora de mostrar una lista de varios archivos para un sesión archivada automáticamente.

Devoluciones:

  • (Lista de archivos) —

    Un objeto ArchiveList, que es una matriz de objetos Archive.

Aumentos:

  • (ArgumentError)

#crear(session_id, options = {}) ⇒ Archivo

Inicia el archivado de una sesión de OpenTok.

Los clientes deben estar conectados activamente a la sesión de OpenTok para que puedas iniciar correctamente la grabación de un archivo.

Solo se puede grabar un archivo a la vez para una sesión determinada. Solo se pueden grabar archivos de sesiones que utilicen el OpenTok Media Router (sesiones cuyo modo multimedia esté configurado en «routed»); no se pueden archivar sesiones cuyo modo multimedia esté configurado en «relayed».

Para más información sobre el archivado, consulte el Archivado de OpenTok guía de programación.

Parámetros:

  • session_id (Cadena) —

    El ID de la sesión de OpenTok que se va a archivar.

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

    Un hash con las claves «name», «has_audio», «has_video» y «output_mode».

Hash de opciones (options):

  • :nombre (Cadena)

    -

    Este es el nombre del archivo. Puedes utilizar este nombre para identificar el archivo. Es una propiedad del objeto «Archive» y también de los eventos relacionados con los archivos en los SDK de cliente de OpenTok.

  • :has_audio (verdadero, falso)

    -

    Si el archivo incluirá una pista de audio (true) o no false). El valor por defecto es true (se incluye una pista de audio). Si configuras ambas has_audio y has_video a false, la llamada a la create() El método da lugar a un error.

  • :has_video (verdadero, falso)

    -

    Si el archivo incluirá una pista de vídeo (true) o no false). El valor por defecto es true (se incluye una pista de vídeo). Si configuras ambas has_audio y has_video a false, la llamada a la create() El método da lugar a un error.

  • :multi_archive_tag (Cadena)

    — por defecto: Opcional —

    Configura esta opción para permitir la grabación simultánea de varios archivos de la misma sesión. Establece una cadena única para cada archivo simultáneo de una sesión en curso. También debes configurar esta opción al iniciar manualmente un archivo que sea archivado automáticamente. Ten en cuenta que la etiqueta «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`: solo puedes grabar un archivo a la vez en una sesión determinada. Ver archivos simultáneos.

  • :output_mode (Cadena)

    -

    Si todas las secuencias del archivo se graban en un único archivo (:composed, el valor por defecto) o a archivos concretos (:individual). Para obtener más información sobre el archivado y los formatos de los archivos de archivo, consulta el Archivado de OpenTok guía de programación.

  • :resolución (Cadena)

    -

    La resolución del archivo puede ser «640x480» (SD horizontal, la predeterminada), «1280x720» (HD horizontal), «1920x1080» (FHD horizontal), «480x640» (SD vertical), «720x1280» (HD vertical) o «1080x1920» (FHD vertical). Esta propiedad solo se aplica a los archivos compuestos. Si se configura esta propiedad y se establece la propiedad outputMode en «individual», la llamada al método dará lugar a un error.

  • :stream_mode (Cadena)

    — por defecto: Opcional —

    Si las transmisiones incluidas en el archivo se seleccionan automáticamente («auto», la opción predeterminada) o manualmente («manual»). Cuando las secuencias se seleccionan automáticamente («auto»), todas las secuencias de la sesión pueden incluirse en el archivo. Cuando las secuencias se seleccionan manualmente («manual»), se especifican las secuencias que se van a incluir en función de las llamadas a la #añadir_transmisión método. Puedes especificar si en el archivo se incluye el audio, el vídeo o ambos de una secuencia. En los archivos compuestos, tanto en modo automático como en modo manual, el generador de archivos incluye las secuencias en función de normas de priorización de flujos. Importante: esta función solo está disponible actualmente en el entorno Estándar.

  • :layout (Hash)

    -

    Especifica esto para asignar el tipo de estructura inicial del archivo. Esto solo se aplica a los archivos compuestos. Se trata de un hash que contiene tres claves: :type, :stylesheet&lt;code&gt; and &lt;code&gt;:screenshare_type. Valores válidos para :type son «bestFit» (ajuste óptimo), «custom» (personalizado),

    "horizontalPresentation" (horizontal presentation),

    «pip» (imagen en imagen) y «verticalPresentation» (presentación vertical). Si especificas un tipo de diseño «personalizado», configura el :stylesheet clave de la hoja de estilo (CSS). (Para otros tipos de diseño, no establezcas el :stylesheet clave.) Valores válidos para :screenshare_type son «bestFit», «pip», «verticalPresentation» y «horizontalPresentation». Esta propiedad es opcional. Si se especifica, entonces el :type propiedad debe se debe establecer en «bestFit». Si no se especifica un tipo de diseño inicial, el archivo utiliza el tipo de diseño «bestFit». Para obtener más información, consulta Personalización del diseño de vídeo para los archivos compuestos.

  • :max_bitrate (Número entero)

    — por defecto: Opcional —

    La tasa de bits máxima de vídeo para el archivo, en bits por segundo. El valor mínimo es 100 000 y el máximo es 6 000 000. Esta opción solo es válida para archivos compuestos. Establece la tasa de bits máxima de vídeo para controlar el tamaño del archivo compuesto. Esta tasa de bits máxima se aplica únicamente a la tasa de bits de vídeo. Si el archivo de salida contiene audio, esos bits quedarán excluidos del límite.

Devoluciones:

  • (Archivo) —

    El objeto «Archive», que incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

Aumentos:

  • (OpenTokArchiveError) —

    No se ha podido iniciar el archivo. La solicitud no era válida o la sesión no tiene clientes conectados.

  • (OpenTokAuthenticationError) —

    Se ha producido un error de autenticación al iniciar un archivo. Clave de API no válida.

  • (OpenTokArchiveError) —

    No se ha podido iniciar el archivo. El ID de sesión no existe.

  • (OpenTokArchiveError) —

    No se ha podido iniciar el archivo. La sesión podría ser de tipo «peer-to-peer» o ya se está grabando.

  • (OpenTokArchiveError) —

    No se ha podido iniciar el archivo.

#eliminar_por_id(archive_id) ⇒ Objeto

Elimina un archivo de OpenTok.

Solo puedes eliminar un archivo que tenga el estado «disponible», «subido» o «eliminado». 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. En el caso de un archivo «eliminado», este permanece eliminado.

Parámetros:

  • archive_id (Cadena) —

    El ID del archivo que deseas eliminar.

Aumentos:

#encontrar(archive_id) ⇒ Archivo

Obtiene un objeto «Archive» correspondiente al ID de archivo indicado.

Parámetros:

  • archive_id (Cadena) —

    El identificador del archivo.

Devoluciones:

  • (Archivo) —

    El objeto «Archive».

Aumentos:

#diseño(archive_id, options = {}) ⇒ 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:

  • archive_id (Cadena) —

    El identificador del archivo.

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

    un conjunto de opciones personalizables

Hash de opciones (options):

  • :tipo (Cadena)

    -

    El tipo de diseño. Establece este valor en «bestFit», «pip», «verticalPresentation», «horizontalPresentation», «focus» o «custom».

  • :hoja de estilo (Cadena)

    -

    La hoja de estilo para un diseño personalizado. Configura este parámetro si has establecido type a "custom". De lo contrario, déjalo sin definir.

  • :screenshare_type (Cadena)

    -

    El tipo de disposición de la pantalla compartida. Establece este valor en «bestFit», «pip», «verticalPresentation» u «horizonalPresentation». Si se define, entonces el type El parámetro debe establecerse en "bestFit".

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

Elimina un flujo de un 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:

  • archive_id (Cadena) —

    El identificador del archivo.

  • stream_id (Cadena) —

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

Aumentos:

  • (ArgumentError) —

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

  • (ArgumentError) —

    El parámetro «stream_id» está vacío.

#stop_by_id(archive_id) ⇒ Archivo

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.

Parámetros:

  • archive_id (Cadena) —

    El ID del archivo del que quieres detener la grabación.

Devoluciones:

  • (Archivo) —

    El objeto «Archive» correspondiente al archivo que se está deteniendo.

Aumentos: