Hérite de : : Object

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

Vue d'ensemble

Contient des méthodes permettant de créer des sessions OpenTok et de générer des jetons. Il comprend également des méthodes permettant de renvoyer des objets qui vous permettent de gérer des archives, de gérer des diffusions en direct, d'utiliser l'interconnexion SIP, d'envoyer des signaux aux sessions, de déconnecter des clients des sessions et de définir les classes de mise en page pour les flux.

Pour créer un nouvel objet OpenTok, appelez le constructeur OpenTok en lui transmettant votre clé API OpenTok et le secret API correspondant à votre Projet OpenTok. Ne divulguez pas votre clé secrète API. Vous l'utiliserez avec le constructeur OpenTok (uniquement sur votre serveur web) pour créer des sessions OpenTok.

Résumé des méthodes d'instance

Informations sur le constructeur

#initialiser(api_key, api_secret, opts = {}) ⇒ OpenTok

Créer un nouvel objet OpenTok.

Paramètres :

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

    La clé API OpenTok pour votre Projet OpenTok.

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

    Votre clé API OpenTok.

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

    un ensemble d'options personnalisables

Table de hachage des options (opts) :

  • :api_url (Symbole)

    -

    Ne configurez pas ce paramètre. Il est réservé à l'usage interne de Vonage.

  • :ua_addendum (Symbole)

    -

    Ne configurez pas ce paramètre. Il est réservé à l'usage interne de Vonage.

  • :timeout_length (Symbole)

    -

    Délai d'expiration personnalisé en secondes. S'il n'est pas spécifié, la valeur par défaut est de 2 secondes.

Détails de la méthode d'instance

#archives ⇒ Objet

Un objet « Archives » qui vous permet de manipuler les archives OpenTok.

#émissions ⇒ Objet

Un objet « Broadcasts », qui vous permet de gérer les diffusions en direct via OpenTok.

#légendes ⇒ Objet

Un objet « Captions » qui vous permet d'activer et de désactiver le sous-titrage en direct pour une session OpenTok.

#connexions ⇒ Objet

Un objet « Connections » qui permet de déconnecter des clients d'une session OpenTok.

#create_session(opts = {}) ⇒ Session

Crée une nouvelle session OpenTok et renvoie l'identifiant de session, qui identifie de manière unique cette session.

Par exemple, lorsque vous utilisez la bibliothèque JavaScript OpenTok, utilisez l'identifiant de session lorsque vous appelez la méthode OT.initSession() (pour initialiser une session OpenTok).

Les sessions OpenTok n'ont pas de date d'expiration. En revanche, les jetons d'authentification ont une durée de validité limitée (voir la méthode `generateToken()`). Notez également qu'il n'est pas possible de fermer explicitement une session.

Une chaîne d'identification de session peut comporter jusqu'à 255 caractères.

L'appel de cette méthode génère une exception OpenTokException en cas d'erreur. Consultez le message d'erreur pour plus de détails.

Vous pouvez également créer une session à l'aide de l'API REST d'OpenTok (voir </developer/rest/#session_id_production>) ou sur votre Page de compte OpenTok.

Paramètres :

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

    (Facultatif) Ce hachage définit les options de la session.

Table de hachage des options (opts) :

  • :media_mode (Symbole)

    -

    Détermine si la session transmettra des flux à l'aide d'OpenTok Media Router (:routed) ou non (:relayed). Par défaut, cette propriété est définie sur :relayed.

    Avec la media_mode est définie comme étant la propriété :relayed, la session tentera de transmettre les flux directement entre les clients. Si les clients ne parviennent pas à se connecter en raison de restrictions imposées par un pare-feu, la session utilise le serveur TURN d'OpenTok pour acheminer les flux audio et vidéo.

    Avec la media_mode est définie comme étant la propriété :routed, la session utilisera le Routeur multimédia OpenTok. Le routeur multimédia OpenTok offre les avantages suivants :

    • Le routeur multimédia OpenTok permet de réduire la consommation de bande passante lors des sessions multipartites. (Lorsque le media_mode est fixée à :relayedchaque client doit envoyer un flux audio-vidéo distinct à chaque client qui s'y abonne).
    • Le routeur multimédia OpenTok permet d'améliorer la qualité de l'expérience utilisateur grâce à repli audio et récupération vidéo. Grâce à ces fonctionnalités, si la connexion d’un client se détériore au point de ne plus permettre la lecture de la vidéo d’un flux auquel il est abonné, la vidéo est interrompue pour ce client (sans affecter les autres clients), et celui-ci ne reçoit alors que le son. Si la connexion du client s’améliore, la vidéo reprend.
    • Le routeur multimédia OpenTok prend en charge le archivage fonctionnalité qui vous permet d'enregistrer, de sauvegarder et de récupérer des sessions OpenTok.

  • :emplacement (chaîne de caractères)

    -

    Une adresse IP que les serveurs OpenTok utiliseront pour localiser la session au sein de leur réseau mondial. Si vous ne définissez pas d'indication de localisation, les serveurs OpenTok se baseront sur le premier client se connectant à la session.

  • :archive_mode (Symbole)

    -

    Détermine si la session sera archivée automatiquement (:always) ou non (:manual). En cas d'archivage automatique, la session doit utiliser la :routed mode multimédia.

  • :archive_name (Symbole)

    -

    Nom à utiliser pour les archives dans les sessions à archivage automatique. Lorsque vous activez cette option, l'option :archive_mode doit être définie sur :always, sinon une erreur se produira. La longueur du nom d'archive ne doit pas dépasser 80 caractères. En raison de contraintes d'encodage, les caractères spéciaux suivants sont remplacés par un deux-points (:) : ~, -, _. Si vous ne définissez pas de nom et que l'option archiveMode est définie sur always, le nom de l'archive sera vide.

  • :archive_resolution (Symbole)

    -

    La résolution des archives dans une session à archivage automatique. Les valeurs valides sont « 480x640 », « 640x480 » (par défaut), « 720x1280 », « 1280x720 », « 1080x1920 » et « 1920x1080 ». Lorsque vous configurez cette option, l’option :archive_mode doit être définie sur :always, sinon une erreur se produira.

  • :e2ee (vrai, faux)

    — par défaut : Booléen, facultatif —

    — Indique si la session utilise un chiffrement de bout en bout entre clients (par défaut : false). Cette option ne doit pas être définie sur « true ».if:mode_médiais:relayed`. Voir la / documentation pour plus d'informations.

Retours :

  • (Session) —

    L'objet Session. La propriété session_id de cet objet correspond à l'identifiant de session.

Augmentations :

  • (ArgumentError)

#générer_jeton(session_id, options) ⇒ chaîne de caractères

Génère un jeton pour une session donnée.

Paramètres :

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

    L'identifiant de la session à laquelle le client doit accéder à l'aide du jeton.

  • options (Hash) —

    Un hachage définissant les options du jeton.

Table de hachage des options (options) :

  • :rôle (Symbole)

    -

    Rôle du jeton. Définissez cette valeur sur l'une des options suivantes :

    • :subscriber – Un abonné ne peut s'abonner qu'à des flux.
    • :publisher – Un éditeur peut publier des flux, s'abonner à des flux et envoyer des signaux. (Il s'agit de la valeur par défaut si vous ne précisez pas de rôle.)
    • :moderator – Outre les privilèges accordés à un éditeur, un modérateur peut exercer des fonctions de modération, telles que forcer les clients à se déconnecter, à interrompre la diffusion de flux ou à couper le son dans les flux diffusés. Voir la / Guide du développeur sur la modération.

  • :expire_time (entier)

    -

    Durée d'expiration, en secondes depuis l'époque UNIX. Indiquez 0 pour utiliser la durée d'expiration par défaut, soit 24 heures après la date de création du jeton. La durée d'expiration maximale est de 30 jours après la date de création.

  • :data (Chaîne de caractères)

    -

    Une chaîne de caractères contenant les métadonnées de connexion décrivant l'utilisateur final. Vous pouvez, par exemple, transmettre l'identifiant de l'utilisateur, son nom ou d'autres données le décrivant. La longueur de la chaîne est limitée à 1 000 caractères. Une fois définies, ces données ne peuvent plus être modifiées.

  • :initial_layout_class_list (Tableau)

    -

    Un tableau de noms de classes (chaînes de caractères) à utiliser comme classes de mise en page initiales pour les flux publiés par le client. Les classes de mise en page servent à personnaliser la mise en page des vidéos dans / diffusions en direct et archives classées.

  • :token_type (Chaîne de caractères)

    -

    Type de jeton à générer. Doit être « T1 » ou « JWT ». La valeur par défaut est « JWT ».

Retours :

  • (Chaîne de caractères) —

    La chaîne de caractères du jeton.

#rendus ⇒ Objet

Un objet « Renders », qui vous permet de travailler avec les rendus d'OpenTok Experience Composer.

#signaux ⇒ Objet

Un objet « Signals » qui vous permet d'envoyer des signaux vers des sessions OpenTok.

#gorgée ⇒ Objet

Un objet Sip, qui vous permet d'utiliser la passerelle SIP OpenTok.

#cours d'eau ⇒ Objet

Un objet « Streams » qui vous permet de gérer les diffusions en direct via OpenTok.

#WebSocket ⇒ Objet

Un objet WebSocket, qui permet de connecter des flux OpenTok à une URI WebSocket.