Hérite de : : Object

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

Vue d'ensemble

Classe permettant de manipuler les rendus d'OpenTok Experience Composer. Voir / Experience Composer.

Résumé des méthodes d'instance

Détails de la méthode d'instance

#trouver(render_id) ⇒ Rendu

Récupère un objet Render correspondant à l'ID de rendu indiqué.

Paramètres :

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

    (Obligatoire) L'identifiant du rendu.

Retours :

  • (Rendu) —

    L'objet de rendu, qui comprend les propriétés définissant le rendu.

Augmentations :

#liste(options = {}) ⇒ RenderList

Renvoie une RenderList, c'est-à-dire un tableau de rendus d'Experience Composers associés à un projet.

Paramètres :

  • options (Hash) (valeur par défaut : {}) —

    Un hachage dont les clés définissent la plage de rendus à récupérer.

Table de hachage des options (options) :

  • :offset (entier)

    — par défaut : Facultatif —

    . Décalage de départ pour la liste des rendus d'Experience Composer. La valeur par défaut est 0.

  • :count (entier)

    -

    Facultatif. Nombre de rendus Experience Composer à récupérer à partir du décalage indiqué. La valeur par défaut est 50 et la valeur maximale est 1 000.

Retours :

  • (RenderList) —

    Un objet RenderList, qui est un tableau d'objets Render.

Augmentations :

  • (ArgumentError)

#commencer(session_id, options = {}) ⇒ Rendu

Lance un rendu d'Experience Composer pour une session OpenTok.

Paramètres :

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

    (Obligatoire) L'identifiant de la session OpenTok qui intégrera le flux d'Experience Composer.

  • options (Hash) (valeur par défaut : {}) —

    (Obligatoire) Un objet « hash » définissant les options de rendu.

Table de hachage des options (options) :

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

    — par défaut : Obligatoire —

    Un jeton OpenTok valide doté du rôle « Publisher » et (éventuellement) des données de connexion à associer au flux de sortie.

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

    — par défaut : Obligatoire —

    Une URL accessible au public, gérée par le client et capable de générer le contenu à afficher sans intervention de l'utilisateur. La longueur minimale de l'URL est de 15 caractères et sa longueur maximale est de 2 048 caractères.

  • :max_duration (Entier)

    — par défaut : Facultatif —

    Durée maximale autorisée pour l'Experience Composer, en secondes. Passé ce délai, il est automatiquement arrêté s'il est toujours en cours d'exécution. La valeur maximale est de 36 000 (10 heures), la valeur minimale est de 60 (1 minute) et la valeur par défaut est de 7 200 (2 heures). Lorsque l'Experience Composer s'arrête, son flux est désactivé et un événement est envoyé à l'URL de rappel, si celle-ci a été configurée dans le portail de l'Account.

  • :résolution (Chaîne de caractères)

    -

    La résolution de l’Experience Composer peut être « 640x480 » (SD paysage), « 480x640 » (SD portrait), « 1280x720 » (HD paysage), « 720x1280 » (HD portrait), « 1920x1080 » (FHD paysage) ou « 1080x1920 » (FHD portrait). Par défaut, cette résolution est de « 1280x720 » (HD paysage, valeur par défaut).

  • :propriétés (Table de hachage)

    — par défaut : Facultatif —

    Configuration initiale des propriétés de Publisher pour le flux de sortie composé. L'objet « properties » contient la clé :name (Chaîne de caractères) qui sert de nom au flux de sortie composite publié vers la session. Le nom doit comporter au minimum 1 caractère et au maximum 200 caractères.

Retours :

  • (Rendu) —

    L'objet de rendu, qui comprend les propriétés définissant le rendu, notamment l'identifiant du rendu.

Augmentations :

#arrêter(render_id) ⇒ Rendu

Arrête le rendu d'un OpenTok Experience Composer.

Paramètres :

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

    (Obligatoire) L'identifiant du rendu.

Retours :

  • (Rendu) —

    L'objet de rendu, qui comprend les propriétés définissant le rendu.

Augmentations :