Hérite de : : Object

Défini dans : : lib/opentok/websocket.rb

Résumé des méthodes d'instance

Informations sur le constructeur

#initialiser(client) ⇒ WebSocket

Renvoie une nouvelle instance de WebSocket.

Détails de la méthode d'instance

#relier(session_id, token, websocket_uri, opts = {}) ⇒ Objet

Établit une connexion WebSocket via Audio Connector afin d'envoyer le flux audio d'une session de la Video API Vonage vers une URI WebSocket. Consultez la / Guide du développeur d'OpenTok Audio Connector.

Exemples :

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

Paramètres :

  • session_id (Chaîne de caractères) —

    (obligatoire) L'identifiant de session OpenTok qui regroupe les flux OpenTok que vous souhaitez inclure dans le flux WebSocket.

  • jeton (chaîne de caractères) —

    (obligatoire) Le jeton OpenTok à utiliser pour la connexion d'Audio Connector à la session OpenTok.

  • websocket_uri (Chaîne de caractères) —

    (obligatoire) Une URI WebSocket accessible au public, qui servira de destination au flux audio (par exemple : « wss://service.com/ws-endpoint »).

  • opts (Table de hachage) (valeur par défaut : {}) —

    (facultatif) Un objet « hash » définissant les options de la connexion WebSocket d'Audio Connector. Par exemple :

Table de hachage des options (opts) :

  • :streams (Tableau)

    — par défaut : facultatif —

    Un tableau contenant les identifiants des flux OpenTok que vous souhaitez inclure dans le flux WebSocket. Si vous omettez cette propriété, tous les flux de la session seront inclus.

  • :en-têtes (Hash)

    — par défaut : facultatif —

    Un hachage des paires clé-valeur des en-têtes à envoyer à votre serveur WebSocket avec chaque message, d'une longueur maximale de 512 octets.