Erbt von: : Object

Definiert in: : lib/opentok/archives.rb

Übersicht

Eine Klasse zur Arbeit mit OpenTok-Archiven.

Zusammenfassung der Instanzmethoden

Details zur Instanzmethode

#add_stream(archive_id, stream_id, options) ⇒ 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:

  • archive_id (Zeichenkette) —

    Die Archiv-ID.

  • stream_id (Zeichenkette) —

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

  • opts (Hash) —

    eine individuell anpassbare Auswahl an Optionen

Erhöht:

  • (ArgumentError) —

    Der Parameter „archive_id“ ist leer.

  • (ArgumentError) —

    Der Parameter „stream_id“ ist leer.

  • (ArgumentError) —

    Die Eigenschaften „has_audio“ und „has_video“ des Parameters „options“ sind beide auf „false“ gesetzt.

#alle(options = {}) ⇒ Archivliste

Gibt eine „ArchiveList“ zurück, d. h. ein Array mit abgeschlossenen und noch laufenden Archiven für Ihren API-Schlüssel.

Parameter:

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

    Ein Hash mit Schlüsseln, die festlegen, welcher Bereich der Archive abgerufen werden soll.

Options-Hash (options):

  • :offset (Ganzzahl)

    -

    Optional. Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten Archivs. 1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde. Wenn Sie keinen Offset angeben, wird 0 verwendet.

  • :count (Ganzzahl)

    -

    Optional. Die Anzahl der zurückzugebenden Archive. Es werden maximal 1000 Archive zurückgegeben.

  • :session_id (Zeichenkette)

    -

    Optional. Die Sitzungs-ID, zu der die Archive gehören. Dies ist nützlich, wenn mehrere Archive für eine automatisch archivierte Sitzung.

Rückgabe:

  • (Archivliste) —

    Ein „ArchiveList“-Objekt, bei dem es sich um ein Array von „Archive“-Objekten handelt.

Erhöht:

  • (ArgumentError)

#erstellen.(session_id, options = {}) ⇒ Archiv

Beginnt mit der Archivierung einer OpenTok-Sitzung.

Die Teilnehmer müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie die Aufzeichnung eines Archivs erfolgreich starten können.

Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den OpenTok Media Router verwenden (Sitzungen, bei denen der Medienmodus auf „routed“ eingestellt ist); Sitzungen, bei denen der Medienmodus auf „relayed“ eingestellt ist, können nicht archiviert werden.

Weitere Informationen zur Archivierung finden Sie in der OpenTok-Archivierung Programmieranleitung.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung.

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

    Ein Hash mit den Schlüsseln „name“, „has_audio“, „has_video“ und „output_mode“.

Options-Hash (options):

  • :name (Zeichenkette)

    -

    Dies ist der Name des Archivs. Anhand dieses Namens können Sie das Archiv identifizieren. Es handelt sich um eine Eigenschaft des „Archive“-Objekts sowie um eine Eigenschaft von archivbezogenen Ereignissen in den OpenTok-Client-SDKs.

  • :has_audio (true, false)

    -

    Ob das Archiv eine Audiospur enthalten wird (true) oder nicht false). Der Standardwert ist true (eine Audiospur ist enthalten). Wenn Sie beide einstellen has_audio und has_video zu false, der Aufruf an die create() Die Methode führt zu einem Fehler.

  • :has_video (true, false)

    -

    Ob das Archiv eine Videospur enthalten wird (true) oder nicht false). Der Standardwert ist true (eine Videospur ist enthalten). Wenn Sie beides einstellen has_audio und has_video zu false, der Aufruf an die create() Die Methode führt zu einem Fehler.

  • :multi_archive_tag (Zeichenkette)

    — Standard: Optional —

    Stellen Sie diese Option ein, um die gleichzeitige Aufzeichnung mehrerer Archive für dieselbe Sitzung zu ermöglichen. Geben Sie hierfür für jedes gleichzeitig laufende Archiv einer laufenden Sitzung eine eindeutige Zeichenfolge ein. Sie müssen diese Option auch einstellen, wenn Sie ein Archiv manuell starten, das automatisch archiviert. Beachten Sie, dass das „multiArchiveTag“value is not included in the response for the methods to [list archives](https://tokbox.com/developer/rest/#listing_archives) and [retrieve archive information](https://tokbox.com/developer/rest/#retrieve_archive_info). If you do not specify a unique`multi_archive_tag`: In einer bestimmten Sitzung können Sie jeweils nur ein Archiv aufzeichnen. Siehe „Simultaneous“-Archive.

  • :output_mode (Zeichenkette)

    -

    Ob alle Streams im Archiv in einer einzigen Datei gespeichert werden (:composed, die Standardeinstellung) oder auf einzelne Dateien (:individual). Weitere Informationen zur Archivierung und zu den Archivdateiformaten finden Sie unter OpenTok-Archivierung Programmieranleitung.

  • :Auflösung (Zeichenkette)

    -

    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). Diese Eigenschaft gilt nur für zusammengesetzte Archive. Wenn Sie diese Eigenschaft festlegen und die Eigenschaft `outputMode` auf „individual“ setzen, führt ein Aufruf der Methode zu einem Fehler.

  • :stream_mode (Zeichenkette)

    — Standard: Optional —

    Ob die im Archiv enthaltenen Streams automatisch („auto“, Standardeinstellung) oder manuell („manual“) ausgewählt werden. Wenn Streams automatisch ausgewählt werden („auto“), können alle Streams der Sitzung in das Archiv aufgenommen werden. Wenn Streams manuell ausgewählt werden („manual“), legen Sie anhand von Aufrufen der #add_stream Methode. Sie können festlegen, ob Audio, Video oder beides eines Streams in das Archiv aufgenommen werden soll. Bei zusammengesetzten Archiven, sowohl im automatischen als auch im manuellen Modus, fügt der Archiv-Generator Streams auf der Grundlage von Strompriorisierungsregeln. Wichtig: Diese Funktion ist derzeit nur in der Standard-Umgebung verfügbar.

  • :layout (Hash)

    -

    Geben Sie dies an, um den anfänglichen Layouttyp für das Archiv festzulegen. Dies gilt nur für zusammengesetzte Archive. Es handelt sich um einen Hash, der drei Schlüssel enthält: :type, :stylesheet&lt;code&gt; and &lt;code&gt;:screenshare_type. Gültige Werte für :type sind „bestFit“ (beste Anpassung), „custom“ (benutzerdefiniert),

    "horizontalPresentation" (horizontal presentation),

    „pip“ (Bild-in-Bild) und „verticalPresentation“ (vertikale Darstellung)). Wenn Sie den Layout-Typ „custom“ angeben, legen Sie die :stylesheet Schlüssel für das Stylesheet (CSS). (Bei anderen Layouttypen darf der :stylesheet Schlüssel.) Gültige Werte für :screenshare_type sind „bestFit“, „pip“, „verticalPresentation“ und „horizontalPresentation“. Diese Eigenschaft ist optional. Wenn sie angegeben wird, dann wird die :type Eigenschaft muss auf „bestFit“ gesetzt sein. Wenn Sie keinen anfänglichen Layouttyp angeben, verwendet das Archiv den Layouttyp „bestFit“. Weitere Informationen finden Sie unter Anpassen des Videolayouts für zusammengestellte Archive.

  • :max_bitrate (Ganzzahl)

    — Standard: Optional —

    Die maximale Video-Bitrate für das Archiv in Bit pro Sekunde. Der Mindestwert beträgt 100.000, der Höchstwert 6.000.000. Diese Option gilt nur für zusammengesetzte Archive. Legen Sie die maximale Video-Bitrate fest, um die Größe des zusammengesetzten Archivs zu steuern. Diese maximale Bitrate gilt ausschließlich für die Video-Bitrate. Wenn das Ausgabearchiv Audio enthält, werden diese Bits von der Begrenzung ausgenommen.

Rückgabe:

  • (Archiv) —

    Das „Archive“-Objekt, das Eigenschaften enthält, die das Archiv definieren, darunter die Archiv-ID.

Erhöht:

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gestartet werden. Die Anfrage war ungültig oder die Sitzung hat keine verbundenen Clients.

  • (OpenTokAuthenticationError) —

    Die Authentifizierung beim Starten eines Archivs ist fehlgeschlagen. Ungültiger API-Schlüssel.

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gestartet werden. Die Sitzungs-ID existiert nicht.

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gestartet werden. Möglicherweise handelt es sich um eine Peer-to-Peer-Sitzung oder die Sitzung wird bereits aufgezeichnet.

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gestartet werden.

#delete_by_id(archive_id) ⇒ Objekt

Löscht ein OpenTok-Archiv.

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 gelöscht, sodass sie nicht mehr zum Herunterladen zur Verfügung steht. Bei einem „gelöschten“ Archiv bleibt der Löschvorgang bestehen.

Parameter:

  • archive_id (Zeichenkette) —

    Die Archiv-ID des Archivs, das Sie löschen möchten.

Erhöht:

  • (OpenTokAuthenticationError) —

    Die Authentifizierung ist fehlgeschlagen oder es wurde eine ungültige Archiv-ID angegeben.

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gelöscht werden. Der Status muss „verfügbar“, „gelöscht“ oder „hochgeladen“ lauten.

  • (OpenTokArchiveError) —

    Das Archiv konnte nicht gelöscht werden.

#finden(archive_id) ⇒ Archiv

Ruft ein Archivobjekt für die angegebene Archiv-ID ab.

Parameter:

  • archive_id (Zeichenkette) —

    Die Archiv-ID.

Rückgabe:

  • (Archiv) —

    Das Archiv-Objekt.

Erhöht:

#Layout(archive_id, options = {}) ⇒ 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:

  • archive_id (Zeichenkette) —

    Die Archiv-ID.

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

    eine individuell anpassbare Auswahl an Optionen

Options-Hash (options):

  • :type (Zeichenkette)

    -

    Der Layout-Typ. Legen Sie diesen Wert auf „bestFit“, „pip“, „verticalPresentation“, „horizontalPresentation“, „focus“ oder „custom“ fest.

  • :stylesheet (Zeichenkette)

    -

    Das Stylesheet für ein benutzerdefiniertes Layout. Legen Sie diesen Parameter fest, wenn Sie type zu "custom". Andernfalls lassen Sie es undefiniert.

  • :screenshare_type (Zeichenkette)

    -

    Der Layout-Typ für die Bildschirmfreigabe. Setzen Sie diesen Wert auf „bestFit“, „pip“, „verticalPresentation“ oder „horizonalPresentation“. Wenn dieser Wert definiert ist, dann wird die type Der Parameter muss auf "bestFit".

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(archive_id, stream_id) ⇒ Objekt

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

Parameter:

  • archive_id (Zeichenkette) —

    Die Archiv-ID.

  • stream_id (Zeichenkette) —

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

Erhöht:

  • (ArgumentError) —

    Der Parameter „archive_id“ ist leer.

  • (ArgumentError) —

    Der Parameter „stream_id“ ist leer.

#stop_by_id(archive_id) ⇒ Archiv

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.

Parameter:

  • archive_id (Zeichenkette) —

    Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten.

Rückgabe:

  • (Archiv) —

    Das „Archive“-Objekt, das dem zu stoppenden Archiv entspricht.

Erhöht: