Stellt eine Vonage Video API-Sitzung dar, an der der Client teilnimmt. Mehr...

Erbt von IDisposable.

Ausführliche Beschreibung

Stellt eine Vonage Video API-Sitzung dar, an der der Client teilnimmt.

Der erste Schritt bei der Verwendung des Vonage Video API Windows SDK besteht darin, eine Instanz von Sitzung Objekt unter Verwendung des Session.Builder Klasse.

Die Sitzung Die Klasse implementiert die Schnittstelle „System.IDisposable“. Achten Sie darauf, die Methode Dispose() Methode der Sitzung Das Objekt sollte seine Ressourcen freigeben, wenn Sie das Objekt nicht mehr benötigen (beispielsweise beim Schließen der App oder des Fensters).

Siehe auch Erstellung von Sitzungen und Token-Erstellung.

Dokumentation zu Member-Funktionen

Connect()

Stellt eine Verbindung zur Vonage Video API-Sitzung her, die in der Sitzung Konstruktor unter Verwendung des bereitgestellten Authentifizierungstokens.

Sobald die Sitzung hergestellt ist, wird die Sitzung Das Objekt sendet die Verbunden Veranstaltung.

Wenn die Sitzung keine Verbindung herstellen kann, wird die Sitzung Das Objekt sendet die Fehler Veranstaltung.

Parameter : | | | | --- | --- | | token | Das Token des Benutzers. Siehe Token-Erstellung Übersicht. |

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 (oder wenn ein Moderator in einem anderen Client einen Befehl zum Stummschalten aller Streams auslöst), werden alle Streams, die nach dem Moderationsbefehl veröffentlicht 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).

Der Aufruf dieser Methode bewirkt, dass die Sitzung Objekt in jedem mit der Sitzung verbundenen Client, um die Erzwungene Stummschaltung Ereignis, mit dem IsActive Eigenschaft der MuteForcedEventArgs Objekt, das auf … gesetzt werden soll false.

Prüfen Sie die CanForceMute Eigenschaft der Session.Capabilities Objekt, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Dies ist Clients vorbehalten, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Übersicht über die Token-Erstellung).

Siehe Stummschalten des Tons von Streams in einer Sitzung.

Siehe auch : Fähigkeiten, ForceMuteAll, Erzwungene Stummschaltung

Disconnect()

Trennt die Verbindung zu dieser Sitzung. Alle Abonnent und Herausgeber Die Instanzen werden getrennt.

Als bewährte Vorgehensweise sollten Sie vor dem Aufruf dieser Methode die Methode Veröffentlichung rückgängig machen (Herausgeber) Methode für alle Herausgeber aufrufen und auf die Publisher.StreamDestroyed Ereignis. Dadurch wird sichergestellt, dass Publisher vollständig entfernt werden, insbesondere wenn Probleme mit der Netzwerkverbindung die Entfernung aufgrund der Wiederverbindungsfunktion verhindern, die Publisher-Streams für eine mögliche Wiederverbindung aufrechterhalten könnte.

Wenn die Sitzung getrennt wird, wird die Sitzung sendet die Getrennt Veranstaltung.

ForceDisconnect()

Zwingt einen Client, die Verbindung zur Sitzung zu trennen.

Sie können zwar die `ForceDisconnect`-Methode verwenden, um Ihre eigene Verbindung zu beenden, doch ist der Aufruf der `Disconnect`-Methode einfacher. Es wird ein Fehler zurückgegeben, wenn die Rolle des Benutzers nicht über die erforderlichen Berechtigungen verfügt, um andere Benutzer zur Trennung der Verbindung zu zwingen. Die Rolle eines Benutzers legen Sie beim Erstellen des Benutzer-Tokens fest.

Wenn eine Verbindung mit dieser Methode beendet wird, wird die Getrennt, Verbindung unterbrochen und Publisher.StramDestroyed-Ereignisse werden auf dieselbe Weise ausgelöst, wie dies der Fall wäre, wenn die Verbindung mithilfe von „Disconnect“ selbst beendet worden wäre.

Parameter : | | | | --- | --- | | Verbindung | Die Verbindung, die getrennt werden soll. |

ForceMuteAll()

Zwingt alle Sender in der Sitzung (mit Ausnahme derjenigen, die ausgeschlossene Streams übertragen), den Ton stummzuschalten.

Außerdem werden alle Streams, die nach dem Aufruf der ForceMuteAll() Methode werden mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltzustand einer Sitzung aufheben, indem Sie die Methode DisableForceMute() Methode. Nachdem Sie die DisableForceMute() werden neue Streams, die in der Sitzung veröffentlicht werden, nicht mehr stummgeschaltet.

Der Aufruf dieser Methode bewirkt, dass die Sitzung Objekt in jedem mit der Sitzung verbundenen Client, um die Erzwungene Stummschaltung Ereignis, mit dem IsActive Eigenschaft der MuteForcedEventArgs Objekt, das auf … gesetzt werden soll true.

Prüfen Sie die CanForceMute Eigenschaft der Session.Capabilities Objekt, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Dies ist Clients vorbehalten, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Übersicht über die Token-Erstellung).

Siehe Stummschalten des Tons von Streams in einer Sitzung.

Parameter : | | | | --- | --- | | excludedStreams | Streams, die von der Stummschaltungsanforderung ausgeschlossen werden sollen. Setzen Sie diesen Wert auf null (oder lassen Sie diesen Parameter ungesetzt), um alle Streams in der Sitzung stummzuschalten (einschließlich der vom lokalen Client veröffentlichten). |

Siehe auch : Fähigkeiten, ForceMuteStream, DisableForceMute(), Session.MuteForced, Publisher.MuteForced

ForceMuteStream()

Zwingt den Anbieter eines bestimmten Streams dazu, dessen Ton stummzuschalten.

Prüfen Sie die CanForceMute Eigenschaft der Session.Capabilities Objekt, um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Dies ist Clients vorbehalten, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Übersicht über die Token-Erstellung).

Siehe Stummschalten des Tons von Streams in einer Sitzung.

Parameter : | | | | --- | --- | | stream | Der Stream, der stummgeschaltet werden soll. |

Siehe auch : Fähigkeiten, ForceMuteAll, Publisher.MuteForced

Veröffentlichen()

Startet ein Herausgeber Streaming in die Sitzung.

Parameter : | | | | --- | --- | | Herausgeber | Der Herausgeber die Sie in die Sitzung streamen möchten. |

SendSignal()

Sendet ein Signal an alle Clients in der Sitzung.

Parameter : | | | | --- | --- | | Typ | Der Typ des Signals. Der Typ wird in der SignalEventArgs.Type Argument des Signal Ereignis-Listener. | | data | Die zu sendenden Daten. Die Datengröße ist auf 8 kB begrenzt. Der Typ wird in der SignalEventArgs.Data Argument des Signal Ereignis-Listener. | | Verbindung | | | retryAfterReconnect | |

SetEncryptionSecret()

Legt den Schlüssel für die End-to-End-Verschlüsselung fest, der von allen Herausgebern und Abonnenten verwendet wird.

Siehe die Ende-zu-Ende-Verschlüsselung Leitfaden für Entwickler.

Parameter : | | | | --- | --- | | secret | Wert des Verschlüsselungsschlüssels. |

Abonnieren()

Beginnen Sie mit dem Empfang und der Wiedergabe von Audio-Video-Streaming-Daten für den angegebenen Teilnehmer.

Parameter : | | | | --- | --- | | Abonnent | Der Abonnent, der an den zu empfangenden Stream gebunden ist. |

Veröffentlichung rückgängig machen()

Trennt die Verbindung zum Herausgeber aus der Sitzung.

Parameter : | | | | --- | --- | | Herausgeber | Der Herausgeber um die Veröffentlichung rückgängig zu machen. |

Abmelden()

Beendet das Abonnieren (Empfangen eines Streams) eines bestimmten Abonnenten in der Sitzung.

Parameter : | | | | --- | --- | | Abonnent | Der Abonnent, dessen Abonnement Sie beenden möchten. |

Veranstaltungsdokumentation

Verbindung hergestellt

Wird gesendet, wenn sich ein weiterer Client mit der Sitzung verbindet.

Die ConnectionEventArgs.Connection Das Objekt repräsentiert die Verbindung des Clients zur Sitzung. Beachten Sie, dass diese Methode aufgerufen wird, wenn sonstiges Clients stellen eine Verbindung zur Sitzung her. Wenn Ihre eigene Wenn sich ein Client verbindet, wird der Sitzung sendet die Verbunden Veranstaltung.

Verbindung unterbrochen

Wird gesendet, wenn ein anderer Client die Sitzung verlässt.

Die ConnectionEventArgs.Connection Das Objekt repräsentiert die vorherige Verbindung des Clients zur Sitzung. Beachten Sie, dass diese Methode aufgerufen wird, wenn sonstiges Die Klienten verlassen die Sitzung. Wenn Ihre eigene Der Client trennt die Verbindung, der Sitzung Das Objekt sendet die Verbunden Veranstaltung.

Fehler

Wird gesendet, wenn beim Herstellen der Verbindung oder während der Verbindung zur Sitzung ein Fehler auftritt.

Dieses Ereignis wird ausgelöst, wenn der Versuch, eine Verbindung zur Sitzung herzustellen, fehlschlägt. Es wird außerdem ausgelöst, wenn die Verbindung zur Sitzung nach einer erfolgreichen Verbindungsherstellung aufgrund eines Fehlers unterbrochen wird; in diesem Fall wird das Ereignis unmittelbar vor dem Getrennt Ereignis gesendet wird.

Wiederverbindung starten

Wird gesendet, wenn der lokale Client die Verbindung zu einer Vonage Video API-Sitzung verloren hat und versucht, die Verbindung wiederherzustellen. Dies ist auf einen Ausfall der Netzwerkverbindung zurückzuführen.

Wenn der Client die Verbindung zur Sitzung wiederherstellen kann, wird die Sitzung Das Objekt sendet die Wiederverbindung erfolgreich Ereignis. Andernfalls, wenn der Client die Verbindung nicht wiederherstellen kann, wird die Sitzung Das Objekt sendet die Getrennt Veranstaltung.

Als Reaktion auf den Aufruf dieser Methode sollten Sie möglicherweise eine Benachrichtigung über die Benutzeroberfläche anzeigen, um den Benutzer darüber zu informieren, dass die App versucht, die Verbindung zur Sitzung wiederherzustellen, und dass die Audio- und Videostreams vorübergehend unterbrochen sind.

Siehe auch : Wiederverbindung erfolgreich, Getrennt

Wiederverbindung erfolgreich

Wird aufgerufen, wenn der lokale Client die Verbindung zur Vonage Video API-Sitzung wiederhergestellt hat, nachdem seine Netzwerkverbindung vorübergehend unterbrochen war.

Wenn die Verbindung unterbrochen wird, wird die Sitzung Das Objekt sendet die Session.ReconnectionStart Ereignis, bevor das Session.ReconnectionSuccess Ereignis. Wenn der Client die Verbindung zur Sitzung nicht wiederherstellen kann, wird die Sitzung Das Objekt sendet die Session.Disconnected Veranstaltung.

Alle bestehenden Publisher und Subscriber werden automatisch wieder verbunden, wenn der Client die Verbindung wiederherstellt und diese Methode aufgerufen wird.

Standardmäßig werden alle Signale, die vom lokalen Client mithilfe der SendSignal(Zeichenkette, Zeichenkette, Verbindung, bool) Die Signale dieser Methode werden gesendet, wenn der Client die Verbindung wiederherstellt. Um zu verhindern, dass Signale gesendet werden, die während der Unterbrechung der Verbindung ausgelöst wurden, setzen Sie die retryAfterReconnect Parameter des SendSignal Methode zu false. (Alle Signale, die von anderen Clients gesendet wurden, während die Verbindung Ihres Clients unterbrochen war, werden bei der Wiederherstellung der Verbindung empfangen.)

Siehe auch : Wiederverbindung starten

StreamDropped

Gesendet am ein weiterer Der Client stellt die Übertragung eines Streams an diese Vonage Video API-Sitzung ein.

Die StreamEventArgs.Stream Das Objekt stellt eine Momentaufnahme des Streams zum Zeitpunkt des Callbacks dar. Es kann verwendet werden, um ein entsprechendes Abonnent (falls es eine gibt).

StreamReceived

Wird gesendet, wenn ein neuer Stream von ein weiterer Client in dieser Vonage Video API-Sitzung.

Die StreamEventArgs.Stream Das Objekt stellt eine Momentaufnahme des Streams zum Zeitpunkt des Callbacks dar. Erstellen Sie ein Abonnent und rufen Sie die Abonnieren (Abonnent) Methode zum Abonnieren des Streams.