Definiert connectionCreated und connectionDestroyed Ereignisse, die
von der Sitzung Objekt.
Das Session-Objekt sendet eine connectionCreated Ereignis, wenn sich ein Client (einschließlich
Ihrer eigenen) mit einer Sitzung verbindet. Außerdem löst es ein connectionCreated Ereignis für
jeden Client in der Sitzung, wenn die erste Verbindung hergestellt wird. (Wenn Ihr lokaler Client eine Verbindung herstellt, löst das
Session-Objekt ebenfalls ein sessionConnected Ereignis, definiert durch die
SessionConnectEvent Klasse.)
Solange Sie mit der Sitzung verbunden sind, löst das Session-Objekt ein
connectionDestroyed Ereignis, wenn ein anderer Client die Verbindung zur Sitzung trennt.
(Wenn Sie die Verbindung trennen, löst das Session-Objekt ebenfalls ein sessionDisconnected
Ereignis, definiert durch die SessionDisconnectEvent Klasse.)
Beispiel
Der folgende Code erfasst die laufende Gesamtzahl der Verbindungen zu einer Sitzung,
indem er die connections Eigenschaft der sessionConnect,
connectionCreated und connectionDestroyed Veranstaltungen:
var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionID = ""; // Replace with your own session ID.
// See https://tokbox.com/developer/guides/create-session/.
var token = ""; // Replace with a generated token that has been assigned the moderator role.
// See https://tokbox.com/developer/guides/create-token/.
var connectionCount = 0;
var session = OT.initSession(apiKey, sessionID);
session.on("connectionCreated", function(event) {
connectionCount++;
displayConnectionCount();
});
session.on("connectionDestroyed", function(event) {
connectionCount--;
displayConnectionCount();
});
session.connect(token);
function displayConnectionCount() {
document.getElementById("connectionCountField").value = connectionCount.toString();
}
In diesem Beispiel wird davon ausgegangen, dass im HTML-DOM ein Eingabefeld vorhanden ist
mit dem id eingestellt auf "connectionCountField":
<input type="text" id="connectionCountField" value="0"></input>
Eigenschaften
| Name | Typ | Beschreibung |
|---|---|---|
connection |
Verbindung | Ein „Connection“-Objekt für die Verbindung, die erstellt oder gelöscht wurde. |
connections |
Array | Veraltet. Verwenden Sie stattdessen das connection Eigenschaft. A connectionCreated oder connectionDestroyed Für jede Verbindung, die in der Sitzung hergestellt oder beendet wird, wird ein Ereignis ausgelöst. |
reason |
Zeichenfolge | Für eine connectionDestroyed Ereignis, eine Beschreibung, warum die Verbindung beendet wurde. Diese Eigenschaft kann folgende Werte annehmen: - "clientDisconnected" — Ein Client hat die Verbindung zur Sitzung durch Aufruf der disconnect() Methode des Session-Objekts oder durch Schließen des Browsers. (Siehe Session.disconnect().) – "forceDisconnected" — Ein Moderator hat den Verfasser aus der Sitzung ausgeschlossen, indem er den Befehl forceDisconnect() Methode des Session-Objekts. (Siehe Session.forceDisconnect().) – "mediaIdle" — Der Client wurde aus einer Sitzung getrennt, da er innerhalb von 4 Stunden nach der Verbindung keine Streams veröffentlicht oder abonniert hat – "networkDisconnected" — Die Netzwerkverbindung wurde abrupt unterbrochen (beispielsweise weil der Client seine Internetverbindung verloren hat) und von der Vonage Video API-Plattform erkannt. - "serverRotation" — Der Client wurde aus der Sitzung getrennt, weil Rotation der Video API-Server. Je nach Kontext kann diese Beschreibung es dem Entwickler ermöglichen, seine Vorgehensweise als Reaktion auf ein Ereignis anzupassen. Für eine connectionCreated Ereignis: Diese Zeichenfolge ist nicht definiert. |
Methoden
| Name | Beschreibung |
|---|---|
isDefaultPrevented() → {Boolean} |
Ob das Standardverhalten des Ereignisses durch einen Aufruf von preventDefault() (true) oder nicht (false). |
preventDefault() |
Verhindert, dass das mit dem Ereignis verbundene Standardverhalten ausgeführt wird. |
isDefaultPrevented() → {Boolean}
Ob das Standardverhalten des Ereignisses durch einen Aufruf von
preventDefault() (true) oder nicht (false).
Siehe preventDefault().
Rückgabe:
preventDefault()
Verhindert, dass das mit dem Ereignis verbundene Standardverhalten ausgeführt wird.
Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die cancelable Eigenschaft
des Ereignisobjekts.
Rufen Sie die preventDefault() Methode in der Callback-Funktion für das Ereignis.
Die folgenden Ereignisse weisen Standardverhalten auf:
sessionDisconnect— Siehe SessionDisconnectEvent.preventDefault().streamDestroyed— Siehe StreamEvent.preventDefault().accessDialogOpened— Siehe die Ereignis „accessDialogOpened“.accessDenied— Siehe die Ereignis „accessDenied“.