An object representing an Experience Composer renderer.
Properties:
| Name | Type | Description |
id | String | The ID of the render instance |
projectId | String | The ID of the project for the render. |
sessionId | String | The ID of the session being rendered into. |
createdAt | Number | The time at which the render was created, in milliseconds since the UNIX epoch. |
upddatedAt | Number | The time at which the render was created, in milliseconds since the UNIX epoch. |
url | String | A publically reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. |
reason | String | Gives a short textual reason for why the Render failed or stopped. |
callbackUrl | String | URL of the customer service where the callbacks will be received. |
event | String | Last sent event of for the render |
resoultion | String | Resolution of the display area for the composition. |
Methods
| Name | Description |
getRender(config, renderId, callback) | Gets a Render object for the given render ID. |
listRenders(config, options, callback) | |
startRender(config, options, callback) | Starts an Experience Composer for an OpenTok session. |
stopRender(config, renderId, callback) | Stops an OpenTok render that is being rendered. |
getRender(config, renderId, callback)
Gets a Render object for the given render ID.
Parameters:
| Name | Type | Description |
config | Object | API config {@see OpenTok} |
renderId | String | The Render ID to fetch |
callback | function | Callback function |
listRenders(config, options, callback)
Return a list of Render objects, representing Experience Composer in any status
Parameters:
| Name | Type | Description |
config | Object | API configuration settings {@see OpenTok.listRenders} |
options | Object | Optional parameters for the API call {@see OpenTok.listRenders} |
callback | function | Callback function |
startRender(config, options, callback)
Starts an Experience Composer for an OpenTok session.
Parameters:
| Name | Type | Description |
config | Object | API configuration settings {@see OpenTok.startRender} |
options | Object | Optional parameters for the API call {@see OpenTok.startRender} |
callback | function | Callback function |
stopRender(config, renderId, callback)
Stops an OpenTok render that is being rendered.
Parameters:
| Name | Type | Description |
config | Object | API configuration settings {@see OpenTok.stopRender} |
renderId | String | The Render ID to fetch |
callback | function | Callback function |