Enthält Methoden zum Erstellen von Vonage Video API-Sitzungen, zum Generieren von Tokens und zum Arbeiten mit Archiven. Mehr...

Ausführliche Beschreibung

Enthält Methoden zum Erstellen von Vonage Video API-Sitzungen, zum Generieren von Tokens und zum Arbeiten mit Archiven.

So erstellen Sie ein neues OpenTok Objekt, rufen Sie die OpenTok() Konstruktor mit Ihrem Vonage Video API-Schlüssel und dem API-Geheimnis für Ihre OpenTok-Projekt. Geben Sie Ihren API-Schlüssel nicht öffentlich weiter. Sie werden ihn mit der OpenTok Konstruktor (nur auf Ihrem Webserver), um Vonage Video API-Sitzungen zu erstellen.

Dokumentation zu Konstruktoren und Destruktoren

OpenTok() [1/2]

Erzeugt eine OpenTok Objekt.

Parameter : | | | | --- | --- | | apiKey | Ihr Vonage Video API-Schlüssel. (Siehe die TokBox-Account-Seite | | apiSecret | Ihr Vonage Video API-Schlüssel. (Siehe die TokBox-Account-Seite |

OpenTok() [2/2]

Für den internen Gebrauch bei TokBox.

Parameter : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |

Dokumentation zu Member-Funktionen

AddStreamToArchive()

Fügt einem aktuell laufenden zusammengesetzten Archiv, das mit dem Befehl streamMode eingestellt auf StreamMode.Manual. 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 : | | | | --- | --- | | archiveId | Die Archiv-ID. | | streamId | Die Stream-ID. | | hasAudio | Gibt an, ob das zusammengesetzte Archiv den Ton des Streams enthalten soll (true, Standard) oder nicht (false). | | hasVideo | Gibt an, ob das zusammengesetzte Archiv das Video des Streams enthalten soll (true, Standard) oder nicht (false). |

AddStreamToArchiveAsync()

Fügt einem aktuell laufenden zusammengesetzten Archiv, das mit dem Befehl streamMode eingestellt auf StreamMode.Manual. 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 : | | | | --- | --- | | archiveId | Die Archiv-ID. | | streamId | Die Stream-ID. | | hasAudio | Gibt an, ob das zusammengesetzte Archiv den Ton des Streams enthalten soll (true, Standard) oder nicht (false). | | hasVideo | Gibt an, ob das zusammengesetzte Archiv das Video des Streams enthalten soll (true, Standard) oder nicht (false). |

AddStreamToBroadcast()

Fügt einem aktuell laufenden Stream, der mit dem Befehl streamMode eingestellt auf StreamMode.Manual. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams in der Sendung ein- bzw. auszuschalten.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID. | | streamId | Die Stream-ID. | | hasAudio | Gibt an, ob der Broadcast den Ton des Streams enthalten soll (true, Standard) oder nicht (false). | | hasVideo | Gibt an, ob die Übertragung das Video des Streams enthalten soll (true, Standard) oder nicht (false). |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

AddStreamToBroadcastAsync()

Fügt einem aktuell laufenden Stream, der mit dem Befehl streamMode eingestellt auf StreamMode.Manual. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams in der Sendung ein- bzw. auszuschalten.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID. | | streamId | Die Stream-ID. | | hasAudio | Gibt an, ob der Broadcast den Ton des Streams enthalten soll (true, Standard) oder nicht (false). | | hasVideo | Gibt an, ob die Übertragung das Video des Streams enthalten soll (true, Standard) oder nicht (false). |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

CreateSession()

Erstellt eine neue Vonage Video API-Sitzung.

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

Eine Sitzungs-ID-Zeichenkette kann bis zu 255 Zeichen lang sein.

Der Aufruf dieser Methode führt im Fehlerfall zu einer OpenTokException. Einzelheiten entnehmen Sie bitte der Fehlermeldung.

Sie können eine Sitzung auch mithilfe der OpenTok REST API oder indem Sie sich bei Ihrem TokBox-Account.

Parameter : | | | | --- | --- | | location | Eine IP-Adresse, anhand derer die Vonage Video API-Server die Sitzung in ihrem globalen Netzwerk verorten. Wenn Sie keinen Standorthinweis festlegen, orientieren sich die Vonage Video API-Server am ersten Client, der eine Verbindung zur Sitzung herstellt. | | mediaMode | Gibt an, ob die Sitzung Streams über den Vonage Video API Media Router überträgt (MediaMode.ROUTED) oder nicht (MediaMode.RELAYED). Standardmäßig lautet die Einstellung MediaMode.RELAYED. Wenn der Parameter auf MediaMode.RELAYED, versucht die Sitzung, Streams direkt zwischen den Clients zu übertragen. Wenn Clients aufgrund von Firewall-Einschränkungen keine Verbindung herstellen können, nutzt die Sitzung die OpenTok Den Server für die Weiterleitung von Streams aktivieren. Der OpenTok Media Router bietet folgende Vorteile: - Der Vonage Video API Media Router kann den Bandbreitenverbrauch bei Mehrparteien-Sitzungen senken. (Wenn die mediaMode auf den Parameter MediaMode.ROUTED, muss jeder Client einen separaten Audio-Video-Stream an jeden Client senden, der diesen abonniert.) – Der Vonage Video API Media Router kann die Qualität des Nutzererlebnisses verbessern durch Audio-Fallback und Video-Wiederherstellung Dank dieser Funktionen wird das Video für einen Client unterbrochen (ohne dass andere Clients davon betroffen sind), wenn sich die Verbindung des Clients so weit verschlechtert, dass sie die Wiedergabe eines abonnierten Videostreams nicht mehr unterstützt; der Client empfängt dann nur noch Audio. Sobald sich die Verbindung des Clients wieder verbessert, wird das Video wieder angezeigt. - Der Vonage Video API Media Router unterstützt die Archivierung Funktion, mit der Sie Vonage Video API-Sitzungen aufzeichnen, speichern und abrufen können. | | archiveMode | Gibt an, ob die Sitzung automatisch archiviert wird (ArchiveMode.ALWAYS) oder nicht (ArchiveMode.MANUAL). Standardmäßig lautet die Einstellung ArchiveMode.MANUAL und du musst die StartArchiv Methode der OpenTok Objekt, um mit der Archivierung zu beginnen. Um die Sitzung zu archivieren (entweder automatisch oder manuell), müssen Sie den Parameter „mediaMode“ auf MediaMode.ROUTED | | Verschlüsselung | Aktivieren End-to-End-Medienverschlüsselung in weitergeleiteten Sitzungen. | | archiveName | Name der Archive in automatisch archivierten Sitzungen. Eine Sitzung, die mit dem Archivierungsmodus „always“ beginnt, verwendet diesen Archivnamen für alle Archive dieser Sitzung. Die Übergabe von „archiveName“ bei Verwendung des Archivierungsmodus „manual“ führt zu einer Fehlermeldung. | | archiveResolution | Auflösung der Archive in automatisch archivierten Sitzungen. Eine Sitzung, die mit dem Archivierungsmodus „always“ beginnt, verwendet diese Auflösung für alle Archive dieser Sitzung. Die Übergabe von „archiveResolution“ bei einem Archivierungsmodus von „manual“ führt zu einer Fehlermeldung. |

Rückgaben : A Sitzung Objekt, das die neue Sitzung repräsentiert. Das Session.Id Eigenschaft der Sitzung ist die Sitzungs-ID, die die Sitzung eindeutig identifiziert. Sie verwenden diese Sitzungs-ID in den Client-SDKs, um die Sitzung zu identifizieren. Wenn Sie beispielsweise die OpenTok.js-Bibliothek verwenden, geben Sie die Sitzungs-ID beim Aufruf der OT.initSession() Methode (zum Initialisieren einer Vonage Video API-Sitzung).

CreateSessionAsync()

Erstellt eine neue Vonage Video API-Sitzung.

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

Eine Sitzungs-ID-Zeichenkette kann bis zu 255 Zeichen lang sein.

Der Aufruf dieser Methode führt im Fehlerfall zu einer OpenTokException. Einzelheiten entnehmen Sie bitte der Fehlermeldung.

Sie können eine Sitzung auch mithilfe der OpenTok REST API oder indem Sie sich bei Ihrem TokBox-Account.

Parameter : | | | | --- | --- | | location | Eine IP-Adresse, anhand derer die Vonage Video API-Server die Sitzung in ihrem globalen Netzwerk verorten. Wenn Sie keinen Standorthinweis festlegen, orientieren sich die Vonage Video API-Server am ersten Client, der eine Verbindung zur Sitzung herstellt. | | mediaMode | Gibt an, ob die Sitzung Streams über den Vonage Video API Media Router überträgt (MediaMode.ROUTED) oder nicht (MediaMode.RELAYED). Standardmäßig lautet die Einstellung MediaMode.RELAYED. Wenn der Parameter auf MediaMode.RELAYED, versucht die Sitzung, Streams direkt zwischen den Clients zu übertragen. Wenn Clients aufgrund von Firewall-Einschränkungen keine Verbindung herstellen können, nutzt die Sitzung die OpenTok Den Server für die Weiterleitung von Streams aktivieren. Der OpenTok Media Router bietet folgende Vorteile: - Der Vonage Video API Media Router kann den Bandbreitenverbrauch bei Mehrparteien-Sitzungen senken. (Wenn die mediaMode auf den Parameter MediaMode.ROUTED, muss jeder Client einen separaten Audio-Video-Stream an jeden Client senden, der diesen abonniert.) – Der Vonage Video API Media Router kann die Qualität des Nutzererlebnisses verbessern durch Audio-Fallback und Video-Wiederherstellung Dank dieser Funktionen wird das Video für einen Client unterbrochen (ohne dass andere Clients davon betroffen sind), wenn sich die Verbindung des Clients so weit verschlechtert, dass sie die Wiedergabe eines abonnierten Videostreams nicht mehr unterstützt; der Client empfängt dann nur noch Audio. Sobald sich die Verbindung des Clients wieder verbessert, wird das Video wieder angezeigt. - Der Vonage Video API Media Router unterstützt die Archivierung Funktion, mit der Sie Vonage Video API-Sitzungen aufzeichnen, speichern und abrufen können. | | archiveMode | Gibt an, ob die Sitzung automatisch archiviert wird (ArchiveMode.ALWAYS) oder nicht (ArchiveMode.MANUAL). Standardmäßig lautet die Einstellung ArchiveMode.MANUAL und du musst die StartArchiv Methode der OpenTok Objekt, um mit der Archivierung zu beginnen. Um die Sitzung zu archivieren (entweder automatisch oder manuell), müssen Sie den Parameter „mediaMode“ auf MediaMode.ROUTED | | Verschlüsselung | Aktivieren End-to-End-Medienverschlüsselung in weitergeleiteten Sitzungen. | | archiveName | Name der Archive in automatisch archivierten Sitzungen. Eine Sitzung, die mit dem Archivierungsmodus „always“ beginnt, verwendet diesen Archivnamen für alle Archive dieser Sitzung. Die Übergabe von „archiveName“ bei Verwendung des Archivierungsmodus „manual“ führt zu einer Fehlermeldung. | | archiveResolution | Auflösung der Archive in automatisch archivierten Sitzungen. Eine Sitzung, die mit dem Archivierungsmodus „always“ beginnt, verwendet diese Auflösung für alle Archive dieser Sitzung. Die Übergabe von „archiveResolution“ bei einem Archivierungsmodus von „manual“ führt zu einer Fehlermeldung. |

Rückgaben : A Sitzung Objekt, das die neue Sitzung repräsentiert. Das Session.Id Eigenschaft der Sitzung ist die Sitzungs-ID, die die Sitzung eindeutig identifiziert. Sie verwenden diese Sitzungs-ID in den Client-SDKs, um die Sitzung zu identifizieren. Wenn Sie beispielsweise die OpenTok.js-Bibliothek verwenden, geben Sie die Sitzungs-ID beim Aufruf der OT.initSession() Methode (zum Initialisieren einer Vonage Video API-Sitzung).

DeleteArchive()

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 : | | | | --- | --- | | archiveId | Die Archiv-ID des Archivs, das Sie löschen möchten. |

DeleteArchiveAsync()

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 : | | | | --- | --- | | archiveId | Die Archiv-ID des Archivs, das Sie löschen möchten. |

Dial()

Stellt eine Verbindung zwischen einer SIP-Plattform und einer Vonage Video API-Sitzung her.

Weitere Informationen, einschließlich technischer Details und Sicherheitsaspekte, finden Sie in der OpenTok SIP-Interconnect-Entwicklerhandbuch.

Parameter : | | | | --- | --- | | 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 als Ziel des von OpenTok an Ihre SIP-Plattform. Wenn die SIP-URI einen ​transport=tls​-Header enthält, erfolgt die Aushandlung zwischen OpenTok und die Verbindung zum SIP-Endpunkt wird sicher hergestellt. Beachten Sie, dass dies nur für die Aushandlung selbst gilt, nicht jedoch für die Audioübertragung. Wenn Sie auch die Audioübertragung verschlüsseln möchten, setzen Sie die Secure Eigenschaft der der Wähloptionen Objekt, das an den Parameter „options“ übergeben wurde, an ​true​. Dies ist ein Beispiel für die Einstellung sipUri für eine sichere Verbindungsaufbau-Verhandlung: "sip:user@sip.partner.com;transport=tls". Dies ist ein Beispiel für eine unsichere Verbindungsaushandlung: "sip:user@sip.partner.com". | | Optionen | Optionale Parameter für die SIP-Anwahl. |

DialAsync()

Stellt eine Verbindung zwischen einer SIP-Plattform und einer Vonage Video API-Sitzung her.

Weitere Informationen, einschließlich technischer Details und Sicherheitsaspekte, finden Sie in der OpenTok SIP-Interconnect-Entwicklerhandbuch.

Siehe auch OpenTok.Dial.

Parameter : | | | | --- | --- | | 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 als Ziel des von OpenTok an Ihre SIP-Plattform. Wenn die SIP-URI einen ​transport=tls​-Header enthält, erfolgt die Aushandlung zwischen OpenTok und die Verbindung zum SIP-Endpunkt wird sicher hergestellt. Beachten Sie, dass dies nur für die Aushandlung selbst gilt, nicht jedoch für die Audioübertragung. Wenn Sie auch die Audioübertragung verschlüsseln möchten, setzen Sie die Secure Eigenschaft der der Wähloptionen Objekt, das an den Parameter „options“ übergeben wurde, an ​true​. Dies ist ein Beispiel für die Einstellung sipUri für eine sichere Verbindungsaufbau-Verhandlung: "sip:user@sip.partner.com;transport=tls". Dies ist ein Beispiel für eine unsichere Verbindungsaushandlung: "sip:user@sip.partner.com". | | Optionen | Optionale Parameter für die SIP-Anwahl. |

DisableForceMute()

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

Nachdem Sie die ForceMuteAll Methode: Alle nach dem Aufruf veröffentlichten Streams werden mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die DisableForceMute() Methode zum Aufheben der Stummschaltung einer Sitzung, damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden.

Siehe auch die DisableForceMuteAsync Methode.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

DisableForceMuteAsync()

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

Nachdem Sie die ForceMuteAllAsync Methode: Alle nach dem Aufruf veröffentlichten Streams werden mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die DisableForceMuteAsync() Methode zum Aufheben der Stummschaltung einer Sitzung, damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden.

Siehe auch die DisableForceMute Methode.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

ForceDisconnect()

Einen bestimmten Client zwingen, die Verbindung zu einer Vonage Video API-Sitzung zu trennen.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. | | connectionId | Die Verbindungs-ID der Verbindung innerhalb einer Sitzung. |

ForceDisconnectAsync()

Einen bestimmten Client zwingen, die Verbindung zu einer Vonage Video API-Sitzung zu trennen.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. | | connectionId | Die Verbindungs-ID der Verbindung innerhalb einer Sitzung. |

ForceMuteAll()

Zwingt alle Streams (mit Ausnahme einer optionalen Liste 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 DisableForceMute Methode.

Siehe auch die ForceMuteAllAsync und ForceMuteStream Methoden.

Parameter : | | | | --- | --- | | sessionId | Die ID der Sitzung. | | excludedStreamIds | Die Stream-IDs der Streams, die nicht stummgeschaltet werden sollen. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

ForceMuteAllAsync()

Zwingt alle Streams (mit Ausnahme einer optionalen Liste 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 DisableForceMuteAsync Methode.

Siehe auch die ForceMuteAll und ForceMuteStreamAsync Methoden.

Parameter : | | | | --- | --- | | sessionId | Die ID der Sitzung. | | excludedStreamIds | Die Stream-IDs der Streams, die nicht stummgeschaltet werden sollen. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

ForceMuteStream()

Den Herausgeber eines bestimmten Streams dazu zwingen, den von ihm veröffentlichten Ton stummzuschalten.

Siehe auch die ForceMuteAll und ForceMuteStreamAsync Methoden.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Sitzung, zu der der Stream gehört. | | streamId | Die Stream-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs- oder Stream-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

ForceMuteStreamAsync()

Den Herausgeber eines bestimmten Streams dazu zwingen, den von ihm veröffentlichten Ton stummzuschalten.

Siehe auch die ForceMuteAll und ForceMuteStream Methoden.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Sitzung, zu der der Stream gehört. | | streamId | Die Stream-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | Wird ausgelöst, wenn die Sitzungs- oder Stream-ID ungültig ist. | | OpenTokWebException | Wird ausgelöst, wenn ein HTTP-Fehler aufgetreten ist. |

GenerateToken()

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

Zu Testzwecken können Sie auch Test-Token generieren, indem Sie sich bei Ihrem TokBox-Account.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird. | | role | Die Rolle für das Token. Gültige Werte sind in der Enumeration „Role“ definiert: - Rolle.SUBSCRIBER (Ein Abonnent kann nur Streams abonnieren) – Rolle.PUBLISHER (Ein Publisher kann Streams veröffentlichen, Streams abonnieren und Signale senden. (Dies ist der Standardwert, wenn Sie keine Rolle angeben.)) - Rolle: 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 | Die Ablaufzeit des Tokens in Sekunden seit der UNIX-Epoche. Geben Sie 0 an, um die Standard-Ablaufzeit von 24 Stunden nach der Erstellung des Tokens zu verwenden. Die maximale Ablaufzeit beträgt 30 Tage nach der Erstellung. | | data | Eine Zeichenkette mit Verbindungsmetadaten, die den Endbenutzer beschreiben. Sie können beispielsweise die Benutzer-ID, den Namen oder andere Daten übergeben, 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 | Eine Liste von Zeichenkettenwerten, die das anfängliche Layout für den Stream enthalten. |

Rückgabe

GetArchive()

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

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID. |

Rücksendungen : Die Archiv Objekt.

GetArchiveAsync()

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

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID. |

Rücksendungen : Die Archiv Objekt.

GetBroadcast()

Verwenden Sie diese Methode, um ein Live-Streaming-Objekt einer Vonage Video API-Sitzung abzurufen.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die die Übertragung definieren, darunter die Übertragungs-ID.

GetBroadcastAsync()

Verwenden Sie diese Methode, um ein Live-Streaming-Objekt einer Vonage Video API-Sitzung abzurufen.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die die Übertragung definieren, darunter die Übertragungs-ID.

GetRenderAsync()

Ruft einen Experience Composer-Renderer ab.

Parameter : | | | | --- | --- | | renderId | Die ID der Darstellung. |

GetStream()

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

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Vonage Video API-Sitzung. | | streamId | Die Stream-ID. |

Rücksendungen : Die Stream Objekt.

GetStreamAsync()

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

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Vonage Video API-Sitzung. | | streamId | Die Stream-ID. |

Rücksendungen : Die Stream Objekt.

ListArchives()

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

Parameter : | | | | --- | --- | | offset | Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten Archivs. 1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde. | | count | Die Anzahl der zurückzugebenden Archive. Es werden maximal 1000 Archive zurückgegeben. | | sessionId | Die Sitzungs-ID. |

Rückgaben : Eine Liste von Archiv Objekte.

ListArchivesAsync()

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

Parameter : | | | | --- | --- | | offset | Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten Archivs. 1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde. | | count | Die Anzahl der zurückzugebenden Archive. Es werden maximal 1000 Archive zurückgegeben. | | sessionId | Die Sitzungs-ID. |

Rückgaben : Eine Liste von Archiv Objekte.

ListRendersAsync()

Ruft alle Experience Composer-Renderer ab, die der angegebenen Anfrage entsprechen.

Parameter : | | | | --- | --- | | Anfrage | Die Anfrage mit den Filteroptionen. |

Rückgabewerte : Die Liste der Renderings.

ListStreams()

Gibt eine Liste von Stream Objekte, die laufende Streams für die Sitzungs-ID darstellen.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. |

Rückgaben : Eine Liste von Stream Objekte.

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

ListStreamsAsync()

Gibt eine Liste von Stream Objekte, die laufende Streams für die Sitzungs-ID darstellen.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. |

Rückgaben : Eine Liste von Stream Objekte.

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

PlayDTMF()

Senden Sie DTMF-Ziffern an alle Teilnehmer einer aktiven Vonage Video API-Sitzung oder an einen bestimmten, mit dieser Sitzung verbundenen Client.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Sitzung, die die DTMF-Zeichenkette empfangen soll. | | connectionId | Die Verbindungs-ID des Clients, an den Sie das DTMF-Signal senden. Lassen Sie dieses Feld leer, um ein DTMF-Signal an alle mit der Sitzung verbundenen Clients zu senden. | | digits | Dies ist die zu sendende DTMF-Ziffernfolge. 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). |

PlayDTMFAsync()

Senden Sie DTMF-Ziffern an alle Teilnehmer einer aktiven Vonage Video API-Sitzung oder an einen bestimmten, mit dieser Sitzung verbundenen Client.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Sitzung, die die DTMF-Zeichenkette empfangen soll. | | connectionId | Die Verbindungs-ID des Clients, an den Sie das DTMF-Signal senden. Lassen Sie dieses Feld leer, um ein DTMF-Signal an alle mit der Sitzung verbundenen Clients zu senden. | | digits | Dies ist die zu sendende DTMF-Ziffernfolge. 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). |

RemoveStreamFromArchive()

Entfernt einen Stream aus einem zusammengesetzten Archiv, das mit dem Befehl streamMode eingestellt auf StreamMode.Manual.

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID. | | streamId | Die Stream-ID. |

RemoveStreamFromArchiveAsync()

Entfernt einen Stream aus einem zusammengesetzten Archiv, das mit dem Befehl streamMode eingestellt auf StreamMode.Manual.

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID. | | streamId | Die Stream-ID. |

RemoveStreamFromBroadcast()

Entfernt einen Stream aus einer Übertragung, die mit dem streamMode eingestellt auf StreamMode.Manual.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID. | | streamId | Die Stream-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

RemoveStreamFromBroadcastAsync()

Entfernt einen Stream aus einer Übertragung, die mit dem streamMode eingestellt auf StreamMode.Manual.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID. | | streamId | Die Stream-ID. |

Ausnahmen : | | | | --- | --- | | OpenTokArgumentException | |

SetArchiveLayout()

Ermöglicht es Ihnen, das Layout eines zusammengesetzten Archivs während der Aufzeichnung dynamisch zu ändern – siehe Anpassen des Videolayouts für zusammengestellte Archive Weitere Informationen zur Anpassung eines Layouts.

Parameter : | | | | --- | --- | | archiveId | | | layout | |

Rückgabe

SetArchiveLayoutAsync()

Ermöglicht es Ihnen, das Layout eines zusammengesetzten Archivs während der Aufzeichnung dynamisch zu ändern – siehe Anpassen des Videolayouts für zusammengestellte Archive Weitere Informationen zur Anpassung eines Layouts.

Parameter : | | | | --- | --- | | archiveId | | | layout | |

Rückgabe

SetBroadcastLayout()

Legt den Layouttyp für die Sendung fest. Eine Beschreibung der Layouttypen finden Sie unter Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung. | | layout | Das BroadcastLayout das die Layout-Optionen für die Sendung festlegt. |

SetBroadcastLayoutAsync()

Legt den Layouttyp für die Sendung fest. Eine Beschreibung der Layouttypen finden Sie unter Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung. | | layout | Das BroadcastLayout das die Layout-Optionen für die Sendung festlegt. |

SetCustomUserAgent()

Legt einen benutzerdefinierten User-Agent-Wert fest. Der HttpClient fügt diesen Wert, sofern vorhanden, an den ursprünglichen User-Agent-Wert an.

Parameter : | | | | --- | --- | | Wert | Der benutzerdefinierte User-Agent-Wert. |

SetDefaultRequestTimeout()

Legt das Standard-Zeitlimit für Anfragen (in Millisekunden) für alle vom SDK gesendeten WebRequests fest

Parameter : | | | | --- | --- | | Zeitlimit | |

SetStreamClassLists()

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 Anpassen des Videolayouts für zusammengestellte Archive und Konfiguration des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Sie können die Liste der anfänglichen Layout-Klassen für von einem Client veröffentlichte Streams festlegen, wenn Sie diese generieren, die vom Client verwendet werden. Siehe die GenerateToken Methode.

Parameter : | | | | --- | --- | | sessionId | Die sessionId | | streams | Eine Liste von StreamsProperties, die Klassenlisten für einen oder mehrere Streams in der Sitzung definiert. |

SetStreamClassListsAsync()

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 Anpassen des Videolayouts für zusammengestellte Archive und Konfiguration des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Sie können die Liste der anfänglichen Layout-Klassen für von einem Client veröffentlichte Streams festlegen, wenn Sie diese generieren, die vom Client verwendet werden. Siehe die GenerateToken Methode.

Parameter : | | | | --- | --- | | sessionId | Die sessionId | | streams | Eine Liste von StreamsProperties, die Klassenlisten für einen oder mehrere Streams in der Sitzung definiert. |

Signal()

Sendet ein Signal an Clients (oder einen bestimmten Client), die mit einer Vonage Video API-Sitzung verbunden sind.

Parameter : | | | | --- | --- | | sessionId | Die sessionId der Vonage Video API, an die das Signal gesendet wird. | | signalProperties | Diese signalProperties definieren die Nutzdaten für das Signal. | | connectionId | Ein optionaler Parameter, der verwendet wird, um das Signal an eine bestimmte Verbindung innerhalb einer Sitzung zu senden. |

SignalAsync()

Sendet ein Signal an Clients (oder einen bestimmten Client), die mit einer Vonage Video API-Sitzung verbunden sind.

Parameter : | | | | --- | --- | | sessionId | Die sessionId der Vonage Video API, an die das Signal gesendet wird. | | signalProperties | Diese signalProperties definieren die Nutzdaten für das Signal. | | connectionId | Ein optionaler Parameter, der verwendet wird, um das Signal an eine bestimmte Verbindung innerhalb einer Sitzung zu senden. |

StartArchive()

Beginnt mit der Archivierung einer Vonage Video API-Sitzung.

Die Clients müssen aktiv mit der Vonage Video API-Sitzung verbunden sein, damit Sie die Aufzeichnung eines Archivs erfolgreich starten können.

Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den Vonage Video API 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.

Beachten Sie, dass Sie die Sitzung automatisch archivieren lassen können, indem Sie den Parameter „archiveMode“ des CreateSession Methode zu ArchiveMode.ALWAYS.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Vonage Video API-Sitzung, die archiviert werden soll. | | name | Der Name des Archivs. Anhand dieses Namens können Sie das Archiv identifizieren. Es handelt sich um eine Eigenschaft der Archiv Objekt, und es handelt sich um eine Eigenschaft von archivbezogenen Ereignissen in der OpenTok Client-Bibliotheken. | | hasVideo | Gibt an, ob das Archiv Video aufzeichnet (true) oder nicht (false). Der Standardwert ist true (Video wird aufgezeichnet). Wenn Sie beide hasAudio und hasVideo auf „false“ gesetzt, führt der Aufruf der StartArchiv Die Methode führt zu einem Fehler. | | hasAudio | Gibt an, ob das Archiv Audio aufzeichnet (true) oder nicht (false). Der Standardwert ist true (Audio wird aufgezeichnet). Wenn Sie beide hasAudio und hasVideo auf „false“ gesetzt, führt der Aufruf der StartArchiv Die Methode führt zu einem Fehler. | | outputMode | Gibt an, ob alle Streams im Archiv in einer einzigen Datei aufgezeichnet werden (OutputMode.COMPOSED, die Standardeinstellung) oder auf einzelne Dateien (OutputMode.INDIVIDUAL). | | Auflösung | Die Auflösung für das Archiv. Der Standardwert für OutputMode.COMPOSED beträgt „640x480“. Die Auflösung für OutputMode.INDIVIDUAL. | | layout | Das Layout, das Sie für Ihr Archiv verwenden möchten. Wenn „type“ auf LayoutType.custom Sie müssen Vonage eine StyleSheet-Zeichenkette bereitstellen, die angibt, wie Ihr Archiv gestaltet werden soll. | | streamMode | Gibt an, ob die im Archiv enthaltenen Streams automatisch ausgewählt werden (StreamMode.Auto, die Standardeinstellung) oder manuell (StreamMode.Manual). Mit StreamMode.Manual, geben Sie die Streams, die in das Archiv aufgenommen werden sollen, mithilfe des OpenTok.AddStreamToArchive und OpenTok.RemoveStreamFromArchive Methoden (oder die OpenTok.AddStreamToArchiveAsync und OpenTok.RemoveStreamFromArchiveAsync Methoden). | | multiArchiveTag | Setzen Sie diese Option, um die gleichzeitige Aufzeichnung mehrerer Archive für dieselbe Sitzung zu unterstützen. Verwenden Sie hierfür für jedes gleichzeitig laufende Archiv einer laufenden Sitzung eine eindeutige Zeichenfolge. Sie müssen diese Option auch festlegen, wenn Sie ein Archiv manuell in einer Sitzung starten, die automatisch archiviert wird. Wenn Sie kein eindeutiges „multiArchiveTag“ angeben, können Sie für eine bestimmte Sitzung jeweils nur ein Archiv aufzeichnen. Siehe Gleichzeitige Archive. |

Rücksendungen : Die Archiv Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.

StartArchiveAsync()

Beginnt mit der Archivierung einer Vonage Video API-Sitzung.

Die Clients müssen aktiv mit der Vonage Video API-Sitzung verbunden sein, damit Sie die Aufzeichnung eines Archivs erfolgreich starten können.

Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den Vonage Video API 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.

Beachten Sie, dass Sie die Sitzung automatisch archivieren lassen können, indem Sie den Parameter „archiveMode“ des CreateSession Methode zu ArchiveMode.ALWAYS.

Parameter : | | | | --- | --- | | sessionId | Die Sitzungs-ID der Vonage Video API-Sitzung, die archiviert werden soll. | | name | Der Name des Archivs. Anhand dieses Namens können Sie das Archiv identifizieren. Es handelt sich um eine Eigenschaft der Archiv Objekt, und es handelt sich um eine Eigenschaft von archivbezogenen Ereignissen in der OpenTok Client-Bibliotheken. | | hasVideo | Gibt an, ob das Archiv Video aufzeichnet (true) oder nicht (false). Der Standardwert ist true (Video wird aufgezeichnet). Wenn Sie beide hasAudio und hasVideo auf „false“ gesetzt, führt der Aufruf der StartArchiv Die Methode führt zu einem Fehler. | | hasAudio | Gibt an, ob das Archiv Audio aufzeichnet (true) oder nicht (false). Der Standardwert ist true (Audio wird aufgezeichnet). Wenn Sie beide hasAudio und hasVideo auf „false“ gesetzt, führt der Aufruf der StartArchiv Die Methode führt zu einem Fehler. | | outputMode | Gibt an, ob alle Streams im Archiv in einer einzigen Datei aufgezeichnet werden (OutputMode.COMPOSED, die Standardeinstellung) oder auf einzelne Dateien (OutputMode.INDIVIDUAL). | | Auflösung | Die Auflösung für das Archiv. Der Standardwert für OutputMode.COMPOSED beträgt „640x480“. Die Auflösung für OutputMode.INDIVIDUAL. | | layout | Das Layout, das Sie für Ihr Archiv verwenden möchten. Wenn „type“ auf LayoutType.custom Sie müssen Vonage eine StyleSheet-Zeichenkette bereitstellen, die angibt, wie Ihr Archiv gestaltet werden soll. | | streamMode | Gibt an, ob die im Archiv enthaltenen Streams automatisch ausgewählt werden (StreamMode.Auto, die Standardeinstellung) oder manuell (StreamMode.Manual). Mit StreamMode.Manual, geben Sie die Streams, die in das Archiv aufgenommen werden sollen, mithilfe des OpenTok.AddStreamToArchive und OpenTok.RemoveStreamFromArchive Methoden (oder die OpenTok.AddStreamToArchiveAsync und OpenTok.RemoveStreamFromArchiveAsync Methoden). | | multiArchiveTag | Setzen Sie diese Option, um die gleichzeitige Aufzeichnung mehrerer Archive für dieselbe Sitzung zu unterstützen. Verwenden Sie hierfür für jedes gleichzeitig laufende Archiv einer laufenden Sitzung eine eindeutige Zeichenfolge. Sie müssen diese Option auch festlegen, wenn Sie ein Archiv manuell in einer Sitzung starten, die automatisch archiviert wird. Wenn Sie kein eindeutiges „multiArchiveTag“ angeben, können Sie für eine bestimmte Sitzung jeweils nur ein Archiv aufzeichnen. Siehe Gleichzeitige Archive. |

Rücksendungen : Die Archiv Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.

StartAudioConnectorAsync()

Leitet Audio aus einer Vonage Video API-Sitzung an einen WebSocket weiter. Weitere Informationen finden Sie unter Audio Connector Entwicklerhandbuch.

Parameter : | | | | --- | --- | | request | Die Anforderung zum Starten des Audio-Connectors. |

Rückgabewerte : Das Antwortobjekt vom Server.

StartBroadcast()

Verwenden Sie diese Methode, um ein Live-Streaming für eine Vonage Video API-Sitzung zu starten. Dadurch wird die Sitzung über HLS (HTTP Live Streaming) oder RTMP-Streams übertragen.

Um die Übertragung einer Sitzung erfolgreich zu starten, muss mindestens ein Client mit der Sitzung verbunden sein.

Pro Sitzung kann jeweils nur eine Live-Streaming-Übertragung aktiv sein (mehrere wären ohnehin nicht sinnvoll). Die Live-Streaming-Übertragung kann pro Sitzung gleichzeitig auf einen HLS-Endpunkt und bis zu fünf RTMP-Server gerichtet sein. Sie können Live-Streaming nur für Sitzungen starten, die den Vonage Video API Media Router verwenden (wobei der Medienmodus auf „routed“ eingestellt ist); bei Sitzungen, bei denen der Medienmodus auf „relayed Vonage Video API Media Router“ eingestellt ist, können Sie Live-Streaming nicht nutzen. Siehe Der OpenTok Media Router und die Medienmodi.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. | | hls | Gibt an, ob eine HLS-Übertragung einbezogen werden soll. | | rtmpList | Eine Liste von RTMP Objekte, die die zu übertragenden RTMP-Streams definieren (bis zu fünf). | | Auflösung | Die Auflösung des übertragenen Videos. Gültige Auflösungen sind „640x480“, „1280x720“, „1920x1080“, „480x640“, „720x1280“, „1080x1920“. | | maxDuration | 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 2 Stunden (7.200 Sekunden). | | layout | Geben Sie dies an BroadcastLayout Objekt zur Zuweisung des anfänglichen Layouttyps für die Übertragung. | | streamMode | Gibt an, ob die in der Übertragung enthaltenen Streams automatisch ausgewählt werden (StreamMode.Auto, die Standardeinstellung) oder manuell (StreamMode.Manual). Mit StreamMode.Manual, geben Sie die Streams, die in die Übertragung einbezogen werden sollen, mithilfe des OpenTok.AddStreamToBroadcast und OpenTok.RemoveStreamFromBroadcast Methoden (oder die OpenTok.AddStreamToBroadcastAsync und OpenTok.RemoveStreamFromBroadcastAsync Methoden). | | dvr | Gibt an, ob die DVR-Funktionalität – Zurückspulen, Anhalten und Fortsetzen – in Playern, die diese unterstützen, aktiviert werden soll (true) oder nicht (false, Standardeinstellung). Bei aktiviertem DVR wird die HLS-URL am Ende um den Abfrageparameter ?DVR ergänzt. Siehe DVR-Funktionalität | | lowLatency | Gibt an, ob der Low-Latency-Modus für den HLS-Stream aktiviert werden soll. Einige HLS-Player unterstützen den Low-Latency-Modus nicht. Diese Funktion ist nicht mit HLS-Übertragungen im DVR-Modus kompatibel. Siehe HLS-Übertragungen mit niedriger Latenz | | multiBroadcastTag | 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. Siehe Gleichzeitige Sendungen. | | hasAudio | Gibt an, ob die Übertragung Ton enthält (Standardwert ist „true“). | | hasVideo | Gibt an, ob die Übertragung Video enthält (Standardwert ist „true“). |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.

StartBroadcastAsync()

Verwenden Sie diese Methode, um ein Live-Streaming für eine Vonage Video API-Sitzung zu starten. Dadurch wird die Sitzung über HLS (HTTP Live Streaming) oder RTMP-Streams übertragen.

Um die Übertragung einer Sitzung erfolgreich zu starten, muss mindestens ein Client mit der Sitzung verbunden sein.

Pro Sitzung kann jeweils nur eine Live-Streaming-Übertragung aktiv sein (mehrere wären ohnehin nicht sinnvoll). Die Live-Streaming-Übertragung kann pro Sitzung gleichzeitig auf einen HLS-Endpunkt und bis zu fünf RTMP-Server gerichtet sein. Sie können Live-Streaming nur für Sitzungen starten, die den Vonage Video API Media Router verwenden (wobei der Medienmodus auf „routed“ eingestellt ist); bei Sitzungen, bei denen der Medienmodus auf „relayed Vonage Video API Media Router“ eingestellt ist, können Sie Live-Streaming nicht nutzen. Siehe Der OpenTok Media Router und die Medienmodi.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | sessionId | Die der Sitzung entsprechende Sitzungs-ID. | | hls | Gibt an, ob eine HLS-Übertragung einbezogen werden soll. | | rtmpList | Eine Liste von RTMP Objekte, die die zu übertragenden RTMP-Streams definieren (bis zu fünf). | | Auflösung | Die Auflösung des übertragenen Videos. Gültige Auflösungen sind „640x480“, „1280x720“, „1920x1080“, „480x640“, „720x1280“, „1080x1920“. | | maxDuration | 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 2 Stunden (7.200 Sekunden). | | layout | Geben Sie dies an BroadcastLayout Objekt zur Zuweisung des anfänglichen Layouttyps für die Übertragung. | | streamMode | Gibt an, ob die in der Übertragung enthaltenen Streams automatisch ausgewählt werden (StreamMode.Auto, die Standardeinstellung) oder manuell (StreamMode.Manual). Mit StreamMode.Manual, geben Sie die Streams, die in die Übertragung einbezogen werden sollen, mithilfe des OpenTok.AddStreamToBroadcast und OpenTok.RemoveStreamFromBroadcast Methoden (oder die OpenTok.AddStreamToBroadcastAsync und OpenTok.RemoveStreamFromBroadcastAsync Methoden). | | dvr | Gibt an, ob die DVR-Funktionalität – Zurückspulen, Anhalten und Fortsetzen – in Playern, die diese unterstützen, aktiviert werden soll (true) oder nicht (false, Standardeinstellung). Bei aktiviertem DVR wird die HLS-URL am Ende um den Abfrageparameter ?DVR ergänzt. Siehe DVR-Funktionalität | | lowLatency | Gibt an, ob der Low-Latency-Modus für den HLS-Stream aktiviert werden soll. Einige HLS-Player unterstützen den Low-Latency-Modus nicht. Diese Funktion ist nicht mit HLS-Übertragungen im DVR-Modus kompatibel. Siehe HLS-Übertragungen mit niedriger Latenz | | multiBroadcastTag | 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. Siehe Gleichzeitige Sendungen. | | hasAudio | Gibt an, ob die Übertragung Ton enthält (Standardwert ist „true“). | | hasVideo | Gibt an, ob die Übertragung Video enthält (Standardwert ist „true“). |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.

StartRenderAsync()

Startet einen neuen Experience Composer-Renderer für eine Vonage Video API-Sitzung.

Weitere Informationen finden Sie unter . Entwicklerhandbuch zu Experience Composer.

Parameter : | | | | --- | --- | | request | Die Rendering-Anfrage. |

Rückgabewert : Die erzeugte Darstellung.

StopArchive()

Beendet ein OpenTok das Archiv, das gerade aufgezeichnet wird.

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

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten. |

Rücksendungen : Die Archiv Objekt, das dem zu beendenden Archiv entspricht.

StopArchiveAsync()

Beendet ein OpenTok das Archiv, das gerade aufgezeichnet wird.

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

Parameter : | | | | --- | --- | | archiveId | Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten. |

Rücksendungen : Die Archiv Objekt, das dem zu beendenden Archiv entspricht.

StopAudioConnectorAsync()

Beendet die Audioübertragung für eine Vonage Video API-Sitzung.

Parameter : | | | | --- | --- | | connectionId | Die OpenTok Verbindungs-ID für die WebSocket-Verbindung des Audio-Connectors in der Vonage Video API-Sitzung. Siehe [AudioConnector.ConnectionId]. |

StopBroadcast()

Verwenden Sie diese Methode, um eine Live-Übertragung einer Vonage Video API-Sitzung zu beenden. Beachten Sie, dass Übertragungen 120 Minuten nach ihrem Start automatisch beendet werden.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die die Übertragung definieren, darunter die Übertragungs-ID.

StopBroadcastAsync()

Verwenden Sie diese Methode, um eine Live-Übertragung einer Vonage Video API-Sitzung zu beenden. Beachten Sie, dass Übertragungen 120 Minuten nach ihrem Start automatisch beendet werden.

Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.

Parameter : | | | | --- | --- | | broadcastId | Die Broadcast-ID der Übertragungssitzung |

Rücksendungen : Die Sendung Objekt. Dieses Objekt enthält Eigenschaften, die die Übertragung definieren, darunter die Übertragungs-ID.

StopRenderAsync()

Beendet einen Experience Composer-Renderer.

Parameter : | | | | --- | --- | | renderId | Die ID der Darstellung. |

Dokumentation zur Immobilie

ApiKey

Der Video API-Schlüssel, der an die OpenTok() Konstrukteur.

ApiSecret

Der an die Vonage Video API übergebene Schlüssel OpenTok() Konstrukteur.

Kunde

Nur für den internen Gebrauch

Debuggen

Ermöglicht die Ausgabe von Anfrage-/Antwortdetails in die Konsole. Nicht in einer Produktionsumgebung verwenden.