Erbt von: : Object

Definiert in: : lib/opentok/archive.rb

Übersicht

Stellt ein Archiv einer OpenTok-Sitzung dar.

"1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
 You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio).
 This property is only set for composed archives.

Übersicht über Instanzattribute

Zusammenfassung der Instanzmethoden

Dynamische Methodenbehandlung

Diese Klasse verarbeitet dynamische Methoden mithilfe der Methode `method_missing`.

#method_missing(Methode, *args, &block) ⇒ Objekt

Details zu Instanzattributen

#created_at ⇒ int

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

Rückgabe:

  • (int) —

    der aktuelle Wert von „created_at“

#Dauer ⇒ Zeichenkette

Die Dauer des Archivs in Sekunden.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert der Duration

#has_audio ⇒ wahr, falsch

Gibt es in der Datei eine Audiospur (wahr) oder nicht (falsch)?

Rückgabe:

  • (wahr, falsch) —

    der aktuelle Wert von has_audio

#has_video ⇒ wahr, falsch

Ob das Archiv eine Videospur enthält (wahr) oder nicht (falsch).

Rückgabe:

  • (wahr, falsch) —

    der aktuelle Wert von has_video

#id ⇒ Zeichenkette

Die Archiv-ID.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von id

#multi_archive_tag ⇒ Objekt (schreibgeschützt)

Gibt den Wert des Attributs „multi_archive_tag“ zurück.

#Name ⇒ Zeichenkette

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

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von „name“

#Ausgabemodus ⇒ Zeichenfolge

Ob alle Streams im Archiv in einer einzigen Datei gespeichert werden (:composed) oder auf einzelne Dateien (:individual).

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von output_mode

#Projekt-ID ⇒ Zeichenkette

Der dem Archiv zugeordnete API-Schlüssel.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von projectId

#Grund ⇒ Zeichenkette

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

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert der Vernunft

#Entschließung ⇒ Zeichenkette

Die Auflösung des Archivs beträgt entweder „640x480“ (SD im Querformat, Standardeinstellung) oder „1280x720“ (HD im Querformat),

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert der Auflösung

#session_id ⇒ Zeichenkette

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

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von session_id

#Größe ⇒ float

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

Rückgabe:

  • (float) —

    der aktuelle Wert von „size“

#Status ⇒ Zeichenkette

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 Herunterladen 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, lautet der Status „Gestartet“. Während 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 Herunterladen in dem von Ihnen festgelegten Amazon S3-Bucket oder Windows Azure-Container bereit, den Sie als Upload-Ziel für Ihr OpenTok-Projekt.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert des Status

#stream_mode ⇒ Objekt (schreibgeschützt)

Gibt den Wert des Attributs „stream_mode“ zurück.

#streamMode ⇒ Zeichenkette

Ob die im Archiv enthaltenen Streams automatisch („auto“, Standardeinstellung) oder manuell („manual“) ausgewählt werden.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von streamMode

#URL ⇒ Zeichenkette

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 nur 10 Minuten lang über diese URL verfügbar. Um eine neue URL zu generieren, rufen Sie die Methode „Archive.listArchives()“ oder „OpenTok.getArchive()“ auf.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert der URL

Details zur Instanzmethode

#add_stream(stream_id, opts = {}) ⇒ Objekt

Fügt dem aktuell ausgeführten zusammengesetzten Archiv, das mit dem auf „manual“ gesetzten streamMode gestartet wurde, einen Stream hinzu. Eine Beschreibung dieser Funktion finden Sie unter <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Sie können die Methode wiederholt aufrufen, wobei Sie für „add_stream“ dieselbe Stream-ID angeben, um die Audio- oder Videokomponente des Streams im Archiv umzuschalten. Wenn Sie sowohl „has_audio“ als auch „has_video“ auf „false“ setzen, erhalten Sie eine Fehlermeldung.

Parameter:

  • stream_id (Zeichenkette) —

    Die ID des Streams, der dem Archiv hinzugefügt werden soll

  • opts (Hash) (Standardwert: {}) —

    eine individuell anpassbare Auswahl an Optionen

Options-Hash (opts):

  • :has_audio (true, false)

    — Standard: Boolescher Wert, optional —

    — Ob das erstellte Archiv den Ton des Streams enthalten soll (true, Standard) oder nicht (false).

  • :has_video (true, false)

    — Standard: Boolescher Wert, optional —

    — Ob das erstellte Archiv das Video des Streams enthalten soll (true, Standardeinstellung) oder nicht (false).

Erhöht:

#löschen ⇒ Objekt

Löscht ein 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.

#Layout(opts = {}) ⇒ Objekt

Legt den Layouttyp für ein zusammengesetztes Archiv fest. Eine Beschreibung der Layouttypen finden Sie unter Anpassen des Videolayouts für zusammengestellte Archive.

Parameter:

  • Optionen (Hash) —

    eine individuell anpassbare Auswahl an Optionen

Erhöht:

  • (ArgumentError) —

    Der Parameter „archive_id“ oder „options“ ist leer. Oder der Typ „custom“ wurde ohne Stylesheet-Option angegeben. Oder es wurde ein Stylesheet für einen anderen Typ als „custom“ übergeben. Oder es wurde ein ungültiger Typ übergeben.

  • (OpenTokAuthenticationError) —

    Die Authentifizierung ist fehlgeschlagen.

  • (ArgumentError) —

    Der Parameter „archive_id“ oder „options“ ist leer.

  • (ArgumentError) —

    Der Typ „custom“ wurde ohne Stylesheet-Option angegeben.

  • (ArgumentError) —

    Es wurde ein Stylesheet für einen anderen Typ als „custom“ übergeben. Oder es wurde ein ungültiger Typ übergeben.

  • (ArgumentError) —

    Es wurde ein ungültiger Layouttyp übergeben.

  • (OpenTok-Fehler) —

    OpenTok-Serverfehler.

  • (OpenTokArchiveError) —

    Das Festlegen des Layouts ist fehlgeschlagen.

#remove_stream(stream_id) ⇒ Objekt

Entfernt einen Stream aus einem derzeit laufenden zusammengesetzten Archiv, das mit dem auf „manual“ gesetzten streamMode gestartet wurde. Eine Beschreibung dieser Funktion finden Sie unter <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Parameter:

  • stream_id (Zeichenkette) —

    Die ID des Streams, der aus dem Archiv entfernt werden soll

Erhöht:

#stoppen ⇒ Objekt

Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.

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

#to_json ⇒ Objekt

Eine JSON-kodierte Zeichenfolgenrepräsentation des Archivs.