Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SignalEvent

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

data

data: string

The message of the signal (can be emtpy)

from

The client that sent the signal

target

The object that dispatched the event

type

type: string

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.

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