Archiv

addStreamToArchive() : bool : Fügt einem aktuell laufenden Archiv, das mit der Einstellung „streamMode“ auf „StreamMode.Manual“ gestartet wurde, einen Stream hinzu. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams im Archiv ein- bzw. auszuschalten.

delete() : gemischt : Löscht ein OpenTok-Archiv.

getPermittedResolutions() : gemischt

jsonSerialize() : gemischt

removeStreamFromArchive() : bool : Entfernt einen Stream aus einem aktuell laufenden Archiv, das mit der Einstellung „streamMode“ auf „StreamMode.Manual“ gestartet wurde.

stop() : gemischt : Beendet die OpenTok-Aufzeichnung, falls gerade eine Aufzeichnung läuft.

toArray() : mixed : Gibt eine assoziative Array-Darstellung dieses Archiv-Objekts zurück.

toJson() : gemischt : Gibt eine JSON-Darstellung dieses Archiv-Objekts zurück.

Konstanten

ZULÄSSIGE_AUTOMATISCHE_AUFLÖSUNGEN

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

Eigenschaften

$createdAt

public int $createdAt

Der Zeitpunkt, zu dem das Archiv erstellt wurde, in Millisekunden seit der UNIX-Epoche.

$duration

public string $duration

Die Dauer des Archivs in Sekunden.

$hasAudio

public bool $hasAudio

Ob das Archiv eine Audiospur enthält (true) oder nicht (false).

$hasVideo

public bool $hasVideo

Ob das Archiv eine Videospur enthält (true) oder nicht (false).

$id

public string $id

Die Archiv-ID.

$multiArchiveTag

public string $multiArchiveTag

Ob „Multiple Archive“ aktiviert ist; dabei handelt es sich um eine eindeutige Zeichenfolge für jede gleichzeitige Archivierung einer laufenden Sitzung. Siehe https://tokbox.com/developer/guides/archiving/#simultaneous-archives für weitere Informationen.

$name

public string $name

Der Name des Archivs. Wenn bei der Erstellung des Archivs kein Name angegeben wurde, wird dieser Wert auf „null“ gesetzt.

$outputMode

public string $outputMode

Der Name des Archivs. Wenn bei der Erstellung des Archivs kein Name angegeben wurde, wird dieser Wert auf „null“ gesetzt.

$partnerId

public string $partnerId

Der dem Archiv zugeordnete API-Schlüssel.

$Grund

public string $reason

Bei Archiven mit dem Status „gestoppt“ oder „fehlgeschlagen“ beschreibt diese Zeichenfolge den Grund, warum das Archiv gestoppt wurde (z. B. „maximale Dauer überschritten“) oder warum es fehlgeschlagen ist.

$resolution

public string $resolution

Die Auflösung des Archivs beträgt entweder „640x480“ (SD im Querformat, Standardeinstellung), „1280x720“ (HD im Querformat), „1920x1080“ (FHD Querformat), „480x640“ (SD Hochformat), „720x1280“ (HD Hochformat) oder „1080x1920“ (FHD Hochformat). Für Archive, die Videostreams von Mobilgeräten enthalten (die häufig das Hochformat verwenden), empfiehlt sich die Verwendung des Hochformats.

$sessionId

public string $sessionId

Die Sitzungs-ID der OpenTok-Sitzung, die mit diesem Archiv verknüpft ist.

$size

public string $size

Die Größe der MP4-Datei. Bei noch nicht erstellten Archiven ist dieser Wert auf 0 gesetzt.

$status

public string $status

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 zur Verfügung.
„fehlgeschlagen“ – Die Archivierung ist fehlgeschlagen.
„pausiert“ – Die Archivierung läuft, und kein Client veröffentlicht derzeit Streams in der Sitzung. Wenn eine Archivierung läuft und ein Client einen Stream veröffentlicht, ändert sich der Status auf „gestartet“. Wenn eine Archivierung „pausiert“ 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, wechselt der Status zu „angehalten“, und nach 60 Sekunden wird die Archivaufzeichnung beendet (und der Status wechselt zu „beendet“).
„gestartet“ – Das Archiv wurde gestartet und wird gerade aufgezeichnet.
„gestoppt“ – Das Archiv hat die Aufzeichnung beendet.
„hochgeladen“ – Das Archiv steht zum Download auf dem von Ihnen für Ihr Projekt eingerichteten Amazon S3-Bucket oder Windows Azure-Container bereit. OpenTok-Projekt.

$streamMode

public string $streamMode

Ob die im Archiv enthaltenen Streams automatisch ausgewählt werden (StreamMode.AUTO) oder manuell (StreamMode.MANUAL). Wenn Streams automatisch ausgewählt werden (StreamMode.AUTO), können alle Streams der Sitzung in das Archiv aufgenommen werden. Wenn Streams manuell ausgewählt werden (StreamMode.MANUAL), geben Sie die einzubindenden Streams anhand von Aufrufen der Archive.addStreamToArchive() und Archive.removeStreamFromArchive() Methoden. Im manuellen Modus können Sie festlegen, ob Audio, Video oder beides eines Streams in das Archiv aufgenommen werden sollen. Sowohl im automatischen als auch im manuellen Modus nimmt der Archiv-Generator Streams auf der Grundlage von Stream Priorisierungsregeln.

$url

public string $url

Die Download-URL der verfügbaren MP4-Datei. Diese wird nur für ein Archiv gesetzt, dessen Status auf „verfügbar“ gesetzt ist; 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 über diese URL nur für 10 Minuten verfügbar. Um eine neue URL zu generieren, rufen Sie die Methode „Archive.listArchives()“ oder „OpenTok.getArchive()“ auf.

Methoden

addStreamToArchive()

Fügt einem aktuell laufenden Archiv, das mit der Einstellung „streamMode“ auf „StreamMode.Manual“ gestartet wurde, einen Stream hinzu. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams im Archiv ein- bzw. auszuschalten.

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

Parameter

$streamId : string : Die Stream-ID.

$hasAudio : bool : Gibt an, ob das Archiv den Ton des Streams enthalten soll (true, Standard) oder nicht (false).

$hasVideo : bool : Gibt an, ob das Archiv das Video des Streams enthalten soll (true, Standardwert) oder nicht (false).

Rückgabewerte

bool —

Gibt bei Erfolg „true“ zurück.

delete()

Löscht ein OpenTok-Archiv.

public delete() : mixed

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

Stichwörter

wirft : ArchiveException

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

Rückgabewerte

gemischt —

getPermittedResolutions()

public static getPermittedResolutions() : mixed

Rückgabewerte

gemischt —

jsonSerialize()

public jsonSerialize() : mixed

Rückgabewerte

gemischt —

removeStreamFromArchive()

Entfernt einen Stream aus einem aktuell laufenden Archiv, das mit der Einstellung „streamMode“ auf „StreamMode.Manual“ gestartet wurde.

public removeStreamFromArchive(string $streamId) : bool

Parameter

$streamId : string : Die Stream-ID.

Rückgabewerte

bool —

Gibt bei Erfolg „true“ zurück.

stop()

Beendet das OpenTok-Archiv, falls gerade eine Aufzeichnung läuft.

public stop() : mixed

Die Aufzeichnung wird automatisch beendet, nachdem 120 Minuten verstrichen sind oder wenn sich alle Teilnehmer aus der archivierten Sitzung abgemeldet haben.

Stichwörter

wirft : ArchiveException

The archive is not being recorded.

Rückgabewerte

gemischt —

toArray()

Gibt eine assoziative Array-Darstellung dieses Archiv-Objekts zurück.

public toArray() : mixed

Stichwörter

veraltet : 3.0.0

A more standard name for this method is supplied by JsonSerializable

siehe : Archive::jsonSerialize()

for a method with the same behavior

Rückgabewerte

gemischt —

toJson()

Gibt eine JSON-Darstellung dieses Archiv-Objekts zurück.

public toJson() : mixed

Rückgabewerte

gemischt —