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

Constructors

constructor

Properties

_creationTs _enteredViaAnotherSession _participants _state activeSpeaker? activeSpeakerInterval activeSpeakerLoopInterval? allowCallWithoutVideoAndAudio callHandlers calls client dataChannelOptions? dataChannelsEnabled? groupCallId initCallFeedPromise? initWithAudioMuted initWithVideoMuted intent isPtt localCallFeed? localDesktopCapturerSourceId? localScreenshareFeed? participantTimeout participantsExpirationTimer pttMaxTransmitTime reEmitter resendMemberStateTimer retryCallCounts retryCallInterval retryCallLoopInterval? room screenshareFeeds stats transmitTimer type userMediaFeeds

Accessors

creationTs enteredViaAnotherSession participants state

Methods

addDeviceToMemberState addListener addScreenshareFeed addUserMediaFeed callExpected cleanMemberState create dispose disposeCall emit enter eventNames forEachCall getGroupCallStats getLocalFeeds getMemberStateEvents getScreenshareFeed getUserMediaFeed hasLocalParticipant initCall initLocalCallFeed initLocalCallFeedInternal isLocalVideoMuted isMicrophoneMuted isScreensharing leave listenerCount listeners off on onActiveSpeakerLoop onByteSentStats onCallFeedsChanged onCallHangup onCallReplaced onCallStateChanged onConnectionStats onIncomingCall onLocalFeedsChanged onParticipantsChanged onRetryCallLoop onRoomState onStateChanged onSummaryStats once placeOutgoingCalls prependListener prependOnceListener rawListeners removeAllListeners removeListener removeScreenshareFeed removeUserMediaFeed replaceScreenshareFeed replaceUserMediaFeed setLocalVideoMuted setMicrophoneMuted setScreensharingEnabled terminate updateDevices updateLocalUsermediaStream updateMemberState updateParticipants wantsOutgoingCall

Constructors

constructor

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

Readonly allowCallWithoutVideoAndAudio

allowCallWithoutVideoAndAudio: boolean

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

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?: CallFeed

Optional localDesktopCapturerSourceId

localDesktopCapturerSourceId?: string

Optional localScreenshareFeed

localScreenshareFeed?: CallFeed

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 Readonly stats

stats: GroupCallStats

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

  • set creationTs(value: null | number): void

  • Parameters

    • value: null | number

    Returns void

enteredViaAnotherSession

  • get enteredViaAnotherSession(): boolean

  • Whether the local device has entered this call via another session, such as a widget.

    Returns boolean

  • set enteredViaAnotherSession(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

participants

state

Methods

Private addDeviceToMemberState

addListener

Private addScreenshareFeed

Private addUserMediaFeed

Private callExpected

  • Determines whether the given call is one that we were expecting to exist given our knowledge of who is participating in the group call.

    Parameters

    Returns boolean

cleanMemberState

  • 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>

create

Private dispose

Private disposeCall

emit

enter

eventNames

forEachCall

getGroupCallStats

getLocalFeeds

Private getMemberStateEvents

getScreenshareFeed

getUserMediaFeed

hasLocalParticipant

Private initCall

initLocalCallFeed

Private initLocalCallFeedInternal

isLocalVideoMuted

isMicrophoneMuted

isScreensharing

leave

listenerCount

listeners

off

on

Private onActiveSpeakerLoop

Private onByteSentStats

Private onCallFeedsChanged

Private onCallHangup

Private onCallReplaced

Private onCallStateChanged

Private onConnectionStats

Private onIncomingCall

Private onLocalFeedsChanged

Private onParticipantsChanged

Private onRetryCallLoop

Private onRoomState

Private onStateChanged

Private onSummaryStats

once

Private placeOutgoingCalls

  • Places calls to all participants that we're responsible for calling.

    Returns void

prependListener

prependOnceListener

rawListeners

removeAllListeners

removeListener

Private removeScreenshareFeed

Private removeUserMediaFeed

Private replaceScreenshareFeed

Private replaceUserMediaFeed

setLocalVideoMuted

  • 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>

setMicrophoneMuted

  • 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>

setScreensharingEnabled

terminate

  • Parameters

    • emitStateEvent: boolean = true

    Returns Promise<void>

Private updateDevices

updateLocalUsermediaStream

  • Parameters

    • stream: MediaStream

    Returns Promise<void>

Private updateMemberState

Private updateParticipants

  • Recalculates and updates the participant map to match the room state.

    Returns void

Private wantsOutgoingCall

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc