Whether the event has a default behaviour 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 behaviour of the event. The following events have a default behaviour:
sessionDisconnected
: 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 the HTML video element associated to it.streamDestroyed
: if dispatched by a Publisher (you have unpublished), automatically stops all media tracks and deletes the HTML video element associated to the stream. If dispatched by Session,
(other user has unpublished), automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and deletes the HTML video element associated to it.Generated using TypeDoc
Defines the following events:
signal
: dispatched by Sessionsignal:TYPE
: dispatched by Session