Whether the event has a default behavior that may be prevented by calling Event.preventDefault
The property of the stream that changed. This value is either "role"
or "record"
The Connection whose property has changed
New value of the property (after change, current value)
Previous value of the property (before change)
The object that dispatched the event
The type of event. This is the same string you pass as first parameter when calling method on()
of any object implementing EventDispatcher interface
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
This feature is part of OpenVidu Pro tier PRO
Defines event
connectionPropertyChanged
dispatched by Session object. This event is fired when any property of the local Connection object changes. The properties that may change are Connection.role and Connection.record.The only way the Connection properties may change is by updating them through: