Un objet représentant un moteur de rendu Experience Composer.
Caractéristiques :
| Nom |
Type |
Description |
id |
Chaîne |
L'identifiant de l'instance de rendu |
projectId |
Chaîne |
L'identifiant du projet pour le rendu. |
sessionId |
Chaîne |
L'identifiant de la session dans laquelle le rendu est effectué. |
createdAt |
Numbers |
L'instant auquel le rendu a été créé, en millisecondes depuis l'époque UNIX. |
upddatedAt |
Numbers |
L'instant auquel le rendu a été créé, en millisecondes depuis l'époque UNIX. |
url |
Chaîne |
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. |
reason |
Chaîne |
Fournit une brève explication textuelle des raisons pour lesquelles le rendu a échoué ou s'est interrompu. |
callbackUrl |
Chaîne |
URL du service client où les rappels seront reçus. |
event |
Chaîne |
Dernier événement envoyé pour le rendu |
resoultion |
Chaîne |
Résolution de la zone d'affichage de la composition. |
Méthodes
| Nom |
Description |
getRender(config, renderId, callback) |
Récupère un Rendu objet correspondant à l'ID de rendu indiqué. |
listRenders(config, options, callback) |
|
startRender(config, options, callback) |
Lance l'Experience Composer pour une session OpenTok. |
stopRender(config, renderId, callback) |
Arrête un rendu OpenTok en cours d'exécution. |
getRender(config, renderId, callback)
Récupère un Rendu objet correspondant à l'ID de rendu indiqué.
Paramètres :
| Nom |
Type |
Description |
config |
Objet |
Configuration de l'API {@voir OpenTok} |
renderId |
Chaîne |
L'identifiant de rendu à récupérer |
callback |
fonction |
Fonction de rappel |
listRenders(config, options, callback)
Renvoie une liste de Rendu objets représentant Experience Composer, quel que soit son état
Paramètres :
| Nom |
Type |
Description |
config |
Objet |
Paramètres de configuration de l'API {@voir OpenTok.listRenders} |
options |
Objet |
Paramètres facultatifs pour l'appel d'API {@voir OpenTok.listRenders} |
callback |
fonction |
Fonction de rappel |
startRender(config, options, callback)
Lance l'Experience Composer pour une session OpenTok.
Paramètres :
| Nom |
Type |
Description |
config |
Objet |
Paramètres de configuration de l'API {@voir OpenTok.startRender} |
options |
Objet |
Paramètres facultatifs pour l'appel d'API {@voir OpenTok.startRender} |
callback |
fonction |
Fonction de rappel |
stopRender(config, renderId, callback)
Arrête un rendu OpenTok en cours d'exécution.
Paramètres :
| Nom |
Type |
Description |
config |
Objet |
Paramètres de configuration de l'API {@voir OpenTok.stopRender} |
renderId |
Chaîne |
L'identifiant de rendu à récupérer |
callback |
fonction |
Fonction de rappel |