Class FishjamWSNotifier

Notifier object that can be used to get notified about various events related to the Fishjam App.

Hierarchy

TypedEventEmitter<NotificationEvents, this>
- FishjamWSNotifier

Index

Constructors

Methods

addListener disconnect emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners

Constructors

constructor

new FishjamWSNotifier(
    config: FishjamConfig,
    onError: ErrorEventHandler,
    onClose: CloseEventHandler,
): FishjamWSNotifier
Parameters
- config: FishjamConfig
- onError: ErrorEventHandler
- onClose: CloseEventHandler
Returns FishjamWSNotifier
Overrides (EventEmitter as new () => TypedEmitter<NotificationEvents>).constructor
- Defined in packages/js-server-sdk/src/ws_notifier.ts:15

Methods

addListener

addListener<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).addListener
- Defined in node_modules/typed-emitter/index.d.ts:22

disconnect

disconnect(): void
Close the underlying WebSocket and stop emitting notifications.

Returns void
- Defined in packages/js-server-sdk/src/ws_notifier.ts:34

emit

emit<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    ...args: Parameters<NotificationEvents[E]>,
): boolean
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- ...args: Parameters<NotificationEvents[E]>
Returns boolean
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).emit
- Defined in node_modules/typed-emitter/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).eventNames
- Defined in node_modules/typed-emitter/index.d.ts:34

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:39

listenerCount

listenerCount<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
): number
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:37

listeners

listeners<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
): NotificationEvents[E][]
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
Returns NotificationEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).listeners
- Defined in node_modules/typed-emitter/index.d.ts:36

off

off<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).off
- Defined in node_modules/typed-emitter/index.d.ts:28

on

on<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).on
- Defined in node_modules/typed-emitter/index.d.ts:23

once

once<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).once
- Defined in node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).prependListener
- Defined in node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
): NotificationEvents[E][]
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
Returns NotificationEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:35

removeAllListeners

removeAllListeners<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event?: E,
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- Optionalevent: E
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<
    E extends
        | "roomCreated"
        | "roomDeleted"
        | "roomCrashed"
        | "peerAdded"
        | "peerDeleted"
        | "peerConnected"
        | "peerDisconnected"
        | "peerMetadataUpdated"
        | "peerCrashed"
        | "streamerConnected"
        | "streamerDisconnected"
        | "viewerConnected"
        | "viewerDisconnected"
        | "trackAdded"
        | "trackRemoved"
        | "trackMetadataUpdated"
        | "trackForwarding"
        | "trackForwardingRemoved"
        | "vadNotification"
        | "channelAdded"
        | "channelRemoved",
>(
    event: E,
    listener: NotificationEvents[E],
): this
Type Parameters
- E extends
      | "roomCreated"
      | "roomDeleted"
      | "roomCrashed"
      | "peerAdded"
      | "peerDeleted"
      | "peerConnected"
      | "peerDisconnected"
      | "peerMetadataUpdated"
      | "peerCrashed"
      | "streamerConnected"
      | "streamerDisconnected"
      | "viewerConnected"
      | "viewerDisconnected"
      | "trackAdded"
      | "trackRemoved"
      | "trackMetadataUpdated"
      | "trackForwarding"
      | "trackForwardingRemoved"
      | "vadNotification"
      | "channelAdded"
      | "channelRemoved"
Parameters
- event: E
- listener: NotificationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).removeListener
- Defined in node_modules/typed-emitter/index.d.ts:30

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<NotificationEvents>).setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40

Class FishjamWSNotifier

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FishjamWSNotifier

Methods

addListener

Type Parameters

Parameters

Returns this

disconnect

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns NotificationEvents[E][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

Returns NotificationEvents[E][]

removeAllListeners

Type Parameters

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

setMaxListeners

Parameters

Returns this

Settings

On This Page