Class SessionDisconnectedEvent

Triggered by sessionDisconnected

Hierarchy

  • Event
    • SessionDisconnectedEvent

Properties

cancelable reason target type

Methods

isDefaultPrevented preventDefault

Properties

cancelable

cancelable: boolean

Whether the event has a default behavior that may be prevented by calling preventDefault

reason

reason: ConnectionEventReason
  • "disconnect": you have called Session.disconnect()
  • "forceDisconnectByUser": you have been evicted from the Session by other user calling Session.forceDisconnect()
  • "forceDisconnectByServer": you have been evicted from the Session by the application
  • "sessionClosedByServer": the Session has been closed by the application
  • "networkDisconnect": your network connection has dropped. Before a SessionDisconnectedEvent with this reason is triggered, Session object will always have previously dispatched a reconnecting event. If the reconnection process succeeds, Session object will dispatch a reconnected event. If it fails, Session object will dispatch a SessionDisconnectedEvent with reason "networkDisconnect"
  • "nodeCrashed": a node has crashed in the server side. You can use this reason to ask your application's backend to reconnect to a new session to replace the crashed one

target

target: Session | StreamManager | Filter

The object that dispatched the event

type

type: string

The type of event. This is the same string you pass as first parameter when calling method on() of any object implementing EventDispatcher interface

Methods

isDefaultPrevented

preventDefault

  • 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 RTCPeerConnection 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 subscribe or by calling createVideoElement). For every video removed, each Subscriber object will also dispatch a videoElementDestroyed event.

    • streamDestroyed:

      • If dispatched by a Publisher (you have unpublished): automatically stops all media tracks and deletes any HTML video element associated to it (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method initPublisher or by calling createVideoElement). For every video removed, the Publisher object will also dispatch a videoElementDestroyed event.
      • If dispatched by Session (other user has unpublished): automatically unsubscribes the proper Subscriber object from the session (this includes closing the RTCPeerConnection and disposing all MediaStreamTracks) and also deletes any HTML video element associated to that Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method subscribe or by calling createVideoElement). For every video removed, the Subscriber object will also dispatch a videoElementDestroyed event.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc