Archives

addStreamToArchive() : bool : Ajoute un flux à une archive en cours d'exécution qui a été lancée avec le paramètre `streamMode` défini sur `StreamMode.Manual`. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux pour activer ou désactiver le son ou la vidéo du flux dans l'archive.

supprimer() : mixte : Supprime une archive OpenTok.

getPermittedResolutions() : mitigé

jsonSerialize() : mitigé

removeStreamFromArchive() : bool : Supprime un flux d'une archive en cours d'exécution qui a été lancée avec le paramètre streamMode défini sur StreamMode.Manual.

stop() : mixte : Arrête l'archivage OpenTok, s'il est en cours d'enregistrement.

toArray() : mixte : Renvoie une représentation sous forme de tableau associatif de cet objet Archive.

toJson() : mixte : Renvoie une représentation JSON de cet objet Archive.

Constantes

RÉSOLUTIONS AUTOMATIQUES AUTORISÉES

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

Propriétés

$createdAt

public int $createdAt

L'heure à laquelle l'archive a été créée, exprimée en millisecondes depuis l'époque UNIX.

$duration

public string $duration

La durée de conservation de l'archive, en secondes.

$hasAudio

public bool $hasAudio

Que le fichier d'archive comporte ou non une piste audio (true) ou non (false).

$hasVideo

public bool $hasVideo

Que le fichier d'archive comporte ou non une piste vidéo (true) ou non (false).

$id

public string $id

L'identifiant de l'archive.

$multiArchiveTag

public string $multiArchiveTag

Si l'option « Multiple Archive » est activée, il s'agira d'une chaîne unique pour chaque archivage simultané d'une session en cours. Voir https://tokbox.com/developer/guides/archiving/#simultaneous-archives pour plus d'informations.

$name

public string $name

Nom de l'archive. Si aucun nom n'a été spécifié lors de la création de l'archive, cette valeur est définie sur null.

$outputMode

public string $outputMode

Nom de l'archive. Si aucun nom n'a été spécifié lors de la création de l'archive, cette valeur est définie sur null.

$partnerId

public string $partnerId

La clé API associée à l'archive.

$reason

public string $reason

Pour les archives dont le statut est « interrompue » ou « échouée », cette chaîne de caractères décrit la raison pour laquelle l'archive a été interrompue (par exemple « durée maximale dépassée ») ou a échoué.

$résolution

public string $resolution

La résolution de l'archive peut être « 640x480 » (SD en mode paysage, par défaut), « 1280x720 » (HD en mode paysage), « 1920x1080 » (FHD paysage), « 480x640 » (SD portrait), « 720x1280 » (HD portrait) ou « 1080x1920 » (FHD portrait). Vous pouvez opter pour un format portrait pour les archives contenant des flux vidéo provenant d'appareils mobiles (qui utilisent souvent le format portrait).

$sessionId

public string $sessionId

L'identifiant de la session OpenTok associée à cette archive.

$size

public string $size

La taille du fichier MP4. Pour les archives qui n'ont pas encore été générées, cette valeur est définie sur 0.

$status

public string $status

Le statut de l'archive, qui peut être l'un des suivants :

« disponible » -- L'archive est disponible au téléchargement depuis le cloud OpenTok.
« expiré » -- L'archive n'est plus disponible au téléchargement depuis le cloud OpenTok.
« Échec » — L'archivage a échoué.
« en pause » -- L'archivage est en cours et aucun client ne publie de flux vers la session. Lorsqu'un archivage est en cours et qu'un client publie un flux, le statut passe à « démarré ». Lorsqu'un archivage est « en pause », rien n'est enregistré. Lorsqu’ un client commence à publier un flux, l’enregistrement démarre (ou reprend). Si tous les clients se déconnectent d’une session en cours d’archivage, le statut passe à « en pause », et au bout de 60 secondes, l’enregistrement d’archivage s’arrête (et le statut passe à « arrêté »).
« a commencé » — L'archivage a commencé et l'enregistrement est en cours.
« arrêté » — L'archive a cessé l'enregistrement.
« téléchargé » -- L'archive est disponible au téléchargement depuis la destination de téléchargement (compartiment Amazon S3 ou conteneur Windows Azure) que vous avez configurée pour votre Projet OpenTok.

$streamMode

public string $streamMode

Que les flux inclus dans les archives soient sélectionnés automatiquement (StreamMode.AUTO) ou manuellement (StreamMode.MANUAL). Lorsque les flux sont sélectionnés automatiquement (StreamMode.AUTO), tous les flux de la session peuvent être inclus dans l'archive. Lorsque les flux sont sélectionnés manuellement (StreamMode.MANUAL), vous spécifiez les flux à inclure en fonction des appels à la fonction Archive.addStreamToArchive() et Archive.removeStreamFromArchive() méthodes. En mode manuel, vous pouvez préciser si l'audio, la vidéo ou les deux d'un flux doivent être inclus dans l' archive. En mode automatique comme en mode manuel, le générateur d'archives inclut les flux en fonction de flux règles de priorisation.

$url

public string $url

L'URL de téléchargement du fichier MP4 disponible. Elle n'est définie que pour les archives dont le statut est « disponible » ; pour les autres archives (y compris celles dont le statut est « téléchargé »), cette propriété est définie sur null. L'URL de téléchargement est masquée, et le fichier n'est accessible via cette URL que pendant 10 minutes. Pour générer une nouvelle URL, appelez la méthode Archive.listArchives() ou OpenTok.getArchive().

Méthodes

addStreamToArchive()

Ajoute un flux à une archive en cours d'exécution qui a été lancée avec le paramètre `streamMode` défini sur `StreamMode.Manual`. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver le flux audio ou vidéo dans l'archive.

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

Paramètres

$streamId : chaîne de caractères : L'identifiant du flux.

$hasAudio : bool : Indique si l'archive doit inclure l'audio du flux (true, valeur par défaut) ou non (false).

$hasVideo : bool : Indique si l'archive doit inclure la vidéo du flux (true, valeur par défaut) ou non (false).

Valeurs de retour

bool —

Renvoie « true » en cas de réussite.

supprimer()

Supprime une archive OpenTok.

public delete() : mixed

Vous ne pouvez supprimer qu'une archive dont le statut est « disponible », « téléchargée » ou « supprimée ». La suppression d'une archive supprime son entrée de la liste des archives. Pour une archive « disponible », cela supprime également le fichier d'archive, le rendant ainsi indisponible au téléchargement. Pour une archive « supprimée », celle-ci reste supprimée.

Mots-clés

lance : ArchiveException

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

Valeurs de retour

mixte —

getPermittedResolutions()

public static getPermittedResolutions() : mixed

Valeurs de retour

mixte —

jsonSerialize()

public jsonSerialize() : mixed

Valeurs de retour

mixte —

removeStreamFromArchive()

Supprime un flux d'une archive en cours d'exécution qui a été lancée avec le paramètre `streamMode` défini sur `StreamMode.Manual`.

public removeStreamFromArchive(string $streamId) : bool

Paramètres

$streamId : chaîne de caractères : L'identifiant du flux.

Valeurs de retour

bool —

Renvoie « true » en cas de réussite.

stop()

Arrête l'archivage OpenTok, s'il est en cours d'enregistrement.

public stop() : mixed

Les archives cessent automatiquement l'enregistrement au bout de 120 minutes ou lorsque tous les clients se sont déconnectés de la session en cours d'archivage.

Mots-clés

lance : ArchiveException

The archive is not being recorded.

Valeurs de retour

mixte —

toArray()

Renvoie une représentation sous forme de tableau associatif de cet objet Archive.

public toArray() : mixed

Mots-clés

obsolète : 3.0.0

A more standard name for this method is supplied by JsonSerializable

voir : Archive::jsonSerialize()

for a method with the same behavior

Valeurs de retour

mixte —

toJson()

Renvoie une représentation JSON de cet objet Archive.

public toJson() : mixed

Valeurs de retour

mixte —