Whether the event has a default behavior that may be prevented by calling Event.preventDefault
The message of the signal (can be emtpy)
The client that sent the signal
The object that dispatched the event
The type of signal (can be empty).
The client must be subscribed to Session.on('signal:type', function(signalEvent) {...}) to receive this object in the callback.
Subscribing to Session.on('signal', function(signalEvent) {...}) will trigger all types of signals.
Whether the default beahivour of the event has been prevented or not. Call Event.preventDefault to prevent it
Prevents the default behavior of the event. The following events have a default behavior:
sessionDisconnected: dispatched by Session object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
and also deletes any HTML video element associated to each Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method Session.subscribe or
by calling Subscriber.createVideoElement). For every video removed, each Subscriber object will also dispatch a videoElementDestroyed event.
streamDestroyed:
targetElement
in method OpenVidu.initPublisher or by calling Publisher.createVideoElement). For every video removed, the Publisher object will also dispatch a videoElementDestroyed event.targetElement in method Session.subscribe or
by calling Subscriber.createVideoElement). For every video removed, the Subscriber object will also dispatch a videoElementDestroyed event.Generated using TypeDoc
Defines the following events:
signal: dispatched by Sessionsignal:TYPE: dispatched by Session