Hérite de : : Object

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

Vue d'ensemble

Représente une session OpenTok.

Utilisez la méthode OpenTok.createSession() pour créer une session OpenTok. Utilisez la propriété session_id de l'objet Session pour récupérer l'identifiant de la session.

Résumé des attributs d'instance

Résumé des méthodes d'instance

Détails des attributs d'instance

#:résolution_des_archives ⇒ Chaîne de caractères (en lecture seule)

La gestion des archives dans une session à archivage automatique.

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de :archive_resolution

#archive_mode ⇒ Chaîne de caractères (en lecture seule)

La session sera-t-elle archivée automatiquement (:always) ou non (:manual).

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de archive_mode

#nom_de_l'archive ⇒ Chaîne de caractères (en lecture seule)

Nom à utiliser pour les archives dans les sessions à archivage automatique.

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de « archive_name »

#résolution_des_archives ⇒ Objet (en lecture seule)

Renvoie la valeur de l'attribut archive_resolution.

#e2ee ⇒ Objet (en lecture seule)

Renvoie la valeur de l'attribut e2ee.

#emplacement ⇒ Chaîne de caractères (en lecture seule)

L'adresse IP indiquant la localisation. Voir la méthode OpenTok.createSession().

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de l'emplacement

#mode_média ⇒ Chaîne de caractères (en lecture seule)

Définissez la valeur sur :routed si la session utilise le routeur multimédia OpenTok, ou sur :relayed si la session tente de transmettre des flux directement entre les clients.

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de « media_mode »

#session_id ⇒ Chaîne de caractères (en lecture seule)

L'identifiant de session.

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de session_id

Détails de la méthode d'instance

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

Génère un jeton.

Paramètres :

  • options (Hash)

Table de hachage des options (options) :

  • :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 ».

  • :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.)
    • :publisheronly – Un client connecté avec un jeton « publisheronly » peut publier des flux, mais ne peut pas s'abonner à des flux.
    • :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.

Retours :

  • (Chaîne de caractères) —

    La chaîne de caractères du jeton.