Un objeto que representa un renderizador de Experience Composer.
Características:
| Nombre |
Tipo |
Descripción |
id |
Cadena |
El identificador de la instancia de renderizado |
projectId |
Cadena |
El ID del proyecto para el renderizado. |
sessionId |
Cadena |
El ID de la sesión en la que se está realizando la representación. |
createdAt |
Numbers |
El momento en el que se creó la representación, en milisegundos desde la época UNIX. |
upddatedAt |
Numbers |
El momento en el que se creó la representación, en milisegundos desde la época UNIX. |
url |
Cadena |
Una URL accesible públicamente, controlada por el cliente y capaz de generar el contenido que se va a mostrar sin necesidad de intervención por parte del usuario. |
reason |
Cadena |
Proporciona una breve explicación textual del motivo por el que el renderizado ha fallado o se ha detenido. |
callbackUrl |
Cadena |
URL del servicio de atención al cliente donde se recibirán las llamadas de respuesta. |
event |
Cadena |
Último evento enviado para el renderizado |
resoultion |
Cadena |
Resolución del área de visualización de la composición. |
Métodos
| Nombre |
Descripción |
getRender(config, renderId, callback) |
Obtiene un Render objeto correspondiente al ID de renderizado indicado. |
listRenders(config, options, callback) |
|
startRender(config, options, callback) |
Inicia un «Experience Composer» para una sesión de OpenTok. |
stopRender(config, renderId, callback) |
Detiene un renderizado de OpenTok que se está llevando a cabo. |
getRender(config, renderId, callback)
Obtiene un Render objeto correspondiente al ID de renderizado indicado.
Parámetros:
| Nombre |
Tipo |
Descripción |
config |
Objeto |
Configuración de la API {@véase OpenTok} |
renderId |
Cadena |
El ID de renderizado que hay que recuperar |
callback |
función |
Función de devolución de llamada |
listRenders(config, options, callback)
Devuelve una lista de Render objetos que representan a Experience Composer en cualquier estado
Parámetros:
| Nombre |
Tipo |
Descripción |
config |
Objeto |
Parámetros de configuración de la API {@véase OpenTok.listRenders} |
options |
Objeto |
Parámetros opcionales para la llamada a la API {@véase OpenTok.listRenders} |
callback |
función |
Función de devolución de llamada |
startRender(config, options, callback)
Inicia un «Experience Composer» para una sesión de OpenTok.
Parámetros:
| Nombre |
Tipo |
Descripción |
config |
Objeto |
Parámetros de configuración de la API {@véase OpenTok.startRender} |
options |
Objeto |
Parámetros opcionales para la llamada a la API {@véase OpenTok.startRender} |
callback |
función |
Función de devolución de llamada |
stopRender(config, renderId, callback)
Detiene un renderizado de OpenTok que se está llevando a cabo.
Parámetros:
| Nombre |
Tipo |
Descripción |
config |
Objeto |
Ajustes de configuración de la API {@véase OpenTok.stopRender} |
renderId |
Cadena |
El ID de renderizado que hay que recuperar |
callback |
función |
Función de devolución de llamada |