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

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:217

Properties

`Private` _creationTs

_creationTs: null | number = null

`Private` _enteredViaAnotherSession

_enteredViaAnotherSession: boolean = false

`Private` _participants

_participants: Map<RoomMember, Map<string, ParticipantState>> = ...

`Private` _state

_state: GroupCallState = GroupCallState.LocalCallFeedUninitialized

`Optional` activeSpeaker

activeSpeaker?: CallFeed

activeSpeakerInterval

activeSpeakerInterval: number = 1000

`Private` `Optional` activeSpeakerLoopInterval

activeSpeakerLoopInterval?: Timeout

`Private` callHandlers

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

`Private` `Readonly` calls

calls: Map<string, Map<string, MatrixCall>> = ...

`Private` client

client: MatrixClient

`Private` `Optional` dataChannelOptions

dataChannelOptions?: IGroupCallDataChannelOptions

`Private` `Optional` dataChannelsEnabled

dataChannelsEnabled?: boolean

foci

foci: IFocusInfo[] = []

groupCallId

groupCallId: string

`Private` `Optional` initCallFeedPromise

initCallFeedPromise?: Promise<void>

`Private` initWithAudioMuted

initWithAudioMuted: boolean = false

`Private` initWithVideoMuted

initWithVideoMuted: boolean = false

intent

intent: GroupCallIntent

isPtt

isPtt: boolean

`Optional` localCallFeed

localCallFeed?: LocalCallFeed

`Optional` localDesktopCapturerSourceId

localDesktopCapturerSourceId?: string

`Optional` localScreenshareFeed

localScreenshareFeed?: LocalCallFeed

participantTimeout

participantTimeout: number = ...

`Private` participantsExpirationTimer

participantsExpirationTimer: null | Timeout = null

pttMaxTransmitTime

pttMaxTransmitTime: number = ...

`Private` reEmitter

reEmitter: ReEmitter

`Private` resendMemberStateTimer

resendMemberStateTimer: null | Timer = null

`Private` retryCallCounts

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

retryCallInterval

retryCallInterval: number = 5000

`Private` `Optional` retryCallLoopInterval

retryCallLoopInterval?: Timeout

room

room: Room

`Readonly` screenshareFeeds

screenshareFeeds: CallFeed[] = []

`Private` transmitTimer

transmitTimer: null | Timeout = null

type

type: GroupCallType

`Readonly` userMediaFeeds

userMediaFeeds: CallFeed[] = []

Accessors

creationTs

get creationTs(): null | number
The timestamp at which the call was created, or null if it has not yet been created.

Returns null | number
- Defined in src/webrtc/groupCall.ts:306
set creationTs(value: null | number): void
Parameters
- value: null | number
Returns void
- Defined in src/webrtc/groupCall.ts:310

enteredViaAnotherSession

get enteredViaAnotherSession(): boolean
Whether the local device has entered this call via another session, such as a widget.

Returns boolean
- Defined in src/webrtc/groupCall.ts:320
set enteredViaAnotherSession(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/webrtc/groupCall.ts:324

participants

get participants(): Map<RoomMember, Map<string, ParticipantState>>
The current participants in the call, as a map from members to device IDs to participant info.

Returns Map<RoomMember, Map<string, ParticipantState>>
- Defined in src/webrtc/groupCall.ts:282
set participants(value: Map<RoomMember, Map<string, ParticipantState>>): void
Parameters
- value: Map<RoomMember, Map<string, ParticipantState>>
Returns void
- Defined in src/webrtc/groupCall.ts:286

state

get state(): GroupCallState
The group call's state.

Returns GroupCallState
- Defined in src/webrtc/groupCall.ts:264
set state(value: GroupCallState): void
Parameters
- value: GroupCallState
Returns void
- Defined in src/webrtc/groupCall.ts:268

Methods

`Private` addDeviceToMemberState

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

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:49

`Private` addScreenshareFeed

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

`Private` addUserMediaFeed

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

`Private` chooseFocus

chooseFocus(): void
Returns void
- Defined in src/webrtc/groupCall.ts:474

cleanMemberState

cleanMemberState(): Promise<void>
Cleans up our member state by filtering out logged out devices, inactive devices, and our own device (if we know we haven't entered).

Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:1529

create

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

`Private` dispose

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

`Private` disposeCall

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

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:56
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:57

enter

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

eventNames

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

forEachCall

forEachCall(f: ((call: MatrixCall) => void)): void
Executes the given callback on all calls in this group call.
Parameters
- f: ((call: MatrixCall) => void)
  
  The callback.
  - - (call: MatrixCall): void
    - Parameters
      
      call: MatrixCall
      
      Returns void
Returns void
- Defined in src/webrtc/groupCall.ts:333

getLocalFeeds

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

`Private` getMemberStateEvents

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

`Private` getPreferredFoci

getPreferredFoci(): IFocusInfo[]
Returns IFocusInfo[]
- Defined in src/webrtc/groupCall.ts:339

getScreenshareFeed

getScreenshareFeed(userId: string, deviceId: string): undefined | CallFeed
Parameters
- userId: string
- deviceId: string
Returns undefined | CallFeed
- Defined in src/webrtc/groupCall.ts:1292

getUserMediaFeed

getUserMediaFeed(userId: string, deviceId: string): undefined | CallFeed
Parameters
- userId: string
- deviceId: string
Returns undefined | CallFeed
- Defined in src/webrtc/groupCall.ts:1218

hasLocalParticipant

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

`Private` initCall

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

initLocalCallFeed

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

`Private` initLocalCallFeedInternal

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

isLocalVideoMuted

isLocalVideoMuted(): boolean
Returns boolean
- Defined in src/webrtc/groupCall.ts:577

isMicrophoneMuted

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

isScreensharing

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

leave

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

listenerCount

listenerCount(event: EventEmitterEvents | CallEvent | GroupCallEvent): number
Parameters
- event: EventEmitterEvents | CallEvent | GroupCallEvent
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:66

listeners

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

off

off<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.off
- Defined in src/models/typed-event-emitter.ts:74

on

on<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.on
- Defined in src/models/typed-event-emitter.ts:78

`Private` onActiveSpeakerLoop

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

`Private` onCallFeedsChanged

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

`Private` onCallHangup

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

`Private` onCallReplaced

onCallReplaced(prevCall: MatrixCall, newCall: MatrixCall): void
Parameters
- prevCall: MatrixCall
- newCall: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:1199

`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:1155

`Private` onIncomingCall

onIncomingCall(newCall: MatrixCall): void
Parameters
- newCall: MatrixCall
Returns void
- Defined in src/webrtc/groupCall.ts:795

`Private` onLocalFeedsChanged

onLocalFeedsChanged(): void
Returns void
- Defined in src/webrtc/groupCall.ts:1575

`Private` onParticipantsChanged

onParticipantsChanged(): void
Returns void
- Defined in src/webrtc/groupCall.ts:1554

`Private` onRetryCallLoop

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

`Private` onRoomState

onRoomState(): void
Returns void
- Defined in src/webrtc/groupCall.ts:1552

`Private` onStateChanged

onStateChanged(newState: GroupCallState, oldState: GroupCallState): void
Parameters
- newState: GroupCallState
- oldState: GroupCallState
Returns void
- Defined in src/webrtc/groupCall.ts:1558

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:82

`Private` placeOutgoingCalls

placeOutgoingCalls(): void
Places calls to all participants that we're responsible for calling.

Returns void
- Defined in src/webrtc/groupCall.ts:862

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:86

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:93

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:111

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:100

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:104

`Private` removeScreenshareFeed

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

`Private` removeUserMediaFeed

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

`Private` replaceScreenshareFeed

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

`Private` replaceUserMediaFeed

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

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:671

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:598

setScreensharingEnabled

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

terminate

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

`Private` updateDevices

updateDevices(fn: ((devices: IGroupCallRoomMemberDevice[]) => null | IGroupCallRoomMemberDevice[]), keepAlive?: boolean): Promise<void>
Updates the local user's member state with the devices returned by the given function.
Parameters
- fn: ((devices: IGroupCallRoomMemberDevice[]) => null | IGroupCallRoomMemberDevice[])
  
  A function from the current devices to the new devices. If it returns null, the update will be skipped.
  - - (devices: IGroupCallRoomMemberDevice[]): null | IGroupCallRoomMemberDevice[]
    - Parameters
      
      devices: IGroupCallRoomMemberDevice[]
      
      Returns null | IGroupCallRoomMemberDevice[]
- keepAlive: boolean = false
  
  Whether the request should outlive the window.
Returns Promise<void>
- Defined in src/webrtc/groupCall.ts:1425

updateLocalUsermediaStream

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

`Private` updateMemberState

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

`Private` updateParticipants

updateParticipants(): void
Recalculates and updates the participant map to match the room state.

Returns void
- Defined in src/webrtc/groupCall.ts:1334

`Private` wantsOutgoingCall

wantsOutgoingCall(userId: string, deviceId: string): boolean
Determines whether a given participant expects us to call them (versus them calling us).

Returns
Whether we need to place an outgoing call to the participant.
Parameters
- userId: string
  
  The participant's user ID.
- deviceId: string
  
  The participant's device ID.
Returns boolean
- Defined in src/webrtc/groupCall.ts:848

Class GroupCall

Hierarchy

Index

Constructors

Properties

Accessors

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

Private _creationTs

Private _enteredViaAnotherSession

Private _participants

Private _state

Optional activeSpeaker

activeSpeakerInterval

Private Optional activeSpeakerLoopInterval

Private callHandlers

Private Readonly calls

Private client

Private Optional dataChannelOptions

Private Optional dataChannelsEnabled

foci

groupCallId

Private Optional initCallFeedPromise

Private initWithAudioMuted

Private initWithVideoMuted

intent

isPtt

Optional localCallFeed

Optional localDesktopCapturerSourceId

Optional localScreenshareFeed

participantTimeout

Private participantsExpirationTimer

pttMaxTransmitTime

Private reEmitter

Private resendMemberStateTimer

Private retryCallCounts

retryCallInterval

Private Optional retryCallLoopInterval

room

Readonly screenshareFeeds

Private transmitTimer

type

Readonly userMediaFeeds

Accessors

creationTs

Returns null | number

Parameters

value: null | number

Returns void

enteredViaAnotherSession

Returns boolean

Parameters

value: boolean

Returns void

participants

Returns Map<RoomMember, Map<string, ParticipantState>>

Parameters

value: Map<RoomMember, Map<string, ParticipantState>>

Returns void

state

Returns GroupCallState

Parameters

value: GroupCallState

Returns void

Methods

Private addDeviceToMemberState

Returns Promise<void>

addListener

`Optional` groupCallId: string

`Optional` dataChannelsEnabled: boolean

`Optional` dataChannelOptions: IGroupCallDataChannelOptions

`Private` _creationTs

`Private` _enteredViaAnotherSession

`Private` _participants

`Private` _state

`Optional` activeSpeaker

`Private` `Optional` activeSpeakerLoopInterval

`Private` callHandlers

`Private` `Readonly` calls

`Private` client

`Private` `Optional` dataChannelOptions

`Private` `Optional` dataChannelsEnabled

`Private` `Optional` initCallFeedPromise

`Private` initWithAudioMuted

`Private` initWithVideoMuted

`Optional` localCallFeed

`Optional` localDesktopCapturerSourceId

`Optional` localScreenshareFeed

`Private` participantsExpirationTimer

`Private` reEmitter

`Private` resendMemberStateTimer

`Private` retryCallCounts

`Private` `Optional` retryCallLoopInterval

`Readonly` screenshareFeeds

`Private` transmitTimer

`Readonly` userMediaFeeds

`Private` addDeviceToMemberState

`Private` addScreenshareFeed

`Private` addUserMediaFeed

`Private` chooseFocus

`Private` dispose

`Private` disposeCall

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

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

`Private` getMemberStateEvents

`Private` getPreferredFoci