Class GroupCall

Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.

Hierarchy

TypedEventEmitter<GroupCallEvent | CallEvent, GroupCallEventHandlerMap & CallEventHandlerMap>
- GroupCall

Index

Constructors

constructor

Methods

addCall addListener addParticipant addScreenshareFeed addUserMediaFeed create dispose disposeCall emit enter eventNames getCallByUserId getDeviceForMember getLocalFeeds getMemberStateEvents getScreenshareFeedByUserId getUserMediaFeedByUserId hasLocalParticipant initCall initLocalCallFeed isLocalVideoMuted isMicrophoneMuted isScreensharing leave listenerCount listeners off on onActiveSpeakerLoop onCallFeedsChanged onCallHangup onCallStateChanged onIncomingCall onMemberStateChanged onRetryCallLoop once prependListener prependOnceListener rawListeners removeAllListeners removeCall removeListener removeMemberStateEvent removeParticipant removeScreenshareFeed removeUserMediaFeed replaceCall replaceScreenshareFeed replaceUserMediaFeed sendMemberStateEvent setLocalVideoMuted setMicrophoneMuted setScreensharingEnabled setState terminate updateLocalUsermediaStream updateMemberCallState

Constructors

constructor

new GroupCall(client: MatrixClient, room: Room, type: GroupCallType, isPtt: boolean, intent: GroupCallIntent, groupCallId?: string, dataChannelsEnabled?: boolean, dataChannelOptions?: IGroupCallDataChannelOptions): GroupCall
Parameters
- client: MatrixClient
- room: Room
- type: GroupCallType
- isPtt: boolean
- intent: GroupCallIntent
- Optional groupCallId: string
- Optional dataChannelsEnabled: boolean
- Optional dataChannelOptions: IGroupCallDataChannelOptions
Returns GroupCall
Overrides TypedEventEmitter.constructor
- Defined in src/webrtc/groupCall.ts:190

Properties

`Optional` activeSpeaker

activeSpeaker?: string

activeSpeakerInterval

activeSpeakerInterval: number = 1000

`Private` `Optional` activeSpeakerLoopTimeout

activeSpeakerLoopTimeout?: Timeout

`Private` callHandlers

callHandlers: Map<string, ICallHandlers> = ...

calls

calls: MatrixCall[] = []

`Private` client

client: MatrixClient

`Private` `Optional` dataChannelOptions

dataChannelOptions?: IGroupCallDataChannelOptions

`Private` `Optional` dataChannelsEnabled

dataChannelsEnabled?: boolean

groupCallId

groupCallId: string

`Private` initWithAudioMuted

initWithAudioMuted: boolean = false

`Private` initWithVideoMuted

initWithVideoMuted: boolean = false

intent

intent: GroupCallIntent

isPtt

isPtt: boolean

`Optional` localCallFeed

localCallFeed?: CallFeed

`Optional` localDesktopCapturerSourceId

localDesktopCapturerSourceId?: string

`Optional` localScreenshareFeed

localScreenshareFeed?: CallFeed

`Private` memberStateExpirationTimers

memberStateExpirationTimers: Map<string, Timeout> = ...

participantTimeout

participantTimeout: number = ...

participants

participants: RoomMember[] = []

pttMaxTransmitTime

pttMaxTransmitTime: number = ...

`Private` reEmitter

reEmitter: ReEmitter

`Private` resendMemberStateTimer

resendMemberStateTimer: null | Timer = null

`Private` retryCallCounts

retryCallCounts: Map<string, number> = ...

retryCallInterval

retryCallInterval: number = 5000

`Private` `Optional` retryCallLoopTimeout

retryCallLoopTimeout?: Timeout

room

room: Room

screenshareFeeds

screenshareFeeds: CallFeed[] = []

state

state: GroupCallState = GroupCallState.LocalCallFeedUninitialized

`Private` transmitTimer

transmitTimer: null | Timeout = null

type

type: GroupCallType

userMediaFeeds

userMediaFeeds: CallFeed[] = []

Methods

`Private` addCall

addCall(call: MatrixCall): void
Parameters
- call: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:979

addListener

addListener<T>(event: T, listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>): GroupCall
Type Parameters
- T extends EventEmitterEvents | CallEvent | GroupCallEvent
Parameters
- event: T
- listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>
Returns GroupCall
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:51

`Private` addParticipant

addParticipant(member: RoomMember): void
Participant Management
Parameters
- member: RoomMember
Returns void
- Defined in src/webrtc/groupCall.ts:1281

`Private` addScreenshareFeed

addScreenshareFeed(callFeed: CallFeed): void
Parameters
- callFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1246

`Private` addUserMediaFeed

addUserMediaFeed(callFeed: CallFeed): void
Parameters
- callFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1162

create

create(): Promise<GroupCall>
Returns Promise<GroupCall>
- Defined in src/webrtc/groupCall.ts:209

`Private` dispose

dispose(): void
Returns void
- Defined in src/webrtc/groupCall.ts:357

`Private` disposeCall

disposeCall(call: MatrixCall, hangupReason: CallErrorCode): void
Parameters
- call: MatrixCall
- hangupReason: CallErrorCode
Returns void
- Defined in src/webrtc/groupCall.ts:1044

emit

emit<T>(event: T, ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>): boolean
Type Parameters
- T extends CallEvent | GroupCallEvent
Parameters
- event: T
- Rest ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:58
emit<T>(event: T, ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>): boolean
Type Parameters
- T extends CallEvent | GroupCallEvent
Parameters
- event: T
- Rest ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:59

enter

enter(): Promise<void>
Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:318

eventNames

eventNames(): (EventEmitterEvents | CallEvent | GroupCallEvent)[]
Returns (EventEmitterEvents | CallEvent | GroupCallEvent)[]
Inherited from TypedEventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:64

getCallByUserId

getCallByUserId(userId: string): undefined | MatrixCall
Call Event Handlers
Parameters
- userId: string
Returns undefined | MatrixCall
- Defined in src/webrtc/groupCall.ts:975

getDeviceForMember

getDeviceForMember(userId: string): undefined | IGroupCallRoomMemberDevice
Parameters
- userId: string
Returns undefined | IGroupCallRoomMemberDevice
- Defined in src/webrtc/groupCall.ts:931

getLocalFeeds

getLocalFeeds(): CallFeed[]
Returns CallFeed[]
- Defined in src/webrtc/groupCall.ts:235

`Private` getMemberStateEvents

getMemberStateEvents(): MatrixEvent[]
Room Member State

Returns MatrixEvent[]
- Defined in src/webrtc/groupCall.ts:698
getMemberStateEvents(userId: string): null | MatrixEvent
Parameters
- userId: string
Returns null | MatrixEvent
- Defined in src/webrtc/groupCall.ts:699

getScreenshareFeedByUserId

getScreenshareFeedByUserId(userId: string): undefined | CallFeed
Screenshare Call Feed Event Handlers
Parameters
- userId: string
Returns undefined | CallFeed
- Defined in src/webrtc/groupCall.ts:1242

getUserMediaFeedByUserId

getUserMediaFeedByUserId(userId: string): undefined | CallFeed
UserMedia CallFeed Event Handlers
Parameters
- userId: string
Returns undefined | CallFeed
- Defined in src/webrtc/groupCall.ts:1158

hasLocalParticipant

hasLocalParticipant(): boolean
Returns boolean
- Defined in src/webrtc/groupCall.ts:244

`Private` initCall

initCall(call: MatrixCall): void
Parameters
- call: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:1014

initLocalCallFeed

initLocalCallFeed(): Promise<CallFeed>
Returns Promise<CallFeed>
- Defined in src/webrtc/groupCall.ts:249

isLocalVideoMuted

isLocalVideoMuted(): boolean
Local Usermedia

Returns boolean
- Defined in src/webrtc/groupCall.ts:448

isMicrophoneMuted

isMicrophoneMuted(): boolean
Returns boolean
- Defined in src/webrtc/groupCall.ts:456

isScreensharing

isScreensharing(): boolean
Returns boolean
- Defined in src/webrtc/groupCall.ts:641

leave

leave(): void
Returns void
- Defined in src/webrtc/groupCall.ts:403

`Private` onActiveSpeakerLoop

onActiveSpeakerLoop(): void
Returns void
- Defined in src/webrtc/groupCall.ts:1203

`Private` onCallFeedsChanged

onCallFeedsChanged(call: MatrixCall): void
Parameters
- call: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:1086

`Private` onCallHangup

onCallHangup(call: MatrixCall): void
Parameters
- call: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:1146

`Private` onCallStateChanged

onCallStateChanged(call: MatrixCall, state: CallState, _oldState: undefined | CallState): void
Parameters
- call: MatrixCall
- state: CallState
- _oldState: undefined | CallState
Returns void
- Defined in src/webrtc/groupCall.ts:1122

`Private` onIncomingCall

onIncomingCall(newCall: MatrixCall): void
Call Setup

There are two different paths for calls to be created:
1. Incoming calls triggered by the Call.incoming event.
2. Outgoing calls to the initial members of a room or new members as they are observed by the RoomState.members event.
Parameters
- newCall: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:654

onMemberStateChanged

onMemberStateChanged(event: MatrixEvent): Promise<void>
Parameters
- event: MatrixEvent
Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:782

`Private` onRetryCallLoop

onRetryCallLoop(): void
Returns void
- Defined in src/webrtc/groupCall.ts:956

once

once<T>(event: T, listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>): GroupCall
Type Parameters
- T extends EventEmitterEvents | CallEvent | GroupCallEvent
Parameters
- event: T
- listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>
Returns GroupCall
Inherited from TypedEventEmitter.once
- Defined in src/models/typed-event-emitter.ts:90

prependListener

prependListener<T>(event: T, listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>): GroupCall
Type Parameters
- T extends EventEmitterEvents | CallEvent | GroupCallEvent
Parameters
- event: T
- listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>
Returns GroupCall
Inherited from TypedEventEmitter.prependListener
- Defined in src/models/typed-event-emitter.ts:97

prependOnceListener

prependOnceListener<T>(event: T, listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>): GroupCall
Type Parameters
- T extends EventEmitterEvents | CallEvent | GroupCallEvent
Parameters
- event: T
- listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>
Returns GroupCall
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/models/typed-event-emitter.ts:104

rawListeners

rawListeners(event: EventEmitterEvents | CallEvent | GroupCallEvent): Function[]
Parameters
- event: EventEmitterEvents | CallEvent | GroupCallEvent
Returns Function[]
Inherited from TypedEventEmitter.rawListeners
- Defined in src/models/typed-event-emitter.ts:122

removeAllListeners

removeAllListeners(event?: EventEmitterEvents | CallEvent | GroupCallEvent): GroupCall
Parameters
- Optional event: EventEmitterEvents | CallEvent | GroupCallEvent
Returns GroupCall
Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/models/typed-event-emitter.ts:111

`Private` removeCall

removeCall(call: MatrixCall, hangupReason: CallErrorCode): void
Parameters
- call: MatrixCall
- hangupReason: CallErrorCode
Returns void
- Defined in src/webrtc/groupCall.ts:1000

removeListener

removeListener<T>(event: T, listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>): GroupCall
Type Parameters
- T extends EventEmitterEvents | CallEvent | GroupCallEvent
Parameters
- event: T
- listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>
Returns GroupCall
Inherited from TypedEventEmitter.removeListener
- Defined in src/models/typed-event-emitter.ts:115

`Private` removeMemberStateEvent

removeMemberStateEvent(): Promise<ISendEventResponse>
Returns Promise<ISendEventResponse>
- Defined in src/webrtc/groupCall.ts:739

`Private` removeParticipant

removeParticipant(member: RoomMember): void
Parameters
- member: RoomMember
Returns void
- Defined in src/webrtc/groupCall.ts:1292

`Private` removeScreenshareFeed

removeScreenshareFeed(callFeed: CallFeed): void
Parameters
- callFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1264

`Private` removeUserMediaFeed

removeUserMediaFeed(callFeed: CallFeed): void
Parameters
- callFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1182

`Private` replaceCall

replaceCall(existingCall: MatrixCall, replacementCall: MatrixCall, hangupReason?: CallErrorCode): void
Parameters
- existingCall: MatrixCall
- replacementCall: MatrixCall
- hangupReason: CallErrorCode = CallErrorCode.Replaced
Returns void
- Defined in src/webrtc/groupCall.ts:985

`Private` replaceScreenshareFeed

replaceScreenshareFeed(existingFeed: CallFeed, replacementFeed: CallFeed): void
Parameters
- existingFeed: CallFeed
- replacementFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1251

`Private` replaceUserMediaFeed

replaceUserMediaFeed(existingFeed: CallFeed, replacementFeed: CallFeed): void
Parameters
- existingFeed: CallFeed
- replacementFeed: CallFeed
Returns void
- Defined in src/webrtc/groupCall.ts:1168

`Private` sendMemberStateEvent

sendMemberStateEvent(): Promise<ISendEventResponse>
Returns Promise<ISendEventResponse>
- Defined in src/webrtc/groupCall.ts:710

setLocalVideoMuted

setLocalVideoMuted(muted: boolean): Promise<boolean>
Sets the mute state of the local participants's video.

Returns
Whether muting/unmuting was successful
Parameters
- muted: boolean
  
  Whether to mute the video
Returns Promise<boolean>
- Defined in src/webrtc/groupCall.ts:540

setMicrophoneMuted

setMicrophoneMuted(muted: boolean): Promise<boolean>
Sets the mute state of the local participants's microphone.

Returns
Whether muting/unmuting was successful
Parameters
- muted: boolean
  
  Whether to mute the microphone
Returns Promise<boolean>
- Defined in src/webrtc/groupCall.ts:469

setScreensharingEnabled

setScreensharingEnabled(enabled: boolean, opts?: IScreensharingOpts): Promise<boolean>
Parameters
- enabled: boolean
- opts: IScreensharingOpts = {}
Returns Promise<boolean>
- Defined in src/webrtc/groupCall.ts:566

`Private` setState

setState(newState: GroupCallState): void
Parameters
- newState: GroupCallState
Returns void
- Defined in src/webrtc/groupCall.ts:229

terminate

terminate(emitStateEvent?: boolean): Promise<void>
Parameters
- emitStateEvent: boolean = true
Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:413

updateLocalUsermediaStream

updateLocalUsermediaStream(stream: MediaStream): Promise<void>
Parameters
- stream: MediaStream
Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:303

`Private` updateMemberCallState

updateMemberCallState(memberCallState?: IGroupCallRoomMemberCallState, keepAlive?: boolean): Promise<ISendEventResponse>
Parameters
- Optional memberCallState: IGroupCallRoomMemberCallState
- keepAlive: boolean = false
Returns Promise<ISendEventResponse>
- Defined in src/webrtc/groupCall.ts:745

Class GroupCall

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: MatrixClient

room: Room

type: GroupCallType

isPtt: boolean

intent: GroupCallIntent

Optional groupCallId: string

Optional dataChannelsEnabled: boolean

Optional dataChannelOptions: IGroupCallDataChannelOptions

Returns GroupCall

Properties

Optional activeSpeaker

activeSpeakerInterval

Private Optional activeSpeakerLoopTimeout

Private callHandlers

calls

Private client

Private Optional dataChannelOptions

Private Optional dataChannelsEnabled

groupCallId

Private initWithAudioMuted

Private initWithVideoMuted

intent

isPtt

Optional localCallFeed

Optional localDesktopCapturerSourceId

Optional localScreenshareFeed

Private memberStateExpirationTimers

participantTimeout

participants

pttMaxTransmitTime

Private reEmitter

Private resendMemberStateTimer

Private retryCallCounts

retryCallInterval

Private Optional retryCallLoopTimeout

room

screenshareFeeds

state

Private transmitTimer

type

userMediaFeeds

Methods

Private addCall

Parameters

call: MatrixCall

Returns void

addListener

Type Parameters

T extends EventEmitterEvents | CallEvent | GroupCallEvent

Parameters

event: T

listener: Listener<CallEvent | GroupCallEvent, GroupCallEventHandlerMap & CallEventHandlerMap, T>

Returns GroupCall

Private addParticipant

Parameters

member: RoomMember

Returns void

Private addScreenshareFeed

Parameters

callFeed: CallFeed

Returns void

Private addUserMediaFeed

Parameters

callFeed: CallFeed

Returns void

create

Returns Promise<GroupCall>

Private dispose

Returns void

Private disposeCall

Parameters

`Optional` groupCallId: string

`Optional` dataChannelsEnabled: boolean

`Optional` dataChannelOptions: IGroupCallDataChannelOptions

`Optional` activeSpeaker

`Private` `Optional` activeSpeakerLoopTimeout

`Private` callHandlers

`Private` client

`Private` `Optional` dataChannelOptions

`Private` `Optional` dataChannelsEnabled

`Private` initWithAudioMuted

`Private` initWithVideoMuted

`Optional` localCallFeed

`Optional` localDesktopCapturerSourceId

`Optional` localScreenshareFeed

`Private` memberStateExpirationTimers

`Private` reEmitter

`Private` resendMemberStateTimer

`Private` retryCallCounts

`Private` `Optional` retryCallLoopTimeout

`Private` transmitTimer

`Private` addCall

`Private` addParticipant

`Private` addScreenshareFeed

`Private` addUserMediaFeed

`Private` dispose

`Private` disposeCall

`Rest` ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>

`Rest` ...args: Parameters<(GroupCallEventHandlerMap & CallEventHandlerMap)[T]>

`Private` getMemberStateEvents

`Private` initCall