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 behaviour 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
  • "networkDisconnect": the user's network connection has dropped

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 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.

    Returns void

Generated using TypeDoc