Class SignalingLayerImpl

Default XMPP implementation of the SignalingLayer interface. Obtains the data from the MUC presence.

Hierarchy

default
- SignalingLayerImpl

Constructors

constructor

new SignalingLayerImpl(): SignalingLayerImpl
Creates new instance.

Returns SignalingLayerImpl
Overrides SignalingLayer.constructor
- Defined in modules/xmpp/SignalingLayerImpl.ts:63

Methods

addCancellableListener

addCancellableListener(eventName: string, listener: EventListener): () => void
Adds new cancellable listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns () => void
- The unsubscribe function.
Inherited from SignalingLayer.addCancellableListener
- Defined in modules/util/Listenable.ts:73

addEventListener

addEventListener(eventId: string, handler: EventListener): void
Alias for on method.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from SignalingLayer.addEventListener
- Defined in modules/util/Listenable.ts:54

addListener

addListener(eventName: string, listener: EventListener): EventEmitter
Adds new listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from SignalingLayer.addListener
- Defined in modules/util/Listenable.ts:85

emit

emit(event: string, ...args: any[]): void
Emits an event.
Parameters
- event: string
  event name
- ...args: any[]
Returns void
Inherited from SignalingLayer.emit
- Defined in modules/util/Listenable.ts:104

getPeerMediaInfo

getPeerMediaInfo(
    owner: string,
    mediaType: MediaType,
    sourceName?: string,
): IPeerMediaInfo
Parameters
- owner: string
- mediaType: MediaType
- OptionalsourceName: string
Returns IPeerMediaInfo
Inherit Doc
Overrides SignalingLayer.getPeerMediaInfo
- Defined in modules/xmpp/SignalingLayerImpl.ts:241

getPeerSourceInfo

getPeerSourceInfo(owner: string, sourceName: string): ISourceInfo
Parameters
- owner: string
- sourceName: string
Returns ISourceInfo
Inherit Doc
Overrides SignalingLayer.getPeerSourceInfo
- Defined in modules/xmpp/SignalingLayerImpl.ts:286

getSSRCOwner

getSSRCOwner(ssrc: number): string
Parameters
- ssrc: number
Returns string
Inherit Doc
Overrides SignalingLayer.getSSRCOwner
- Defined in modules/xmpp/SignalingLayerImpl.ts:300

getTrackSourceName

getTrackSourceName(ssrc: number): string
Parameters
- ssrc: number
Returns string
Inherit Doc
Overrides SignalingLayer.getTrackSourceName
- Defined in modules/xmpp/SignalingLayerImpl.ts:307

listenerCount

listenerCount(eventName?: string): number
Returns the number of listeners for the specified event.
Parameters
- OptionaleventName: string
  The name of the event.
Returns number
- The number of listeners for the event.
Inherited from SignalingLayer.listenerCount
- Defined in modules/util/Listenable.ts:120

off

off(eventId: string, handler?: EventListener): void
Removes event listener.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from SignalingLayer.off
- Defined in modules/util/Listenable.ts:36

on

on(eventId: string, handler: EventListener): void
Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from SignalingLayer.on
- Defined in modules/util/Listenable.ts:27

once

once(eventId: string, handler: EventListener): void
Adds a one-time listener function for the event.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from SignalingLayer.once
- Defined in modules/util/Listenable.ts:45

removeAllListeners

removeAllListeners(): void
Removes all listeners for the event emitter.

Returns void
Inherited from SignalingLayer.removeAllListeners
- Defined in modules/util/Listenable.ts:111

removeEventListener

removeEventListener(eventId: string, handler?: EventListener): void
Alias for off method.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from SignalingLayer.removeEventListener
- Defined in modules/util/Listenable.ts:63

removeListener

removeListener(eventName: string, listener: EventListener): EventEmitter
Removes listener.
Parameters
- eventName: string
  the name of the event that triggers the listener
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from SignalingLayer.removeListener
- Defined in modules/util/Listenable.ts:96

removeSSRCOwners

removeSSRCOwners(ssrcList: number[]): void
Parameters
- ssrcList: number[]
Returns void
Inherit Doc
Overrides SignalingLayer.removeSSRCOwners
- Defined in modules/xmpp/SignalingLayerImpl.ts:314

setChatRoom

setChatRoom(room: ChatRoom): void
Sets the ChatRoom instance used and binds presence listeners.
Parameters
- room: ChatRoom
Returns void
- Defined in modules/xmpp/SignalingLayerImpl.ts:328

setSSRCOwner

setSSRCOwner(ssrc: number, newEndpointId: string, newSourceName: string): void
Parameters
- ssrc: number
- newEndpointId: string
- newSourceName: string
Returns void
Inherit Doc
Overrides SignalingLayer.setSSRCOwner
- Defined in modules/xmpp/SignalingLayerImpl.ts:353

setTrackMuteStatus

setTrackMuteStatus(sourceName: string, muted: boolean): boolean
Parameters
- sourceName: string
- muted: boolean
Returns boolean
Inherit Doc
Overrides SignalingLayer.setTrackMuteStatus
- Defined in modules/xmpp/SignalingLayerImpl.ts:380

setTrackVideoType

setTrackVideoType(sourceName: string, videoType: VideoType): boolean
Parameters
- sourceName: string
- videoType: VideoType
Returns boolean
Inherit Doc
Overrides SignalingLayer.setTrackVideoType
- Defined in modules/xmpp/SignalingLayerImpl.ts:398

updateSsrcOwnersOnLeave

updateSsrcOwnersOnLeave(id: string): void
Parameters
- id: string
Returns void
Inherit Doc
Overrides SignalingLayer.updateSsrcOwnersOnLeave
- Defined in modules/xmpp/SignalingLayerImpl.ts:416