Objet représentant une archive OpenTok.

Ne pas appeler le new() constructor. Pour lancer l'enregistrement d'une archive, appelez la fonction OpenTok.startArchive() méthode.

Caractéristiques :
Nom Type Description
createdAt Numbers L'heure à laquelle l'archive a été créée, exprimée en millisecondes depuis l'époque UNIX.
duration Chaîne La durée de conservation de l'archive, en secondes.
hasAudio Booléen Que le fichier d'archive comporte ou non une piste audio (true) ou non (false). Vous pouvez empêcher l'enregistrement du son en configurant hasAudio à false dans le options que vous passez dans le paramètre OpenTok.startArchive() méthode.
hasVideo Booléen Que le fichier d'archive comporte ou non une piste vidéo (true) ou non (false). Vous pouvez empêcher l'enregistrement vidéo en configurant hasVideo à false dans le options que vous passez dans le paramètre OpenTok.startArchive() méthode.
id Chaîne L'identifiant de l'archive.
name Chaîne 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.
streamMode Chaîne Mode de flux pour l'archive. Il peut être défini sur l'une des valeurs suivantes : - « auto » — les flux inclus dans l'archive sont sélectionnés automatiquement (valeur par défaut). - « manual » — Spécifiez les flux à inclure en fonction des appels à la fonction OpenTok.addArchiveStream() et OpenTok.removeArchiveStream() des méthodes.
outputMode Chaîne Le mode de sortie à générer pour cette archive, qui peut être l'un des suivants : - « composed » : tous les flux de l'archive sont enregistrés dans un seul fichier (composé). - « individual » : chaque flux de l'archive est enregistré dans son propre fichier individuel. Voir la OpenTok.startArchive() méthode.
projectId Chaîne La clé API associée à l'archive.
reason Chaîne Pour les archives dont le statut est « interrompue » ou « échouée », cette chaîne de caractères décrit la raison pour laquelle l'archivage a été interrompu (par exemple « durée maximale dépassée ») ou a échoué.
resolution Chaîne La résolution de l'archive (soit « 640x480 », « 1280x720 » ou « 1920x1080 »). Cette propriété n'est définie que pour les archives composées.
sessionId Chaîne L'identifiant de la session OpenTok associée à cette archive.
size Numbers 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 Chaîne 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ée » -- L'archive n'est plus disponible au téléchargement depuis le cloud OpenTok. - « échouée » -- L'enregistrement de l'archive 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 après 60 secondes, l’enregistrement de l’archive s’arrête (et le statut passe à « arrêté »). - « lancé » -- L’archivage a démarré et est en cours d’enregistrement. - « arrêté » -- L’archivage a cessé d’enregistrer. - « téléchargé » -- L’archivage est disponible au téléchargement depuis le compartiment Amazon S3 ou le conteneur Windows Azure de destination que vous avez configuré pour votre Projet OpenTok.
url Chaîne L'URL de téléchargement du fichier MP4 disponible. Cette propriété 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 OpenTok.getArchive() ou OpenTok.listArchives() méthode.
multiArchiveTag Chaîne Définissez ce paramètre pour permettre l'enregistrement simultané de plusieurs archives pour une même session. Attribuez une chaîne unique à chaque archive simultanée d'une session en cours. Vous devez également définir cette option lorsque vous lancez manuellement une archive qui est normalement archivée automatiquement. Notez que la valeur multiArchiveTag n’est pas incluse dans la réponse des méthodes permettant de lister les archives et de récupérer des informations sur celles-ci. Si vous ne spécifiez pas de multiArchiveTag unique, vous ne pouvez enregistrer qu’une seule archive à la fois pour une session donnée. Voir Archives simultanées.

Méthodes

Nom Description
delete(callback) Supprime l'archive OpenTok.
stop(callback) Arrête l'enregistrement de l'archive.

supprimer(callback)

Supprime l'archive OpenTok.

Vous ne pouvez supprimer qu'une archive dont le statut est « disponible » ou « téléchargée ». La suppression d'une archive entraîne la suppression de son entrée de la liste des archives. Pour une archive « disponible », cela entraîne également la suppression du fichier d'archive, qui ne sera alors plus disponible au téléchargement.

Paramètres :
Nom Type Description
callback fonction Fonction à appeler une fois l'opération terminée. Si la suppression de l'archive aboutit, la fonction est appelée sans argument. En cas d'échec, un objet d'erreur est transmis à la fonction.

stop(callback)

Arrête l'enregistrement de l'archive.

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.

Paramètres :
Nom Type Description
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - archive — L'objet Archive.