Erbt von: : Object

Definiert in: : lib/opentok/websocket.rb

Zusammenfassung der Instanzmethoden

Angaben zum Hersteller

#initialisieren(Client) ⇒ WebSocket

Gibt eine neue Instanz von WebSocket zurück.

Details zur Instanzmethode

#verbinden(session_id, token, websocket_uri, opts = {}) ⇒ Objekt

Stellt eine Audio-Connector-WebSocket-Verbindung her, um Audiodaten aus einer Vonage Video API-Sitzung an eine WebSocket-URI zu senden. Siehe die / OpenTok Audio Connector – Entwicklerhandbuch.

Beispiele:

opts = {
  "streams" => ["STREAMID1", "STREAMID2"],
  "headers" => {
    "key1" => "val1",
    "key2" => "val2"
  }
}
response = opentok.websocket.connect(SESSIONID, TOKEN, "ws://service.com/wsendpoint", opts)

Parameter:

  • session_id (Zeichenkette) —

    (erforderlich) Die OpenTok-Sitzungs-ID, die die OpenTok-Streams enthält, die Sie in den WebSocket-Stream einbinden möchten.

  • Token (Zeichenkette) —

    (erforderlich) Das OpenTok-Token, das für die Verbindung des Audio Connectors zur OpenTok-Sitzung verwendet werden soll.

  • websocket_uri (Zeichenkette) —

    (erforderlich) Eine öffentlich erreichbare WebSocket-URI, die als Ziel für den Audiostream verwendet werden soll (z. B. „wss://service.com/ws-endpoint“).

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

    (optional) Ein Hash, der Optionen für die WebSocket-Verbindung des Audio-Connectors definiert. Zum Beispiel:

Options-Hash (opts):

  • :streams (Array)

    — Standard: optional —

    Ein Array mit Stream-IDs für die OpenTok-Streams, die Sie in den WebSocket-Stream einbinden möchten. Wenn Sie diese Eigenschaft weglassen, werden alle Streams der Sitzung einbezogen.

  • :headers (Hash)

    — Standard: optional —

    Ein Hash aus Schlüssel-Wert-Paaren von Headern, die mit jeder Nachricht an Ihren WebSocket-Server gesendet werden sollen, mit einer maximalen Länge von 512 Byte.