継承元： : Object

定義場所： : lib/opentok/websocket.rb

インスタンスメソッドの概要

コンストラクタの詳細

#初期化(クライアント) ⇒ WebSocket

WebSocket の新しいインスタンスを返します。

インスタンスメソッドの詳細

#コネクト(session_id, token, websocket_uri, opts = {}) ⇒ Object

Vonage Video API セッションから WebSocket URI へオーディオを送信するための Audio Connector WebSocket 接続を開始します。詳しくは、 / OpenTok Audio Connector 開発者ガイド.

例を挙げよう：

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

パラメータ：

  • session_id (文字列) —

    (必須) WebSocket ストリームに含めたい OpenTok ストリームを含む OpenTok セッション ID。

  • token (String) —

    (必須) OpenTokセッションへのAudio Connector接続に使用するOpenTokトークン。

  • websocket_uri (文字列) —

    (必須) オーディオストリームの送信先として使用する、一般にアクセス可能な WebSocket URI（例：「wss://service.com/ws-endpoint」など）。

  • opts (ハッシュ) （デフォルトは：{}） —

    （オプション）Audio ConnectorのWebSocket接続に関するオプションを定義するハッシュ。例：

オプションハッシュ (opts):

  • :streams (配列)

    — デフォルト: オプション —

    WebSocketストリームに含めたいOpenTokストリームのIDの配列です。このプロパティを省略した場合、セッション内のすべてのストリームが含まれます。

  • :headers (ハッシュ)

    — デフォルト: オプション —

    各メッセージとともにWebSocketサーバーに送信されるヘッダーのキー・値ペアのハッシュ。最大長は512バイトです。