StreamEvent
„StreamEvent“ ist ein Ereignis, das den Typ „streamCreated“ oder „streamDestroyed“ haben kann. Diese Ereignisse werden vom Session-Objekt ausgelöst, wenn ein anderer Client die Veröffentlichung eines Streams an einen Sitzung. Bei einem Stream eines lokalen Clients löst das Publisher-Objekt das Ereignis aus.
Beispiel – Auslösen des Ereignisses „streamCreated“
durch das Session-Objekt
Der folgende Code stellt eine Verbindung zu einer Sitzung her und richtet einen Ereignis-Listener ein, der ausgelöst wird, wenn ein von einem anderen Client veröffentlichter Stream erstellt wird:
session.on("streamCreated", function(event) {
subscriber = session.subscribe(event.stream, targetElement);
}).connect(token);
Beispiel – Auslösen des Ereignisses „streamDestroyed“
durch das Session-Objekt
Der folgende Code stellt eine Verbindung zu einer Sitzung her und richtet einen Ereignis-Listener ein, der ausgelöst wird, wenn die Streams anderer Clients enden:
session.on("streamDestroyed", function(event) {
console.log("Stream " + event.stream.name + " ended. " + event.reason);
}).connect(token);
Beispiel – Auslösen des Ereignisses „streamCreated“
durch ein Publisher-Objekt
Der folgende Code veröffentlicht einen Stream und fügt einen Ereignis-Listener hinzu, der ausgelöst wird, sobald das Streaming beginnt
var publisher = session.publish(targetElement)
.on("streamCreated", function(event) {
console.log("Publisher started streaming.");
});
Beispiel – Ereignis „streamDestroyed“
von einem Publisher-Objekt gesendet
Der folgende Code veröffentlicht einen Stream und belässt den Publisher im HTML-DOM, wenn das Streaming beendet wird:
var publisher = session.publish(targetElement)
.on("streamDestroyed", function(event) {
event.preventDefault();
console.log("Publisher stopped streaming.");
});
Eigenschaften
cancelable
Typ: Boolesch
Ob das Ereignis ein Standardverhalten aufweist, das abgebrochen werden kann
(true) oder nicht (false). Sie können das Standardverhalten deaktivieren, indem Sie
die Funktion preventDefault() Methode des StreamEvent-Objekts in der
Ereignisbehandlungsfunktion. Die streamDestroyed Die Veranstaltung kann abgesagt werden.
(Siehe preventDefault().)
reason
Typ: Zeichenkette
Für eine streamDestroyed Ereignis,
eine Beschreibung, warum der Stream zerstört wurde. Diese Eigenschaft kann einen der folgenden
Werte annehmen:
"clientDisconnected"— Ein Client hat die Verbindung zur Sitzung durch Aufruf derdisconnect()Methode des Session-Objekts oder durch Schließen des Browsers. (Siehe Session.disconnect().)"forceDisconnected"— Ein Moderator hat den Ersteller des Streams aus der Sitzung ausgeschlossen, indem er denforceDisconnect()Methode des Session-Objekts. (Siehe Session.forceDisconnect().)"forceUnpublished"— Ein Moderator hat den Betreiber des Streams dazu gezwungen, die Übertragung einzustellen, indem er denforceUnpublish()Methode des Session-Objekts. (Siehe Session.forceUnpublish().)"mediaStopped"— Der Nutzer, der den Stream veröffentlicht, hat die Medienfreigabe beendet. Beispielsweise hat der Nutzer das Fenster geschlossen, das als Quelle für einen Bildschirmfreigabe-Stream diente. Oder der Nutzer hat ein Mikrofon getrennt, das als Audioquelle für einen reinen Audio-Stream diente. Oder es handelt sich bei den Video- und Audioquellen um „MediaStreamTrack“-Elemente, und die Medienquellen wurden angehalten oder zerstört."networkDisconnected"— Die Netzwerkverbindung wurde abrupt unterbrochen (beispielsweise weil der Client seine Internetverbindung verloren hat) und von der Vonage Video API-Plattform erkannt."reset"— Der Stream eines Publishers wurde als Reaktion auf einen Aufruf an dessenPublisher.destroy()Methode."serverRotation"— Der Stream des Publishers wurde unterbrochen, da die Verbindung des Clients zur Sitzung aufgrund von Rotation der Video API-Server.
Je nach Kontext kann diese Beschreibung es dem Entwickler ermöglichen, die Maßnahmen, die er als Reaktion auf ein Ereignis ergreift, genauer abzustimmen.
Für eine streamCreated Ereignis: Diese Zeichenfolge ist nicht definiert.
stream
Typ: Stream
Ein Stream-Objekt, das dem hinzugefügten Stream entspricht (im
Fall eines streamCreated Ereignis) oder gelöscht (im Falle eines
streamDestroyed Veranstaltung).
streams
Typ: Array
Veraltet. Verwenden Sie stattdessen das stream Eigenschaft. A
streamCreated oder streamDestroyed Das Ereignis wird bei
jedem Hinzufügen oder Entfernen eines Streams ausgelöst.
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.
Für die streamDestroyed Ereignis, das vom Session-Objekt ausgelöst wird,
wird standardmäßig das Abonnement aller Subscriber-Objekte, die den Stream abonniert haben,
aufgehoben und diese aus dem HTML-DOM entfernt. Jedes Subscriber-Objekt löst ein
destroyed Ereignis, wenn das Element aus dem HTML-DOM entfernt wird. Wenn Sie die
preventDefault() Methode im Ereignis-Listener für die streamDestroyed
Ereignis wird das Standardverhalten unterbunden, und Sie können Subscriber-Objekte mithilfe Ihres
eigenen Codes bereinigen. Siehe
Session.getSubscribersForStream().
Für die streamDestroyed Wenn ein Ereignis von einem Publisher-Objekt ausgelöst wird, wird das Publisher-Objekt standardmäßig
aus dem HTML-DOM entfernt. Das Publisher-Objekt
löst ein destroyed Ereignis, wenn das Element aus dem HTML-DOM entfernt wird.
Wenn Sie die preventDefault() Methode im Ereignis-Listener für die
streamDestroyed Ereignis wird das Standardverhalten unterbunden, und Sie können
den Publisher zur Wiederverwendung beibehalten oder ihn mithilfe Ihres eigenen Codes bereinigen.
Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die cancelable Eigenschaft
des Ereignisobjekts.
Rufen Sie die preventDefault() Methode in der Ereignisbehandlungsfunktion für das Ereignis.