Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamEvent

Defines the following events:

Hierarchy

Index

Properties

cancelable

cancelable: boolean

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

reason

reason: string

For 'streamDestroyed' event:

  • "unpublish": method Session.unpublish() has been called
  • "disconnect": method Session.disconnect() has been called
  • "forceUnpublishByUser": some user has called Session.forceUnpublish() over the Stream
  • "forceDisconnectByUser": some user has called Session.forceDisconnect() over the Stream
  • "forceUnpublishByServer": the user's stream has been unpublished from the Session by the application
  • "forceDisconnectByServer": the user has been evicted from the Session by the application
  • "sessionClosedByServer": the Session has been closed by the application
  • "networkDisconnect": the user's network connection has dropped
  • "mediaServerDisconnect": OpenVidu Media Server has crashed or lost its connection. A new media server instance is active and no media streams are available in the media server

For 'streamCreated' empty string

stream

stream: Stream

Stream object that was created or destroyed

target

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

  • isDefaultPrevented(): boolean

preventDefault

  • preventDefault(): void
  • 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:

      • 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 OpenVidu.initPublisher or by calling Publisher.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 WebRTCPeer connection 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 Session.subscribe or by calling Subscriber.createVideoElement). For every video removed, the Subscriber object will also dispatch a videoElementDestroyed event.

    Returns void

Generated using TypeDoc