Um objeto que representa um renderizador do Experience Composer.
Características:
| Nome |
Tipo |
Descrição |
id |
String |
O ID da instância de renderização |
projectId |
String |
O ID do projeto para a renderização. |
sessionId |
String |
O ID da sessão na qual a renderização está sendo feita. |
createdAt |
Número |
A hora em que a renderização foi criada, em milissegundos desde a época UNIX. |
upddatedAt |
Número |
A hora em que a renderização foi criada, em milissegundos desde a época UNIX. |
url |
String |
Um URL acessível ao público, controlado pelo cliente e capaz de gerar o conteúdo a ser exibido sem a intervenção do usuário. |
reason |
String |
Apresenta uma breve explicação em texto sobre o motivo pelo qual a renderização falhou ou foi interrompida. |
callbackUrl |
String |
URL do serviço de atendimento ao cliente onde as chamadas de retorno serão recebidas. |
event |
String |
Último evento enviado para a renderização |
resoultion |
String |
Resolução da área de exibição da composição. |
Métodos
| Nome |
Descrição |
getRender(config, renderId, callback) |
Obtém um Renderizar objeto correspondente ao ID de renderização fornecido. |
listRenders(config, options, callback) |
|
startRender(config, options, callback) |
Inicia um Experience Composer para uma sessão do OpenTok. |
stopRender(config, renderId, callback) |
Interrompe uma renderização do OpenTok que está em andamento. |
getRender(config, renderId, callback)
Obtém um Renderizar objeto correspondente ao ID de renderização fornecido.
Parâmetros:
| Nome |
Tipo |
Descrição |
config |
Objeto |
Configuração da API {@ver OpenTok} |
renderId |
String |
O ID do render a ser buscado |
callback |
função |
Função de retorno de chamada |
listRenders(config, options, callback)
Retorna uma lista de Renderizar objetos que representam o Experience Composer em qualquer status
Parâmetros:
| Nome |
Tipo |
Descrição |
config |
Objeto |
Configurações da API {@see OpenTok.listRenders} |
options |
Objeto |
Parâmetros opcionais para a chamada de API {@see OpenTok.listRenders} |
callback |
função |
Função de retorno de chamada |
startRender(config, options, callback)
Inicia um Experience Composer para uma sessão do OpenTok.
Parâmetros:
| Nome |
Tipo |
Descrição |
config |
Objeto |
Configurações da API {@veja OpenTok.startRender} |
options |
Objeto |
Parâmetros opcionais para a chamada da API {@see OpenTok.startRender} |
callback |
função |
Função de retorno de chamada |
stopRender(config, renderId, callback)
Interrompe uma renderização do OpenTok que está em andamento.
Parâmetros:
| Nome |
Tipo |
Descrição |
config |
Objeto |
Configurações da API {@veja OpenTok.stopRender} |
renderId |
String |
O ID do render a ser buscado |
callback |
função |
Função de retorno de chamada |