Ein Objekt, das einen Experience Composer-Renderer repräsentiert.
Eigenschaften:
| Name |
Typ |
Beschreibung |
id |
Zeichenfolge |
Die ID der Render-Instanz |
projectId |
Zeichenfolge |
Die ID des Projekts für den Render. |
sessionId |
Zeichenfolge |
Die ID der Sitzung, in die gerendert wird. |
createdAt |
Numbers |
Der Zeitpunkt, zu dem das Rendering erstellt wurde, in Millisekunden seit der UNIX-Epoche. |
upddatedAt |
Numbers |
Der Zeitpunkt, zu dem das Rendering erstellt wurde, in Millisekunden seit der UNIX-Epoche. |
url |
Zeichenfolge |
Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und die den darzustellenden Inhalt ohne Benutzereingriff generieren kann. |
reason |
Zeichenfolge |
Gibt eine kurze textuelle Begründung dafür an, warum der Rendervorgang fehlgeschlagen ist oder abgebrochen wurde. |
callbackUrl |
Zeichenfolge |
URL des Kundendienstes, über den die Rückrufe empfangen werden. |
event |
Zeichenfolge |
Zuletzt gesendetes Ereignis für das Rendern |
resoultion |
Zeichenfolge |
Auflösung des Anzeigebereichs für die Komposition. |
Methoden
| Name |
Beschreibung |
getRender(config, renderId, callback) |
Ruft einen Rendering Objekt für die angegebene Render-ID. |
listRenders(config, options, callback) |
|
startRender(config, options, callback) |
Startet den Experience Composer für eine OpenTok-Sitzung. |
stopRender(config, renderId, callback) |
Beendet einen OpenTok-Render, der gerade ausgeführt wird. |
getRender(config, renderId, callback)
Ruft einen Rendering Objekt für die angegebene Render-ID.
Parameter:
| Name |
Typ |
Beschreibung |
config |
Objekt |
API-Konfiguration {@siehe OpenTok} |
renderId |
Zeichenfolge |
Die abzurufende Render-ID |
callback |
Funktion |
Callback-Funktion |
listRenders(config, options, callback)
Gibt eine Liste von Rendering Objekte, die den Experience Composer in einem beliebigen Status darstellen
Parameter:
| Name |
Typ |
Beschreibung |
config |
Objekt |
API-Konfigurationseinstellungen {@siehe OpenTok.listRenders} |
options |
Objekt |
Optionale Parameter für den API-Aufruf {@siehe OpenTok.listRenders} |
callback |
Funktion |
Callback-Funktion |
startRender(config, options, callback)
Startet den Experience Composer für eine OpenTok-Sitzung.
Parameter:
| Name |
Typ |
Beschreibung |
config |
Objekt |
API-Konfigurationseinstellungen {@siehe OpenTok.startRender} |
options |
Objekt |
Optionale Parameter für den API-Aufruf {@siehe OpenTok.startRender} |
callback |
Funktion |
Callback-Funktion |
stopRender(config, renderId, callback)
Beendet einen OpenTok-Render, der gerade ausgeführt wird.
Parameter:
| Name |
Typ |
Beschreibung |
config |
Objekt |
API-Konfigurationseinstellungen {@siehe OpenTok.stopRender} |
renderId |
Zeichenfolge |
Die abzurufende Render-ID |
callback |
Funktion |
Callback-Funktion |