Erbt von: : Object

Definiert in: : lib/opentok/streams.rb

Übersicht

Eine Klasse zur Arbeit mit OpenTok-Streams. Sie enthält Methoden zum Abrufen von Informationen über OpenTok-Streams, zum Festlegen von Layout-Klassen für Streams und zum Stummschalten von Streams.

Zusammenfassung der Instanzmethoden

Details zur Instanzmethode

#alle(session_id) ⇒ StreamList

Verwenden Sie diese Methode, um Informationen zu allen OpenTok-Streams in einer Sitzung abzurufen.

Sie können diese Methode beispielsweise aufrufen, um Informationen zu den von OpenTok-Streams verwendeten Layout-Klassen abzurufen. Die Layout-Klassen legen fest, wie der Stream im Layout einer Live-Übertragung oder einer zusammengestellten Archivaufzeichnung angezeigt wird. Weitere Informationen finden Sie unter Zuweisung von Layoutklassen zu Streams in Live-Streaming-Übertragungen und Anpassen des Videolayouts für zusammengestellte Archive.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der OpenTok-Sitzung.

Rückgabe:

  • (StreamList) —

    Die StreamList der Stream-Objekte.

Erhöht:

  • (ArgumentError) —

    Die „stream_id“ oder „session_id“ ist ungültig.

  • (OpenTokAuthenticationError) —

    Sie sind nicht berechtigt, die Stream-Informationen abzurufen. Überprüfen Sie Ihre Anmeldedaten.

  • (OpenTok-Fehler) —

    Ein OpenTok-Serverfehler.

#disable_force_mute(session_id) ⇒ Objekt

Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird der Ton bei neuen Streams, die in der Sitzung veröffentlicht werden, nicht mehr stummgeschaltet.

Nachdem Sie die Methode `force_mute_all()` aufgerufen haben, werden alle nach dem Aufruf veröffentlichten Streams mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die Methode `disable_force_mute()` auf, um den Stummschaltungsstatus einer Sitzung aufzuheben, damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID.

#finden(session_id, stream_id) ⇒ Stream

Verwenden Sie diese Methode, um Informationen zu einem OpenTok-Stream abzurufen.

Sie können diese Methode beispielsweise aufrufen, um Informationen zu den von einem OpenTok-Stream verwendeten Layout-Klassen abzurufen. Die Layout-Klassen legen fest, wie der Stream im Layout eines Broadcast-Streams angezeigt wird. Weitere Informationen finden Sie unter Zuweisung von Layoutklassen zu Streams in Live-Streaming-Übertragungen und Anpassen des Videolayouts für zusammengestellte Archive.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der OpenTok-Sitzung.

  • stream_id (Zeichenkette) —

    Die Stream-ID innerhalb der Sitzung.

Rückgabe:

  • (Stream) —

    Das Stream-Objekt.

Erhöht:

  • (ArgumentError) —

    Die stream_id oder session_id ist ungültig.

  • (OpenTokAuthenticationError) —

    Sie sind nicht berechtigt, die Stream-Informationen abzurufen. Überprüfen Sie Ihre Anmeldedaten.

  • (OpenTok-Fehler) —

    Ein OpenTok-Serverfehler.

#force_mute(session_id, stream_id) ⇒ Objekt

Einen bestimmten Stream, der mit einer OpenTok-Sitzung verbunden ist, zwangsweise stummschalten.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der OpenTok-Sitzung.

  • stream_id (Zeichenkette) —

    Die Stream-ID des Streams in der Sitzung.

#force_mute_all(session_id, opts = {}) ⇒ Objekt

Alle mit einer OpenTok-Sitzung verbundenen Streams (mit Ausnahme einer optionalen Liste von Streams) dazu zwingen, das veröffentlichte Audio stummzuschalten.

Zusätzlich zu den bereits bestehenden Streams werden alle Streams, die nach dem Aufruf dieser Methode veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltungsstatus einer Sitzung aufheben, indem Sie die Methode `disable_force_mute()` aufrufen.

Dies ist eine optionale Eigenschaft. Wenn Sie diese Eigenschaft weglassen, werden alle Streams in der Sitzung stummgeschaltet.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID.

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

    Ein optionaler Hash, der Optionen für die Stummschaltaktion definiert. Zum Beispiel:

    "excluded_streams" => [
  "excludedStreamId1",
  "excludedStreamId2"
]

Options-Hash (opts):

  • :excluded_streams (Array)

    -

    Die Stream-IDs der Streams, die nicht stummgeschaltet werden sollen.

#Layout(session_id, opts) ⇒ Objekt

Verwenden Sie diese Methode, um das Layout eines zusammengesetzten (Archiv- oder Live-)OpenTok-Streams festzulegen.

Sie können diese Methode beispielsweise aufrufen, um die Layout-Klassen eines OpenTok-Streams festzulegen. Die Layout-Klassen legen fest, wie der Stream im Layout einer Live-Übertragung oder einer zusammengestellten Archivaufzeichnung angezeigt wird. Weitere Informationen finden Sie unter Zuweisung von Layoutklassen zu Streams in Live-Streaming-Übertragungen und Anpassen des Videolayouts für zusammengestellte Archive.

Weitere Informationen finden Sie unter „Layout“<https://tokbox.com/developer/rest/#change-stream-layout-classes-composed>

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der OpenTok-Sitzung.

  • opts (Hash) —

    Ein Hash mit einem Schlüssel items und Wert als Array von Objekten mit stream_id und layoutClassList Eigenschaften.

Erhöht:

  • (ArgumentError) —

    Die session_id ist ungültig.

  • (OpenTokAuthenticationError) —

    Sie sind nicht berechtigt, die Stream-Informationen abzurufen. Überprüfen Sie Ihre Anmeldedaten.

  • (OpenTokStreamLayoutError) —

    Der Layoutvorgang konnte aufgrund falscher Layoutwerte nicht ausgeführt werden.

  • (OpenTok-Fehler) —

    Ein OpenTok-Serverfehler.