Ein Objekt, das ein OpenTok-Archiv darstellt.

Rufen Sie nicht die new() Konstruktor. Um die Aufzeichnung eines Archivs zu starten, rufen Sie die OpenTok.startArchive() Methode.

Eigenschaften:
Name Typ Beschreibung
createdAt Numbers Der Zeitpunkt, zu dem das Archiv erstellt wurde, in Millisekunden seit der UNIX-Epoche.
duration Zeichenfolge Die Dauer des Archivs in Sekunden.
hasAudio Boolesche Ob das Archiv eine Audiospur enthält (true) oder nicht (false). Sie können die Audioaufzeichnung verhindern, indem Sie folgende Einstellung vornehmen: hasAudio zu false im options Parameter, den Sie an die OpenTok.startArchive() Methode.
hasVideo Boolesche Ob das Archiv eine Videospur enthält (true) oder nicht (false). Sie können die Videoaufzeichnung verhindern, indem Sie folgende Einstellung vornehmen: hasVideo zu false im options Parameter, den Sie an die OpenTok.startArchive() Methode.
id Zeichenfolge Die Archiv-ID.
name Zeichenfolge Der Name des Archivs. Wenn bei der Erstellung des Archivs kein Name angegeben wurde, wird hier der Wert „null“ gesetzt.
streamMode Zeichenfolge Der Stream-Modus für das Archiv. Hierfür stehen folgende Optionen zur Auswahl: - „auto“ – Die im Archiv enthaltenen Streams werden automatisch ausgewählt (Standardeinstellung). - „manual“ – Geben Sie die einzubeziehenden Streams anhand von Aufrufen der OpenTok.addArchiveStream() und OpenTok.removeArchiveStream() Methoden.
outputMode Zeichenfolge Der für dieses Archiv zu verwendende Ausgabemodus, der einer der folgenden sein kann: - „composed“ – Alle Streams im Archiv werden in einer einzigen (zusammengesetzten) Datei gespeichert. - „individual“ – Jeder Stream im Archiv wird in einer eigenen Datei gespeichert. Siehe die OpenTok.startArchive() Methode.
projectId Zeichenfolge Der dem Archiv zugeordnete API-Schlüssel.
reason Zeichenfolge Bei Archiven mit dem Status „gestoppt“ oder „fehlgeschlagen“ beschreibt diese Zeichenfolge den Grund, warum das Archiv gestoppt wurde (z. B. „maximale Dauer überschritten“) oder fehlgeschlagen ist.
resolution Zeichenfolge Die Auflösung des Archivs (entweder „640x480“, „1280x720“ oder „1920x1080“). Diese Eigenschaft wird nur für zusammengesetzte Archive festgelegt.
sessionId Zeichenfolge Die Sitzungs-ID der OpenTok-Sitzung, die mit diesem Archiv verknüpft ist.
size Numbers Die Größe der MP4-Datei. Bei noch nicht erstellten Archiven ist dieser Wert auf 0 gesetzt.
status Zeichenfolge Der Status des Archivs, der einer der folgenden sein kann: - „verfügbar“ – Das Archiv steht in der OpenTok-Cloud zum Download bereit. - „abgelaufen“ – Das Archiv steht in der OpenTok-Cloud nicht mehr zum Download bereit. - „fehlgeschlagen“ – Die Archivierung ist fehlgeschlagen. - „angehalten“ – Die Archivierung läuft, und kein Client veröffentlicht derzeit Streams in die Sitzung. Wenn eine Archivierung läuft und ein Client einen Stream veröffentlicht, wechselt der Status zu „gestartet“. Wenn eine Archivierung „angehalten“ ist, wird nichts aufgezeichnet. Sobald ein Client mit der Veröffentlichung eines Streams beginnt, startet (oder wird die) Aufzeichnung fortgesetzt. Wenn alle Clients die Verbindung zu einer Sitzung trennen, die gerade archiviert wird, ändert sich der Status auf „paused“, und nach 60 Sekunden wird die Archivaufzeichnung beendet (und der Status ändert sich auf „stopped“). - „gestartet“ – Die Archivierung wurde gestartet und wird gerade aufgezeichnet. - „gestoppt“ – Die Aufzeichnung der Archivierung wurde beendet. - „hochgeladen“ – Die Archivierung steht zum Download im von Ihnen eingerichteten Amazon S3-Bucket oder Windows Azure-Container bereit, den Sie als Upload-Ziel für Ihre OpenTok-Projekt.
url Zeichenfolge Die Download-URL der verfügbaren MP4-Datei. Diese wird nur für ein Archiv mit dem Status „verfügbar“ gesetzt; bei anderen Archiven (einschließlich Archiven mit dem Status „hochgeladen“) ist diese Eigenschaft auf null gesetzt. Die Download-URL ist verschleiert, und die Datei ist nur 10 Minuten lang über diese URL verfügbar. Um eine neue URL zu generieren, rufen Sie die OpenTok.getArchive() oder OpenTok.listArchives() Methode.
multiArchiveTag Zeichenfolge Setzen Sie diese Option, um die gleichzeitige Aufzeichnung mehrerer Archive für dieselbe Sitzung zu unterstützen. Legen Sie für jedes gleichzeitig laufende Archiv einer laufenden Sitzung eine eindeutige Zeichenfolge fest. Sie müssen diese Option auch festlegen, wenn Sie ein Archiv, das automatisch archiviert wird, manuell starten. Beachten Sie, dass der Wert von „multiArchiveTag“ nicht in der Antwort der Methoden zum Auflisten von Archiven und zum Abrufen von Archivinformationen enthalten ist. Wenn Sie kein eindeutiges „multiArchiveTag“ angeben, können Sie für eine bestimmte Sitzung jeweils nur ein Archiv aufzeichnen. Siehe Gleichzeitige Archive.

Methoden

Name Beschreibung
delete(callback) Löscht das OpenTok-Archiv.
stop(callback) Beendet die Aufzeichnung des Archivs.

delete(callback)

Löscht das OpenTok-Archiv.

Sie können nur ein Archiv löschen, dessen Status „verfügbar“ oder „hochgeladen“ lautet. Durch das Löschen eines Archivs wird dessen Eintrag aus der Archivliste entfernt. Bei einem „verfügbaren“ Archiv wird zudem die Archivdatei gelöscht, sodass sie nicht mehr zum Herunterladen zur Verfügung steht.

Parameter:
Name Typ Beschreibung
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei erfolgreicher Löschung des Archivs wird die Funktion ohne Übergabe von Argumenten aufgerufen. Bei einem Fehler wird ein Fehlerobjekt an die Funktion übergeben.

stop(callback)

Beendet die Aufzeichnung des Archivs.

Die Aufzeichnung von Archiven wird automatisch nach 120 Minuten beendet oder sobald sich alle Teilnehmer aus der archivierten Sitzung abgemeldet haben.

Parameter:
Name Typ Beschreibung
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - archive — Das „Archive“-Objekt.