Konstruktor

new OpenTok(apiKey, apiSecret)

Enthält Methoden zum Erstellen von OpenTok-Sitzungen, zum Generieren von Tokens, zum Arbeiten mit Archiven und vieles mehr.

Um ein neues OpenTok-Objekt zu erstellen, rufen Sie den OpenTok-Konstruktor mit Ihrem OpenTok-API-Schlüssel und dem API-Geheimnis für Ihr Vonage Video API-Konto. Geben Sie Ihren API-Schlüssel nicht öffentlich weiter. Sie verwenden ihn mit dem OpenTok-Konstruktor (ausschließlich auf Ihrem Webserver), um OpenTok-Sitzungen zu erstellen.

Stellen Sie sicher, dass das gesamte OpenTok Node.js SDK auf Ihrem Webserver installiert ist.

Parameter:
Name Typ Beschreibung
apiKey Zeichenfolge Ihr OpenTok-API-Schlüssel. (Siehe Ihre Vonage Video API Account-Seite.)
apiSecret Zeichenfolge Ihr OpenTok-API-Schlüssel. (Siehe Ihre Vonage Video API Account-Seite.)

Methoden

Name Beschreibung
addArchiveStream(archiveId, streamId, archiveOptions, callback) Fügt einem Archiv, bei dem der „streamMode“ auf „manual“ gesetzt ist, einen Stream hinzu.
addBroadcastStream(broadcastId, streamId, broadcastOptions, callback) Fügt einem Broadcast, dessen `streamMode` auf „manual“ gesetzt ist, einen Stream hinzu.
createSession(options, callback) Erstellt eine neue OpenTok-Sitzung.
deleteArchive(archiveId, callback) Löscht ein OpenTok-Archiv.
dial(sessionId, token, sipUri, options) Stellt eine Verbindung zu einem SIP-Gateway her, um einen reinen Audio-Stream in Ihre OpenTok-Sitzung einzuspeisen.
disableForceMute(sessionId, callback) Hebt den aktiven Stummschaltstatus der Sitzung auf.
forceDisconnect(sessionId, connectionId, callback) Trennt einen Teilnehmer von einer OpenTok-Sitzung.
forceMuteAll(sessionId, opts, callback) Zwingt alle Streams (mit Ausnahme eines optionalen Arrays von Streams) in einer Sitzung dazu, das veröffentlichte Audio stummzuschalten.
forceMuteStream(sessionId, streamId, callback) Den Ton eines bestimmten Streams in einer Sitzung stummschalten.
generateToken(sessionId, options, generateT1Token) Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung.
getArchive(archiveId, callback) Ruft einen Archiv Objekt für die angegebene Archiv-ID.
getBroadcast(broadcastId, callback) Gibt Informationen zu einer Live-Streaming-Übertragung zurück.
getRender(renderId, callback) Ruft einen Rendering Objekt für die angegebene Render-ID.
getStream(sessionId, options, callback) Ruft Informationen zu einem Stream ab.
listArchives(options, callback) Ruft eine Liste von ab Archiv Objekte, die sowohl abgeschlossene als auch laufende Archive für Ihren API-Schlüssel darstellen.
listBroadcasts(options, callback) Ruft eine Liste von ab Sendung Objekte, die sowohl abgeschlossene als auch laufende Übertragungen für Ihren API-Schlüssel darstellen.
listRenders(options, callback) Ruft eine Liste von ab Rendering Objekte, die alle Renderings im Status „startend“, „gestartet“, „gestoppt“ oder „fehlgeschlagen“ für Ihren API-Schlüssel darstellen.
listStreams(sessionId, callback) Ruft eine Liste von ab Stream Objekte, die aktuelle Streams in einer Sitzung darstellen.
playDTMF(sessionId, connectionId, digits, callback) Senden Sie DTMF-Ziffern an alle Teilnehmer einer aktiven OpenTok-Sitzung oder an einen bestimmten Client, der mit dieser Sitzung verbunden ist.
removeArchiveStream(archiveId, streamId, callback) Entfernt einen Stream aus einem zusammengesetzten Archiv, bei dem der „streamMode“ auf „manual“ gesetzt ist.
removeBroadcastStream(broadcastId, streamId, callback) Entfernt einen Stream aus einer Übertragung, bei der der „streamMode“ auf „manual“ gesetzt ist.
setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback) Legt den Layouttyp für ein zusammengesetztes Archiv fest.
setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback) Legt das Layout der Sendung fest (oder aktualisiert es).
setStreamClassLists(sessionId, classListArray, callback) Legt die Liste der Layoutklassen für Streams in einer Sitzung fest.
signal(sessionId, connectionId, payload, callback) Sendet ein Signal an alle Verbindungen einer Sitzung oder an eine bestimmte Verbindung.
startArchive(sessionId, options, callback) Beginnt mit der Archivierung einer OpenTok-Sitzung.
startBroadcast(sessionId, options, callback) Startet eine Live-Streaming-Übertragung.
startCaptions(sessionId, token, options, callback) Startet die Live-Untertitel für eine OpenTok-Sitzung.
startCaptions(captionId, callback)
startRender(options, callback) Startet den Experience Composer für eine OpenTok-Sitzung.
stopArchive(archiveId, callback) Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.
stopBroadcast(broadcastId, callback) Beendet eine Live-Streaming-Übertragung.
stopRender(renderId, callback) Beendet einen Experience Composer, der gerade gerendert wird.
websocketConnect(sessionId, token, websocketUri, options, callback) Sendet Audio aus einer Vonage Video API-Sitzung an einen WebSocket.

addArchiveStream(archiveId, streamId, archiveOptions, callback)

Fügt einem Archiv, dessen `streamMode` auf „manual“ gesetzt ist, einen Stream hinzu. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams im Archiv ein- bzw. auszuschalten.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID.
streamId Zeichenfolge Die Stream-ID, die dem Archiv hinzugefügt werden soll.
archiveOptions Objekt Ein Objekt, das folgende Eigenschaften aufweist: - hasAudio — Ob das erstellte Archiv den Audio-Stream des Streams enthalten soll (true, Standard) oder nicht (false). - hasVideo — Ob das erstellte Archiv das Video des Streams enthalten soll (true, Standard) oder nicht (false).
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion wird ein Argument übergeben – error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt).

addBroadcastStream(broadcastId, streamId, broadcastOptions, callback)

Fügt einem Broadcast, dessen `streamMode` auf „manual“ gesetzt ist, einen Stream hinzu. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um das Audio oder Video des Streams im Broadcast ein- bzw. auszublenden.

Parameter:
Name Typ Beschreibung
broadcastId Zeichenfolge Die Sendungs-ID.
streamId Zeichenfolge Die Stream-ID, die zur Übertragung hinzugefügt werden soll.
broadcastOptions Objekt Ein Objekt, das folgende Eigenschaften aufweist: - hasAudio — Ob die Übertragung den Ton des Streams enthalten soll (true, Standardeinstellung) oder nicht (false). - hasVideo — Ob die Übertragung das Video des Streams enthalten soll (true, Standard) oder nicht (false).
callback Funktion Eine Callback-Methode, die zwei Parameter entgegennimmt: error, das im Fehlerfall auf ein Error-Objekt gesetzt wird, und broadcast, das auf einen Sendung Objekt bei Erfolg.

createSession(Optionen, Callback)

Erstellt eine neue OpenTok-Sitzung. Die Sitzung wird als Sitzung Objekt in die Callback- Funktion. Die sessionId Die Eigenschaft ist die Sitzungs-ID, die die Sitzung eindeutig identifiziert. Im Fehlerfall wird ein Error-Objekt an die Callback-Funktion übergeben.

Wenn Sie beispielsweise die OpenTok.js-Bibliothek verwenden, geben Sie beim Aufruf der OT.initSession() Methode (zum Initialisieren einer OpenTok-Sitzung).

OpenTok-Sitzungen laufen nicht ab. Authentifizierungstoken verfallen jedoch (siehe die Methode `generateToken(String, TokenOptions)`). Beachten Sie außerdem, dass Sitzungen nicht explizit beendet werden können.

Eine Sitzungs-ID-Zeichenkette kann bis zu 255 Zeichen lang sein. Sie können eine Sitzung auch mithilfe der OpenTok REST API oder indem Sie sich bei Ihrem Vonage Video API-Konto.

Parameter:
Name Typ Beschreibung
options Objekt Dieses Objekt definiert Optionen für die Sitzung, darunter die folgenden Eigenschaften (die beide optional sind): - location (Zeichenkette) — Eine IP-Adresse, anhand derer die OpenTok-Server die Sitzung im globalen OpenTok-Netzwerk zuordnen. Wenn Sie keinen Standorthinweis festlegen, stützen sich die OpenTok-Server auf den ersten Client, der eine Verbindung zur Sitzung herstellt. - e2ee (Boolesch) — Legt fest, ob [end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption/) for the OpenTok session. Set to "true"or"false". - mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router („geschlagen“) or not („weitergegeben“). By default, the setting is „weitergegeben“. With the mediaModeparameter set to„weitergegeben“, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams. The [OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits: - archiveMode (String) — Whether the session is automatically archived („immer“) or not („Handbuch“). By default, the setting is „Handbuch“, and you must call the StartArchive()method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set themediaModeparameter to „geschlagen“. - Archivname(String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, \_. -archiveResolution(Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080". - The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When themediaModeparameter is set to„weitergeleitet“`, muss jeder Client einen separaten Audio-Video-Stream an jeden Client senden, der diesen abonniert.) – Der OpenTok Media Router kann die Qualität des Nutzererlebnisses verbessern durch Audio-Fallback und Video-Wiederherstellung. Mit diesen Funktionen wird – falls sich die Verbindung eines Clients so weit verschlechtert, dass er die Videoübertragung für einen abonnierten Stream nicht mehr unterstützen kann – das Video für diesen Client unterbrochen (ohne dass andere Clients davon betroffen sind), und der Client empfängt nur noch Audio. Verbessert sich die Verbindung des Clients, wird das Video wiederhergestellt. - Der OpenTok Media Router unterstützt die Archivierung Funktion, mit der Sie OpenTok-Sitzungen aufzeichnen, speichern und abrufen können.
callback Funktion Die Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist. Dieser Funktion werden zwei Argumente übergeben: - error — Bei einem Fehler wird dieser Parameter auf ein Error-Objekt gesetzt. Weitere Informationen finden Sie in der Fehlermeldung. Bei Erfolg wird er auf null gesetzt. - session — Bei Erfolg wird dieser Parameter auf einen Sitzung Objekt. Die Eigenschaft „sessionId“ dieses Objekts ist die Sitzungs-ID der Sitzung. Im Fehlerfall ist dieser Parameter nicht gesetzt.

deleteArchive(archiveId, callback)

Löscht ein OpenTok-Archiv.

Sie können nur ein Archiv löschen, dessen Status „verfügbar“ oder „hochgeladen“ lautet. Durch das Löschen eines Archivs wird dessen Eintrag aus der Archivliste entfernt. Bei einem „verfügbaren“ Archiv wird zudem die Archivdatei gelöscht, sodass sie nicht mehr zum Herunterladen zur Verfügung steht.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID des Archivs, das Sie löschen möchten.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei erfolgreicher Löschung des Archivs wird die Funktion ohne Übergabe von Argumenten aufgerufen. Bei einem Fehler wird ein Fehlerobjekt an die Funktion übergeben.

dial(sessionId, token, sipUri, options)

Stellt eine Verbindung zu einem SIP-Gateway her, um einen reinen Audio-Stream in Ihre OpenTok-Sitzung einzuspeisen. Teil der SIP- Funktion.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird.
token Das Token für die Sitzungs-ID, mit der sich der SIP-Benutzer verbinden wird.
sipUri Die SIP-URI, die von der SIP-Interconnect-Funktion gewählt wird.
options Objekt Ein optionales Optionsobjekt mit den folgenden Eigenschaften (die alle optional sind): - headers (Objekt) — Benutzerdefinierte Header, die der von OpenTok an die SIP-Plattform eines Drittanbieters gesendeten SIP-INVITE-Anfrage hinzugefügt werden sollen. - auth (Objekt) — Die Anmeldedaten, die für die HTTP-Digest-Authentifizierung verwendet werden sollen, falls dies von der SIP-Plattform eines Drittanbieters verlangt wird. - „username“ -- Der Benutzername, der im SIP-INVITE-Request verwendet werden soll. - „password“ -- Das Passwort, das im SIP-INVITE verwendet werden soll. - secure (Boolesch) — Gibt an, ob die SIP-Medienstreams verschlüsselt übertragen werden sollen oder nicht. - from (Zeichenkette) — Die Nummer oder Zeichenkette, die als Anrufer an die endgültige SIP-Nummer gesendet wird. Es muss sich um eine Zeichenkette in folgender Form handeln: from@example.com, wobei from kann eine Zeichenkette oder eine Zahl sein. Wenn from wird auf eine Zahl gesetzt (zum Beispiel, "14155550101@example.com"), wird sie auf Festnetztelefonen als eingehende Nummer angezeigt. Wenn from ist nicht definiert oder auf eine Zeichenkette gesetzt (zum Beispiel, "joe@example.com"), +00000000 wird auf Festnetztelefonen als anrufende Nummer angezeigt. - video (Boolesch) — Ein boolescher Flag, der angibt, ob der SIP-Anruf Video enthalten wird (true) oder nicht (false, die Standardeinstellung). Wenn Video enthalten ist, wird das Video des SIP-Clients in den OpenTok-Stream aufgenommen, der an die OpenTok-Sitzung gesendet wird. Der SIP-Client erhält einen dynamisch zusammengesetzten Videostream aus den in der OpenTok-Sitzung veröffentlichten Streams. Dies ist eine Beta-Funktion. - observeForceMute (optional) Gibt der SIP-Endpunkt die von anderen Clients, wie z. B. Moderatoren, veranlasste Stummschaltung an (true) oder auch nicht (false(Standard). Siehe Stummschalten des Tons von Streams in einer Sitzung. - streams (optional) Die Stream-IDs der Teilnehmer, die vom SIP-Teilnehmer abonniert werden sollen. Werden keine angegeben, werden alle Streams der Sitzung ausgewählt.
Rückgabe:

A SipInterconnect Objekt mit den folgenden Eigenschaften:

  • id -- Die eindeutige Konferenz-ID des SIP-Anrufs
  • connectionId -- Die Verbindungs-ID des reinen Audio-Streams, der den SIP-Anruf darstellt
  • streamId -- Die Stream-ID des reinen Audio-Streams, der den SIP-Anruf darstellt

disableForceMute(sessionId, callback)

Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.

Nachdem Sie die OpenTok.forceMuteAll() Methode, werden alle nach dem Aufruf veröffentlichten Streams mit stummgeschaltetem Ton veröffentlicht. Wenn Sie die OpenTok.disableForceMute() Mit dieser Methode werden künftig an die Sitzung übermittelte Streams nicht stummgeschaltet (bereits stummgeschaltete Streams bleiben jedoch weiterhin stummgeschaltet).

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion wird ein Argument übergeben. error — ein Fehler, der anzeigt, dass der Aufruf fehlgeschlagen ist. Bei erfolgreichem Aufruf wird dieser Wert auf null gesetzt.

forceDisconnect(sessionId, connectionId, callback)

Trennt einen Teilnehmer von einer OpenTok-Sitzung. Dies ist das serverseitige Äquivalent zu dem Die Methode `forceDisconnect()` in OpenTok.js

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der OpenTok-Sitzung, mit der der Client verbunden ist, dessen Verbindung Sie trennen möchten.
connectionId Die Verbindungs-ID des Clients, dessen Verbindung Sie trennen möchten.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt).

forceMuteAll(sessionId, opts, callback)

Zwingt alle Streams (mit Ausnahme eines optionalen Arrays von Streams) in einer Sitzung dazu, das veröffentlichte Audio stummzuschalten.

Zusätzlich zu den bereits bestehenden Streams werden alle Streams, die nach dem Aufruf dieser Methode veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltungsstatus einer Sitzung aufheben, indem Sie die Methode OpenTok.disableForceMute() Methode.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID.
opts Ein Objekt, das die folgenden Eigenschaften enthält: - excudedStreamIds (Zeichenfolgen-Array) — Ein Array mit Stream-IDs, die von der Stummschaltung ausgenommen werden sollen. Dies ist optional. Wenn Sie diese Eigenschaft nicht festlegen, werden alle Arrays in der Sitzung stummgeschaltet.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion wird ein Argument übergeben. error — ein Fehler, der anzeigt, dass der Aufruf fehlgeschlagen ist. Bei erfolgreichem Aufruf wird dieser Wert auf null gesetzt.

forceMuteStream(sessionId, streamId, callback)

Den Ton eines bestimmten Streams in einer Sitzung stummschalten.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge Die Sitzungs-ID.
streamId Zeichenfolge Die Stream-ID.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion wird ein Argument übergeben. error — ein Fehler, der anzeigt, dass der Aufruf fehlgeschlagen ist. Bei erfolgreichem Aufruf wird dieser Wert auf null gesetzt.

generateToken(sessionId, options, generateT1Token)

Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung. Um einen Benutzer zu authentifizieren, der eine Verbindung zu einer OpenTok-Sitzung herstellt, übermittelt der Client bei der Verbindung zur Sitzung ein Token.

Zu Testzwecken können Sie auch ein Token generieren, indem Sie sich bei Ihrem Vonage Video API-Konto.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird.
options Ein Objekt, das Optionen für das Token definiert (die jeweils optional sind): - role (Zeichenkette) — Die Rolle für das Token. Jede Rolle definiert eine Reihe von Berechtigungen, die dem Token gewährt werden: - 'subscriber' — Ein Abonnent kann nur Streams abonnieren. - 'publisher' — Ein Publisher kann Streams veröffentlichen, Streams abonnieren und Signale senden. (Dies ist der Standardwert, wenn Sie keine Rolle angeben.) - 'publisheronly' — Ein Publisher kann lediglich Streams veröffentlichen, Streams jedoch nicht abonnieren. - 'moderator' — Zusätzlich zu den einem Publisher gewährten Berechtigungen kann ein Moderator Moderationsaufgaben wahrnehmen, beispielsweise Clients zwingen, die Verbindung zu trennen, die Veröffentlichung von Streams zu beenden oder den Ton in veröffentlichten Streams stummzuschalten. Siehe die Leitfaden für Moderatoren. - expireTime (Zahl) — Die Ablaufzeit des Tokens in Sekunden seit der UNIX-Epoche. Die maximale Ablaufzeit beträgt 30 Tage nach dem Erstellungszeitpunkt. Wird eine Bruchzahl angegeben, wird diese auf die nächste ganze Zahl abgerundet. Die Standard-Ablaufzeit beträgt 24 Stunden nach dem Erstellungszeitpunkt des Tokens. - data (Zeichenkette) — Eine Zeichenkette mit Verbindungsmetadaten, die den Endbenutzer beschreiben. Sie können beispielsweise die Benutzer-ID, den Namen oder andere Daten übermitteln, die den Endbenutzer beschreiben. Die Länge der Zeichenkette ist auf 1000 Zeichen begrenzt. Diese Daten können nach ihrer Festlegung nicht mehr aktualisiert werden. - initialLayoutClassList (Array) — Ein Array mit Klassennamen (Zeichenketten), die als anfängliche Layout-Klassen für die vom Client veröffentlichten Streams verwendet werden sollen. Layout-Klassen werden zur Anpassung des Layouts von Videos in Live-Streaming-Übertragungen und zusammengestellte Archive.
generateT1Token Verbindungstoken sind nun mit SHA-256 signierte JWTs. Setzen Sie dies auf true um ein Token im alten T1-Format zu erstellen.
Rückgabe:

Die Token-Zeichenkette.

getArchive(archiveId, callback)

Ruft einen Archiv Objekt für die angegebene Archiv-ID.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - archive - Die Archiv Objekt.

getBroadcast(broadcastId, callback)

Gibt Informationen zu einer Live-Streaming-Übertragung zurück.

Parameter:
Name Typ Beschreibung
broadcastId Zeichenfolge Die ID der Übertragung.
callback Funktion Eine Callback-Methode, die zwei Parameter entgegennimmt: error, das im Fehlerfall auf ein Error-Objekt gesetzt wird, und broadcast, das auf einen Sendung Objekt bei Erfolg.

getRender(renderId, callback)

Ruft einen Rendering Objekt für die angegebene Render-ID.

Parameter:
Name Typ Beschreibung
renderId Zeichenfolge Die Render-ID.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - render - Die Rendering Objekt.

getStream(sessionId, options, callback)

Ruft Informationen zu einem Stream ab. Der Stream muss ein aktiver Stream in einer OpenTok-Sitzung sein.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge Die Sitzungs-ID der OpenTok-Sitzung, die den Stream enthält.
options Zeichenfolge Die Stream-ID.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). Dieses wird auf null gesetzt, wenn kein Fehler vorliegt. Der Aufruf dieser Methode führt zu einem Fehler, wenn Sie eine ungültige Stream-ID oder eine ungültige Sitzungs-ID übergeben. - stream - Die Stream Objekt. Dieses Objekt enthält Eigenschaften, die den Stream definieren. Bei einem Fehler ist dieser Wert nicht definiert.

listArchives(Optionen, Callback)

Ruft eine Liste von ab Archiv Objekte, die sowohl abgeschlossene als auch laufende Archive darstellen, für Ihren API-Schlüssel.

Parameter:
Name Typ Beschreibung
options Objekt Ein Optionsparameter mit drei Eigenschaften: - count — Die maximale Anzahl der zurückzugebenden Archive. Standardmäßig werden 50 Archive zurückgegeben (oder weniger, falls weniger als 50 Archive vorhanden sind). Die Methode gibt maximal 1000 Archive zurück. - offset — Der Offset für das erste aufzulistende Archiv (beginnend mit dem ersten Archiv, das als Offset 0 erfasst wurde). 1 ist der Offset des Archivs, das vor dem jüngsten Archiv begonnen hat. Diese Eigenschaft ist optional; der Standardwert ist 0. - sessionId — Geben Sie die ID einer Sitzung an, um speziell die Archive dieser Sitzung abzurufen. Diese Eigenschaft ist optional. Wenn keine Sitzungs-ID angegeben wird, gibt die Methode Archive aus allen Sitzungen zurück, die mit Ihrem API-Schlüssel erstellt wurden. Wenn Sie keine options Argument: Die Methode gibt bis zu 1000 Archive zurück, beginnend mit dem ersten erfassten Archiv.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - archives - Eine Reihe von Archiv Objekte.

listBroadcasts(Optionen, Callback)

Ruft eine Liste von ab Sendung Objekte, die sowohl abgeschlossene als auch laufende Übertragungen für Ihren API-Schlüssel darstellen.

Parameter:
Name Typ Beschreibung
options Objekt Ein Optionsparameter mit drei Eigenschaften: - count — Die maximale Anzahl der zurückzugebenden Broadcasts. Standardmäßig werden 50 Broadcasts zurückgegeben (oder weniger, falls weniger als 50 Broadcasts vorhanden sind). Die Methode gibt maximal 1000 Broadcasts zurück. - offset — Der Offset für die erste in der Liste aufgeführte Sendung (beginnend mit der ersten aufgezeichneten Sendung, deren Offset 0 ist). 1 ist der Offset der Sendung, die vor der letzten Sendung begonnen hat. Diese Eigenschaft ist optional; der Standardwert ist 0. - sessionId — Geben Sie die ID einer Sitzung an, um speziell die Broadcasts für diese Sitzung abzurufen. Diese Eigenschaft ist optional. Wenn keine Sitzungs-ID angegeben wird, gibt die Methode die Broadcasts aller Sitzungen zurück, die mit Ihrem API-Schlüssel erstellt wurden. Wenn Sie keine options Argument: Die Methode gibt bis zu 1000 Sendungen zurück, beginnend mit der ersten aufgezeichneten Sendung.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - broadcasts - Eine Reihe von Sendung Objekte.

listRenders(Optionen, Callback)

Ruft eine Liste von ab Rendering Objekte, die alle Renderings im Status „startend“, „gestartet“, „gestoppt“ oder „fehlgeschlagen“ für Ihren API-Schlüssel darstellen.

Parameter:
Name Typ Beschreibung
options Objekt Ein Optionsparameter mit drei Eigenschaften: - count — Die maximale Anzahl der zurückzugebenden Renderings. Standardmäßig werden 50 Renderings zurückgegeben (oder weniger, falls weniger als 50 Renderings vorhanden sind). Die Methode gibt maximal 1000 Renderings zurück. - offset — Der Offset für den ersten in der Liste aufgeführten Render-Durchlauf (beginnend mit dem ersten aufgezeichneten Render-Durchlauf, der als Offset 0 gilt). 1 ist der Offset des Render-Durchlaufs, der vor dem letzten Render-Durchlauf begonnen hat. Diese Eigenschaft ist optional; der Standardwert ist 0. - sessionId — Geben Sie die ID einer Sitzung an, um Renderings speziell für diese Sitzung abzurufen. Diese Eigenschaft ist optional. Wenn keine Sitzungs-ID angegeben wird, gibt die Methode Renderings aus allen Sitzungen zurück, die mit Ihrem API-Schlüssel erstellt wurden. Wenn Sie keine options Argument gibt die Methode bis zu 1000 Renderergebnisse zurück, beginnend mit dem ersten aufgezeichneten Renderergebnis.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - renders - Eine Reihe von Rendering Objekte.

listStreams(sessionId, callback)

Ruft eine Liste von ab Stream Objekte, die aktuelle Streams in einer Sitzung darstellen.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge Die Sitzungs-ID der OpenTok-Sitzung, die die Streams enthält.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). Dieses wird auf null gesetzt, wenn kein Fehler vorliegt. Der Aufruf dieser Methode führt zu einem Fehler, wenn Sie eine ungültige Sitzungs-ID übergeben. - streams - Eine Reihe von Stream Objekte. Jedes Stream-Objekt enthält Eigenschaften, die den Stream definieren. Bei einem Fehler ist dieser Wert nicht definiert.

playDTMF(sessionId, connectionId, digits, callback)

DTMF-Ziffern an alle Teilnehmer einer aktiven OpenTok-Sitzung oder an einen bestimmten Client senden, der mit dieser Sitzung verbunden ist.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der Sitzung, die die DTMF-Zeichenfolge empfangen wird.
connectionId Die Verbindungs-ID des Clients, an den Sie das DTMF-Signal senden möchten. Lassen Sie dieses Feld leer, um ein DTMF-Signal an alle mit der Sitzung verbundenen Clients zu senden.
digits Dies ist die zu sendende Folge von DTMF-Ziffern. Sie kann die Ziffern 0–9 sowie die Zeichen „*“, „#“ und „p“ enthalten. Ein „p“ steht für eine Pause von 500 ms (falls Sie beim Senden der Ziffern eine Verzögerung einfügen möchten).
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion wird ein Argument übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). Dieses wird auf null gesetzt, wenn kein Fehler vorliegt.

removeArchiveStream(archiveId, streamId, callback)

Entfernt einen Stream aus einem zusammengesetzten Archiv, bei dem der „streamMode“ auf „manual“ gesetzt ist.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID.
streamId Zeichenfolge Die Stream-ID, die aus dem Archiv entfernt werden soll.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei einem Fehlschlag des Aufrufs wird ein Fehler an die Funktion übergeben.

removeBroadcastStream(broadcastId, streamId, callback)

Entfernt einen Stream aus einer Übertragung, bei der der „streamMode“ auf „manual“ gesetzt ist.

Parameter:
Name Typ Beschreibung
broadcastId Zeichenfolge Die Sendungs-ID.
streamId Zeichenfolge Die Stream-ID, die aus der Übertragung entfernt werden soll.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei einem Fehlschlag des Aufrufs wird ein Fehler an die Funktion übergeben.

setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback)

Legt den Layouttyp für ein zusammengesetztes Archiv fest. Eine Beschreibung der Layouttypen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID.
type Zeichenfolge Der Layouttyp. Legen Sie diesen Wert auf „bestFit“, „pip“, „verticalPresentation“, „horizontalPresentation“, „focus“ oder „custom“ fest. Eine Beschreibung dieser Layouttypen finden Sie unter Anpassen des Videolayouts für zusammengestellte Archive.
stylesheet Zeichenfolge (Optional) Das Stylesheet für ein benutzerdefiniertes Layout. Legen Sie diesen Parameter fest, wenn Sie type zu "custom". Andernfalls lassen Sie den Wert undefiniert oder setzen Sie ihn auf null.
screenshareType Zeichenfolge (Optional) Der Layouttyp, der verwendet werden soll, wenn in der Sitzung ein Bildschirmfreigabestream vorhanden ist. Beachten Sie, dass Sie zur Verwendung dieses Parameters die type Parameter auf „bestFit“ setzen und die stylesheet Parameter zu null.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei einem Fehler wird ein error Das Objekt wird an die Funktion übergeben. Bei erfolgreichem Abschluss wird die Funktion aufgerufen, ohne dass ein Fehlerobjekt übergeben wird.

setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback)

Legt das Layout der Sendung fest (oder aktualisiert es). Siehe Konfiguration des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Parameter:
Name Typ Beschreibung
broadcastId Zeichenfolge Die ID der Übertragung.
type Zeichenfolge Der Layouttyp. Legen Sie diesen Wert auf „bestFit“, „pip“, „verticalPresentation“, „horizontalPresentation“, „focus“ oder „custom“ fest. Eine Beschreibung dieser Layouttypen finden Sie unter Konfiguration des Layouts für OpenTok-Live-Streaming-Übertragungen.
stylesheet Zeichenfolge (Optional) Das Stylesheet für ein benutzerdefiniertes Layout. Legen Sie diesen Parameter fest, wenn Sie type auf „custom“. Andernfalls lassen Sie die Einstellung undefiniert oder setzen Sie sie auf null.
screenshareType Zeichenfolge (Optional) Der Layouttyp, der verwendet werden soll, wenn in der Sitzung ein Bildschirmfreigabestream vorhanden ist. Beachten Sie, dass Sie zur Verwendung dieses Parameters die type Parameter auf „bestFit“ setzen und die stylesheet Parameter zu null.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Im Fehlerfall wird ein Error-Objekt an die Funktion übergeben. Bei erfolgreichem Abschluss wird die Funktion ohne Übergabe eines Error-Objekts aufgerufen.

setStreamClassLists(sessionId, classListArray, callback)

Legt die Liste der Layoutklassen für Streams in einer Sitzung fest. Layoutklassen werden im Layout für zusammengesetzte Archive und Live-Streaming-Übertragungen verwendet. Weitere Informationen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive und Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Sie können die anfängliche Liste der Layout-Klassen für von einem Client veröffentlichte Streams festlegen, wenn Sie die vom Client verwendeten Streams generieren. Weitere Informationen finden Sie unter OpenTok.generateToken() Methode.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge Die Sitzungs-ID der Sitzung, zu der die Streams gehören.
classListArray Array (Optional) Ein Array, das die Klassenlisten definiert, die auf Streams angewendet werden sollen. Jedes Element des Arrays ist ein Objekt mit zwei Eigenschaften: id und layoutClassList. Die id Die Eigenschaft ist die Stream-ID (ein String), und die layoutClassList ist ein Array mit Klassennamen (Strings), die auf den Stream angewendet werden sollen. Setze layoutClassList auf ein leeres Array, um die Liste der Layout-Klassen für einen Stream zu löschen. Zum Beispiel: streamClassArray array legt die Liste der Layout-Klassen für drei Streams fest: const classListArray = [ { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] }, { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] }, { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] } ];
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei einem Fehler wird ein error Das Objekt wird an die Funktion übergeben. Bei erfolgreichem Abschluss wird die Funktion aufgerufen, ohne dass ein Fehlerobjekt übergeben wird.

signal(sessionId, connectionId, payload, callback)

Sendet ein Signal an alle Verbindungen einer Sitzung oder an eine bestimmte Verbindung.

Die Clients müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie erfolgreich ein Signal an sie senden können.

Weitere Informationen finden Sie in der OpenTok-Signalisierung Programmübersicht.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der OpenTok-Sitzung, an die Sie das Signal senden möchten.
connectionId Die Verbindungs-ID eines mit der Sitzung verbundenen Clients. Lassen Sie dieses Feld leer, wenn Sie ein Signal an alle Verbindungen in der Sitzung senden möchten.
payload Ein Objekt mit optionalen data und type Eigenschaften: - data — Die zu sendenden Daten. Die maximale Länge der Datenzeichenfolge beträgt 8 kB. Setzen Sie die Datenzeichenfolge nicht auf „null“ oder „undefined“. - type — Der Typ des Signals. Clients können anhand des Typs Signale filtern. Die maximale Länge der Typ-Zeichenkette beträgt 128 Zeichen.
callback Funktion Die Callback-Funktion, die aufgerufen wird, wenn der Aufruf der Methode erfolgreich ist oder fehlschlägt. Wenn der Aufruf fehlschlägt, wird ein Fehlerobjekt an die Callback-Funktion übergeben.

startArchive(sessionId, options, callback)

Beginnt mit der Archivierung einer OpenTok-Sitzung.

Die Teilnehmer müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie erfolgreich mit der Aufzeichnung eines Archivs beginnen können.

Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den OpenTok Media Router verwenden (Sitzungen, bei denen der Medienmodus auf „routed“ eingestellt ist); Sitzungen, bei denen der Medienmodus auf „relayed“ eingestellt ist, können nicht archiviert werden.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung.
options Objekt Ein optionales Optionsobjekt mit den folgenden Eigenschaften (die jeweils optional sind): - name (Zeichenkette) – Der Name des Archivs, anhand dessen Sie das Archiv identifizieren können. Der Name wird als Eigenschaft des „Archive“-Objekts festgelegt und ist eine Eigenschaft von archivbezogenen Ereignissen in den OpenTok-Client-Bibliotheken. - hasAudio (Boolesch) — Gibt an, ob das Archiv eine Audiospur enthalten soll (true) oder nicht (false). Der Standardwert ist true (eine Audiospur ist enthalten). Wenn Sie beides einstellen hasAudio und hasVideo zu false, der Aufruf an die startArchive() Die Methode führt zu einem Fehler. - hasVideo (Boolescher Wert) — Gibt an, ob das Archiv eine Videospur enthalten soll (true) oder (nicht false). Der Standardwert ist true (eine Videospur ist enthalten). Wenn Sie beides einstellen hasAudio und hasVideo zu false, der Aufruf an die startArchive() Die Methode führt zu einem Fehler. - outputMode (Zeichenkette) — Gibt an, ob alle Streams im Archiv in einer einzigen Datei gespeichert werden („composed“, Standardeinstellung) oder in einzelnen Dateien („individual“). - layout (Objekt) — Ein Objekt, das die anfänglichen Layout-Optionen für ein zusammengesetztes Archiv definiert. Dieses Objekt verfügt über drei Eigenschaften: type, stylesheetund screenshareType, die jeweils Zeichenfolgen sind. Set type auf „bestFit“, „pip“, „verticalPresentation“, „horizontalPresentation“ oder „custom“. Legen Sie die stylesheet Eigenschaft, wenn type ist auf „custom“ eingestellt, und stellen Sie es auf das Stylesheet ein, das das benutzerdefinierte Layout definiert. Stellen Sie beispielsweise das layout Objekt zu { type: "pip" } um das anfängliche Layout des Archivs auf „Bild-in-Bild“ festzulegen. Stellen Sie die screenshareType Eigenschaft für den Layouttyp, der verwendet werden soll, wenn in der Sitzung ein Bildschirmfreigabe-Stream vorliegt (Diese Eigenschaft ist optional.) Hinweis: Wenn Sie die screenshareType Eigenschaft, müssen Sie die type Eigenschaft auf „bestFit“ setzen und die stylesheet Eigenschaft nicht festgelegt. Weitere Informationen finden Sie unter Anpassen des Video-Layouts für zusammengestellte Archive. - resolution (Zeichenkette) — Bei einem zusammengesetzten Archiv setzen Sie diesen Wert auf die Auflösung des Archivs. Gültige Werte sind „1920x1080“, „1280x720“ oder „640x480“ (Standardwert). - streamMode (optional) — Der Stream-Modus für das Archiv. Hierfür stehen folgende Optionen zur Auswahl: - „auto“ — Die im Archiv enthaltenen Streams werden automatisch ausgewählt (Standardeinstellung). - „manual“ — Geben Sie die einzubeziehenden Streams anhand von Aufrufen der Methode OpenTok.addArchiveStream() an und OpenTok.removeArchiveStream() Methoden. - multiArchiveTag (Zeichenkette) — Setzen Sie diese Option, um die gleichzeitige Aufzeichnung mehrerer Archive für dieselbe Sitzung zu unterstützen. Legen Sie hierfür für jedes gleichzeitig erstellte Archiv einer laufenden Sitzung eine eindeutige Zeichenkette fest. Sie müssen diese Option außerdem setzen, wenn Sie ein Archiv, das automatisch archiviert wird, manuell starten. Beachten Sie, dass die multiArchiveTag Der Wert ist in der Antwort der Methoden zum Auflisten von Archiven und zum Abrufen von Archivinformationen nicht enthalten. Wenn Sie keinen eindeutigen Wert angeben, multiArchiveTag In einer bestimmten Sitzung kann jeweils nur ein Archiv aufgezeichnet werden. - maxBitrate (Zahl) — Die maximale Video-Bitrate für das Archiv, in Bit pro Sekunde. Diese Option gilt nur für zusammengesetzte Archive. Legen Sie die maximale Videobitrate fest, um die Größe des zusammengesetzten Archivs zu steuern. Diese maximale Bitrate gilt ausschließlich für die Videobitrate. Wenn das Ausgabearchiv Audio enthält, werden diese Bits nicht auf das Limit angerechnet. Weitere Informationen zum Archivieren und zu den Archivdateiformaten finden Sie unter OpenTok-Archivierung Programmieranleitung.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - archive - Die Archiv Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.

startBroadcast(sessionId, options, callback)

Startet eine Live-Streaming-Übertragung. Siehe die Live- Streaming-Übertragung Leitfaden für Entwickler.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge Die ID der Sitzung, die übertragen werden soll.
options Objekt Ein Objekt mit folgender Form: { outputs: { hls: { dvr: false, lowLatency: false, }, rtmp: [{ id: "foo", serverUrl: "rtmp://myfooserver/myfooapp", streamName: "myfoostream" }, { id: "bar", serverUrl: "rtmp://mybarserver/mybarapp", streamName: "mybarstream" }] }, maxDuration: 5400, resolution: "640x480", layout: { type: "custom", stylesheet: "the layout stylesheet (only used with type == custom)", screenshareType: "the layout type to use when there is a screen-sharing stream (optional)" }, streamMode: "manual" } Die options Das Objekt enthält die folgenden Eigenschaften: - outputs (erforderlich) — Dieses Objekt definiert die Arten von Broadcast-Streams, die Sie starten möchten. Sie können HLS, RTMP oder beides als Broadcast-Streams einbinden. Wenn Sie RTMP-Streaming einbinden, können Sie bis zu fünf Ziel-RTMP-Streams (oder nur einen) angeben. Für HLS fügen Sie einen einzelnen hls Eigenschaft im Objekt „outputs“. Dieses Objekt enthält die folgenden optionalen Eigenschaften: - dvr (Boolesch) — Ob aktiviert werden soll DVR-Funktionalität — Zurückspulen, Anhalten und Fortsetzen — in Abspielprogrammen, die diese Funktionen unterstützen (true), oder nicht (false(Standard). Bei aktiviertem DVR enthält die HLS-URL einen ?DVR Abfragezeichenfolge am Ende angehängt. - lowLatency (Boolesch) — Ob aktiviert werden soll Low-Latency-Modus für den HLS-Stream. Einige HLS-Player unterstützen den Low-Latency-Modus nicht. Diese Funktion ist nicht kompatibel mit HLS-Übertragungen im DVR-Modus. Die HLS-URL wird in der broadcastUrls als die hls Immobilie in der Sendung Objekt, das an die Callback-Methoden der OpenTok#getBroadcast sowie die OpenTok#listBroadcast-Methoden. Geben Sie für jeden RTMP-Stream Folgendes an: serverUrl (die URL des RTMP-Servers), streamName (den Stream-Namen, z. B. den Namen des YouTube-Live-Streams oder den Facebook-Stream-Schlüssel) sowie (optional) id (eine eindeutige ID für den Stream). Wenn Sie eine ID angeben, wird diese als id Eigenschaft des Sendung Objekt, das an die Callback-Methoden der startBroadcast() Methode und die OpenTok.getBroadcast() Methode. OpenTok überträgt die Sitzung an jede von Ihnen angegebene RTMP-URL. Beachten Sie, dass OpenTok-Live-Streaming RTMP und RTMPS unterstützt. - maxDuration (optional) — Die maximale Dauer der Übertragung in Sekunden. Die Übertragung wird automatisch beendet, sobald die maximale Dauer erreicht ist. Sie können die maximale Dauer auf einen Wert zwischen 60 (60 Sekunden) und 36.000 (10 Stunden) festlegen. Die standardmäßige maximale Dauer beträgt 4 Stunden (14.400 Sekunden). - resolution (optional) — Die Auflösung der Übertragung: entweder "640x480" (SD, Standard), "1280x720" (HD) oder "1920x1080" (FHD). layout (optional) — Geben Sie dies an, um den anfänglichen Layouttyp für die Übertragung festzulegen. Dieses Objekt verfügt über drei Eigenschaften: type, stylesheetund screenshareType, die jeweils Zeichenfolgen sind. Gültige Werte für die type Eigenschaften sind "bestFit" (beste Anpassung), "custom" (Gewohnheit), "horizontalPresentation" (horizontale Darstellung), "pip" (Bild-in-Bild), und "verticalPresentation" (vertikale Darstellung)). Wenn Sie einen "custom" Layout-Typ, setzen Sie die stylesheet Eigenschaft der layout dem Stylesheet hinzufügen. (Bei anderen Layouttypen darf kein stylesheet Eigenschaft.) Wenn Sie keinen anfänglichen Layouttyp angeben, verwendet der Broadcast-Stream den Layouttyp „Best Fit“. Legen Sie den screenshareType Eigenschaft für den Layout-Typ, der verwendet werden soll, wenn in der Sitzung ein Bildschirmfreigabe-Stream vorliegt. (Diese Eigenschaft ist optional.) Hinweis: Wenn Sie die screenshareType Eigenschaft, müssen Sie die type Eigenschaft auf "bestFit" und lassen Sie die stylesheet Eigenschaft nicht gesetzt. Für weitere Informationen, siehe Konfiguration des Video-Layouts für OpenTok-Live-Streaming-Übertragungen).- streamMode (optional) — Der Stream-Modus für die Übertragung. Hierfür stehen folgende Optionen zur Auswahl: - „auto“ — Die in die Übertragung einzubeziehenden Streams werden automatisch ausgewählt (Standardeinstellung). - „manual“ — Die einzubeziehenden Streams werden anhand von Aufrufen der OpenTok.addBroadcastStream() und OpenTok.removeBroadcastStream() Methoden. - multiBroadcastTag (optional) — Setzen Sie diesen Wert, um mehrere gleichzeitige Übertragungen für dieselbe Sitzung zu unterstützen. Verwenden Sie für jede gleichzeitige Übertragung einer laufenden Sitzung eine eindeutige Zeichenfolge. Beachten Sie, dass die multiBroadcastTag Der Wert ist in der Antwort nicht enthalten, wenn die Methoden zum Auflisten von Live-Streaming-Übertragungen und zum Abrufen von Informationen zu einer Live-Streaming-Übertragung aufgerufen werden.
callback Funktion Eine Callback-Methode, die zwei Parameter entgegennimmt: error, das im Fehlerfall auf ein Error-Objekt gesetzt wird, und broadcast, das auf einen Sendung Objekt bei Erfolg.

startCaptions(sessionId, token, options, callback)

Startet die Live-Untertitel für eine OpenTok-Sitzung.

Die maximal zulässige Dauer beträgt 4 Stunden; danach wird die Audio-Untertitelung beendet, ohne dass dies Auswirkungen auf die laufende OpenTok-Sitzung hat. Ein Ereignis wird an Ihre Callback-URL gesendet, sofern diese beim Start der Untertitelung angegeben wurde.

Jede OpenTok-Sitzung unterstützt nur eine Audio-Untertitelungssitzung.

Parameter:
Name Typ Beschreibung
sessionId Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung.
token Ein gültiges OpenTok-Token, dessen Rolle auf „Moderator“ gesetzt ist.
options Objekt Ein optionales Optionsobjekt mit den folgenden Eigenschaften (die jeweils optional sind): - languageCode (Zeichenkette) — Der BCP-47-Code für eine gesprochene Sprache, die bei diesem Anruf verwendet wird. Der Standardwert ist „en-US“. Die folgenden Sprachcodes werden unterstützt: „en-AU“ (Englisch, Australien), „en-GB“ (Englisch, Großbritannien), „en-us“ (Englisch, USA), „es-US“ (Spanisch, USA), „zh-CN“ (Chinesisch, vereinfacht), „fr-FR“ (Französisch), „fr-CA“ (Französisch, Kanada), „de-DE“ (Deutsch), „hi-IN“ (Hindi, Indien), „it-IT“ (Italienisch), „ja-JP“ (Japanisch), „ko-KR“ (Koreanisch), „pt-BR“ (Portugiesisch, brasilianisch), „th-TH“ (Thailändisch). – maxDuration (Ganzzahl) — Die maximale Dauer der Audio-Untertitelung in Sekunden. Der Standardwert beträgt 14.400 Sekunden (4 Stunden) – dies ist die maximal zulässige Dauer. Der Mindestwert für „maxDuration“ beträgt 300 (300 Sekunden bzw. 5 Minuten). - partialCaptions (Boolescher Wert) — Gibt an, ob diese Option aktiviert werden soll, um die Untertitelung zu beschleunigen, wobei jedoch gewisse Ungenauigkeiten in Kauf genommen werden müssen. Der Standardwert ist „true“. Weitere Informationen zu Untertiteln finden Sie unter OpenTok-Untertitel Programmieranleitung.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - captionID — Die ID der Bildunterschriften

startCaptions(captionId, callback)

Deaktiviert die Live-Untertitel für eine OpenTok-Sitzung

Parameter:
Name Typ Beschreibung
captionId Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung. Weitere Informationen zu Untertiteln finden Sie unter OpenTok-Untertitel Programmieranleitung.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - success — Stimmt immer

startRender(Optionen, Callback)

Startet einen Experience Composer für eine OpenTok-Sitzung. Die Experience Composer- Instanz wird als Render-Objekt dargestellt. Weitere Informationen finden Sie unter Entwicklerhandbuch zu Experience Composer.

Die Clients müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie die Wiedergabe einer Sitzung erfolgreich starten können.

Parameter:
Name Typ Beschreibung
options Objekt Ein optionales Optionsobjekt mit den folgenden Eigenschaften (die jeweils optional sind): - sessionId (Zeichenkette) — Die ID einer Sitzung (generiert mit derselben APIKEY(wie in der URL angegeben), in die Sie die Darstellung starten möchten – token (Zeichenkette) — Ein gültiges OpenTok-Token mit der Rolle „Publisher“ und (optional) Verbindungsdaten, die dem Ausgabestream zugeordnet werden sollen. - url (Zeichenkette) — Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und die den darzustellenden Inhalt ohne Benutzereingriff generieren kann. - properties (Objekt) — Erstkonfiguration der Publisher-Eigenschaften für den zusammengesetzten Ausgabestrom. - maxDuration (Zahl) — Die maximal zulässige Dauer für den Rendervorgang in Sekunden. Nach Ablauf dieser Zeit wird der Rendervorgang automatisch beendet, sofern er noch läuft. - resolution (Zeichenkette) — Auflösung des Anzeigebereichs für die Komposition.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - render - Die Rendering Objekt. Dieses Objekt enthält Eigenschaften, die die Darstellung definieren, einschließlich der Darstellungs-ID.

stopArchive(archiveId, callback)

Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.

Die Aufzeichnung von Archiven wird automatisch nach 120 Minuten beendet oder sobald sich alle Teilnehmer aus der archivierten Sitzung abgemeldet haben.

Ein Archiv, das gerade nicht aufgezeichnet wird, kann nicht angehalten werden.

Parameter:
Name Typ Beschreibung
archiveId Zeichenfolge Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - archive - Die Archiv Objekt.
Rückgabe:

Die Archiv Objekt, das dem Archiv entspricht, das angehalten wird.

stopBroadcast(broadcastId, callback)

Beendet eine Live-Streaming-Übertragung.

Parameter:
Name Typ Beschreibung
broadcastId Zeichenfolge Die ID der Übertragung.
callback Funktion Eine Callback-Methode, die zwei Parameter entgegennimmt: error, das im Fehlerfall auf ein Error-Objekt gesetzt wird, und broadcast, das auf einen Sendung Objekt bei Erfolg.

stopRender(renderId, callback)

Beendet einen Experience Composer, der gerade gerendert wird.

Parameter:
Name Typ Beschreibung
renderId Zeichenfolge Die ID des Renderings, dessen Ausführung Sie beenden möchten.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - render - Die Rendering Objekt.
Rückgabe:

Die Archiv Objekt, das dem Archiv entspricht, das angehalten wird.

websocketConnect(sessionId, token, websocketUri, options, callback)

Leitet Audio aus einer Vonage Video API-Sitzung an einen WebSocket weiter. Siehe die Audio-Anschluss Leitfaden für Entwickler.

Parameter:
Name Typ Beschreibung
sessionId Zeichenfolge (erforderlich) Die OpenTok-Sitzungs-ID, die die OpenTok-Streams enthält, die Sie in den WebSocket-Stream einbinden möchten
token Zeichenfolge (erforderlich) Das OpenTok-Token, das für die Verbindung des Audio-Streamers zur OpenTok-Sitzung verwendet werden soll. Sie können Token-Daten hinzufügen, um zu kennzeichnen, dass es sich bei der Verbindung um den Audio-Streamer-Endpunkt handelt, oder um andere identifizierende Daten anzugeben.
websocketUri Zeichenfolge (erforderlich) Eine öffentlich erreichbare WebSocket-URI, die als Ziel für den Audiostream verwendet werden soll (z. B. „wss://service.com/ws-endpoint“).
options Objekt Ein optionales Optionsobjekt mit den folgenden Eigenschaften (die alle optional sind): - streams (Array) — Ein Array mit den Stream-IDs der OpenTok-Streams, die Sie in den WebSocket-Stream einbinden möchten. Wenn Sie diese Eigenschaft weglassen, werden alle Streams der Sitzung einbezogen. - headers (Objekt) — Ein Objekt, das aus Schlüssel-Wert-Paaren von Headern besteht, die mit jeder Nachricht an Ihren WebSocket-Server gesendet werden sollen; die maximale Länge beträgt 512 Byte.
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Bei einem Fehler wird ein error Das Objekt wird als erster Parameter der Funktion übergeben. Bei erfolgreichem Ablauf wird die Funktion ohne Übergabe eines Fehlerobjekts (als erster Parameter) aufgerufen, und der zweite Parameter ist ein Objekt mit den folgenden Eigenschaften: - id -- Eine eindeutige ID, die die WebSocket-Verbindung des Audio-Streamers identifiziert. - connectionId -- Die OpenTok-Verbindungs-ID für die WebSocket-Verbindung des Audio-Streamers in der OpenTok-Sitzung.