Erbt von: : Object

Definiert in: : lib/opentok/session.rb

Übersicht

Stellt eine OpenTok-Sitzung dar.

Verwenden Sie die Methode `OpenTok.createSession()`, um eine OpenTok-Sitzung zu erstellen. Rufen Sie die Sitzung-ID mithilfe der Eigenschaft `session_id` des `Session`-Objekts ab.

Übersicht über Instanzattribute

Zusammenfassung der Instanzmethoden

Details zu Instanzattributen

#:archive_resolution ⇒ Zeichenfolge (schreibgeschützt)

Die Auflösung von Archiven in einer automatisch archivierten Sitzung.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von :archive_resolution

#archive_mode ⇒ Zeichenfolge (schreibgeschützt)

Ob die Sitzung automatisch archiviert wird (:always) oder nicht (:manual).

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von „archive_mode“

#Archivname ⇒ Zeichenfolge (schreibgeschützt)

Der Name, der für Archive in automatisch archivierten Sitzungen verwendet werden soll.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von „archive_name“

#archive_resolution ⇒ Objekt (schreibgeschützt)

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

#e2ee ⇒ Objekt (schreibgeschützt)

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

#Standort ⇒ Zeichenfolge (schreibgeschützt)

Die IP-Adresse, die als Standorthinweis dient. Siehe die Methode „OpenTok.createSession()“.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert des Standorts

#media_mode ⇒ Zeichenfolge (schreibgeschützt)

Setzen Sie den Wert auf „:routed“, wenn die Sitzung den OpenTok Media Router verwendet, oder auf „:relayed“, wenn die Sitzung versucht, Streams direkt zwischen Clients zu übertragen.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von „media_mode“

#session_id ⇒ Zeichenfolge (schreibgeschützt)

Die Sitzungs-ID.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von session_id

Details zur Instanzmethode

#generate_token(Optionen) ⇒ Zeichenfolge

Erzeugt ein Token.

Parameter:

  • Optionen (Hash)

Options-Hash (options):

  • :token_type (Zeichenkette)

    -

    Der zu generierende Token-Typ. Muss entweder „T1“ oder „JWT“ lauten. „JWT“ ist die Standardeinstellung.

  • :Rolle (Symbol)

    -

    Die Rolle für das Token. Setzen Sie diesen Wert auf einen der folgenden Werte:

    • :subscriber – Ein Abonnent kann nur Streams abonnieren.
    • :publisher – Ein Publisher kann Streams veröffentlichen, Streams abonnieren und Signale senden. (Dies ist der Standardwert, wenn Sie keine Rolle angeben.)
    • :publisheronly – Ein Client, der mit einem „publisheronly“-Token verbunden ist, kann Streams veröffentlichen, aber keine Streams abonnieren.
    • :moderator – Zusätzlich zu den einem Publisher gewährten Berechtigungen kann ein Moderator Moderationsaufgaben wahrnehmen, beispielsweise Clients zwingen, die Verbindung zu trennen, die Veröffentlichung von Streams zu beenden oder den Ton in veröffentlichten Streams stummzuschalten. Siehe die / Leitfaden für Moderatoren.

  • :expire_time (Ganzzahl)

    -

    Die Ablaufzeit in Sekunden seit der UNIX-Epoche. Geben Sie den Wert 0 an, um die Standard-Ablaufzeit von 24 Stunden nach der Erstellung des Tokens zu verwenden. Die maximale Ablaufzeit beträgt 30 Tage nach der Erstellung.

  • :data (Zeichenkette)

    -

    Eine Zeichenkette mit Verbindungsmetadaten, die den Endbenutzer beschreiben. Sie können beispielsweise die Benutzer-ID, den Namen oder andere Daten übermitteln, die den Endbenutzer beschreiben. Die Länge der Zeichenkette ist auf 1000 Zeichen begrenzt. Diese Daten können nach ihrer Festlegung nicht mehr aktualisiert werden.

  • :initial_layout_class_list (Array)

    -

    Ein Array mit Klassennamen (Zeichenketten), die als anfängliche Layout-Klassen für die vom Client veröffentlichten Streams verwendet werden sollen. Layout-Klassen dienen zur Anpassung des Layouts von Videos in / Live-Streaming-Übertragungen und zusammengestellte Archive.

Rückgabe:

  • (Zeichenkette) —

    Die Token-Zeichenkette.