Archivo

addStreamToArchive() : bool : Añade una transmisión a un archivo que se está reproduciendo actualmente y que se inició con el parámetro «streamMode» establecido en «StreamMode.Manual». Puedes llamar al método varias veces con el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión en el archivo.

delete() : mixto : Elimina un archivo de OpenTok.

getPermittedResolutions() : variado

jsonSerialize() : variado

removeStreamFromArchive() : bool : Elimina un flujo de un archivo que se está ejecutando actualmente y que se inició con el parámetro «streamMode» establecido en «StreamMode.Manual».

stop() : mixto : Detiene la grabación de OpenTok, si se está grabando.

toArray() : mixto : Devuelve una representación en forma de matriz asociativa de este objeto Archive.

toJson() : mixto : Devuelve una representación JSON de este objeto «Archive».

Constantes

RESOLUCIONES AUTOMÁTICAS PERMITIDAS

private mixed|null PERMITTED_AUTO_RESOLUTIONS = ['480x640', "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080"]

Propiedades

$createdAt

public int $createdAt

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

$duración

public string $duration

La duración del archivo, en segundos.

$hasAudio

public bool $hasAudio

Si el archivo tiene una pista de audio (true) o no (false).

$hasVideo

public bool $hasVideo

Si el archivo contiene una pista de vídeo (true) o no (false).

$id

public string $id

El identificador del archivo.

$multiArchiveTag

public string $multiArchiveTag

Si la opción «Archivo múltiple» está activada, se generará una cadena única para cada archivo simultáneo de una sesión en curso. Véase https://tokbox.com/developer/guides/archiving/#simultaneous-archives para más información.

$name

public string $name

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

$outputMode

public string $outputMode

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

$partnerId

public string $partnerId

La clave API asociada al archivo.

$motivo

public string $reason

En el caso de los archivos con el estado «detenido» o «fallido», esta cadena describe el motivo por el que el archivo se detuvo (por ejemplo, «se ha superado la duración máxima») o falló.

$resolución

public string $resolution

La resolución del archivo, ya sea «640x480» (SD horizontal, la predeterminada), «1280x720» (HD horizontal), «1920x1080» (FHD horizontal), «480x640» (SD vertical), «720x1280» (HD vertical) o «1080x1920» (FHD vertical). Es posible que te interese utilizar una relación de aspecto vertical para los archivos que incluyan transmisiones de vídeo procedentes de dispositivos móviles (que suelen utilizar la relación de aspecto vertical).

$sessionId

public string $sessionId

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

$size

public string $size

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

public string $status

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ó»: la 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 destino de subida, el depósito de Amazon S3 o el contenedor de Windows Azure que hayas configurado para tu Proyecto OpenTok.

$streamMode

public string $streamMode

Si las transmisiones incluidas en el archivo se seleccionan automáticamente (StreamMode.AUTO) o manualmente (StreamMode.MANUAL). Cuando las transmisiones se seleccionan automáticamente (StreamMode.AUTO), todas las transmisiones de la sesión pueden incluirse en el archivo. Cuando las transmisiones se seleccionan manualmente (StreamMode.MANUAL), se especifican los flujos que se van a incluir en función de las llamadas a la función Archive.addStreamToArchive() y Archive.removeStreamFromArchive() métodos. En el modo manual, puedes especificar si se incluyen en el archivo el audio, el vídeo o ambos de una secuencia. Tanto en el modo automático como en el manual, el generador de archivos incluye las secuencias en función de flujo reglas de priorización.

$url

public string $url

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().

Métodos

addStreamToArchive()

Añade una transmisión a un archivo que se está reproduciendo actualmente y que se inició con el parámetro `streamMode` establecido en `StreamMode.Manual`. Puedes llamar al método varias veces con el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión en el archivo.

public addStreamToArchive(string $streamId, bool $hasAudio, bool $hasVideo) : bool

Parámetros

$streamId : cadena : El identificador de la transmisión.

$hasAudio : bool : Indica si el archivo debe incluir el audio de la transmisión (true, valor por defecto) o no (false).

$hasVideo : bool : Indica si el archivo debe incluir el vídeo de la transmisión (true, valor por defecto) o no (false).

Valores de retorno

bool —

Devuelve «true» si la operación se realiza correctamente.

delete()

Elimina un archivo de OpenTok.

public delete() : mixed

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», el archivo permanece eliminado.

Etiquetas

lanza : ArchiveException

There archive status is not "available", "updated",
or "deleted".

Valores de retorno

mixto —

getPermittedResolutions()

public static getPermittedResolutions() : mixed

Valores de retorno

mixto —

jsonSerialize()

public jsonSerialize() : mixed

Valores de retorno

mixto —

removeStreamFromArchive()

Elimina un flujo de un archivo que se está ejecutando actualmente y que se inició con el parámetro `streamMode` establecido en `StreamMode.Manual`.

public removeStreamFromArchive(string $streamId) : bool

Parámetros

$streamId : cadena : El identificador de la transmisión.

Valores de retorno

bool —

Devuelve «true» si la operación se realiza correctamente.

stop()

Detiene la grabación de OpenTok, si se está grabando.

public stop() : mixed

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.

Etiquetas

lanza : ArchiveException

The archive is not being recorded.

Valores de retorno

mixto —

toArray()

Devuelve una representación en forma de matriz asociativa de este objeto Archive.

public toArray() : mixed

Etiquetas

obsoleto : 3.0.0

A more standard name for this method is supplied by JsonSerializable

véase : Archive::jsonSerialize()

for a method with the same behavior

Valores de retorno

mixto —

toJson()

Devuelve una representación JSON de este objeto «Archive».

public toJson() : mixed

Valores de retorno

mixto —