DigitalWorldCall

Defined in: src/webrtc/call.ts:355

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.

Type parameters:

Events - List of all events emitted by this TypedEventEmitter. Normally an enum type.
Arguments - A ListenerMap type providing mappings from event names to listener types.
SuperclassArguments - TODO: not really sure. Alternative listener mappings, I think? But only honoured for .emit?

Extends

TypedEventEmitter<CallEvent, CallEventHandlerMap>

Properties

callId

callId: string

Defined in: src/webrtc/call.ts:357

direction?

optional direction?: CallDirection

Defined in: src/webrtc/call.ts:361

groupCallId?

optional groupCallId?: string

Defined in: src/webrtc/call.ts:429

hangupParty?

optional hangupParty?: CallParty

Defined in: src/webrtc/call.ts:359

hangupReason?

optional hangupReason?: string

Defined in: src/webrtc/call.ts:360

invitee?

optional invitee?: string

Defined in: src/webrtc/call.ts:358

isPtt

isPtt: boolean = false

Defined in: src/webrtc/call.ts:368

ourPartyId

ourPartyId: string

Defined in: src/webrtc/call.ts:362

peerConn?

optional peerConn?: RTCPeerConnection

Defined in: src/webrtc/call.ts:363

roomId

roomId: string

Defined in: src/webrtc/call.ts:356

toDeviceSeq

toDeviceSeq: number = 0

Defined in: src/webrtc/call.ts:364

Accessors

hasLocalUserMediaAudioTrack

Get Signature

get hasLocalUserMediaAudioTrack(): boolean

Defined in: src/webrtc/call.ts:549

Returns

boolean

hasLocalUserMediaVideoTrack

Get Signature

get hasLocalUserMediaVideoTrack(): boolean

Defined in: src/webrtc/call.ts:539

Returns

boolean

hasPeerConnection

Get Signature

get hasPeerConnection(): boolean

Defined in: src/webrtc/call.ts:2976

Returns

boolean

hasRemoteUserMediaAudioTrack

Get Signature

get hasRemoteUserMediaAudioTrack(): boolean

Defined in: src/webrtc/call.ts:553

Returns

boolean

hasRemoteUserMediaVideoTrack

Get Signature

get hasRemoteUserMediaVideoTrack(): boolean

Defined in: src/webrtc/call.ts:543

Returns

boolean

localScreensharingFeed

Get Signature

get localScreensharingFeed(): CallFeed | undefined

Defined in: src/webrtc/call.ts:571

Returns

CallFeed | undefined

localScreensharingStream

Get Signature

get localScreensharingStream(): MediaStream | undefined

Defined in: src/webrtc/call.ts:579

Returns

MediaStream | undefined

localUsermediaFeed

Get Signature

get localUsermediaFeed(): CallFeed | undefined

Defined in: src/webrtc/call.ts:567

Returns

CallFeed | undefined

localUsermediaStream

Get Signature

get localUsermediaStream(): MediaStream | undefined

Defined in: src/webrtc/call.ts:575

Returns

MediaStream | undefined

remoteScreensharingFeed

Get Signature

get remoteScreensharingFeed(): CallFeed | undefined

Defined in: src/webrtc/call.ts:587

Returns

CallFeed | undefined

remoteScreensharingStream

Get Signature

get remoteScreensharingStream(): MediaStream | undefined

Defined in: src/webrtc/call.ts:595

Returns

MediaStream | undefined

remoteUsermediaFeed

Get Signature

get remoteUsermediaFeed(): CallFeed | undefined

Defined in: src/webrtc/call.ts:583

Returns

CallFeed | undefined

remoteUsermediaStream

Get Signature

get remoteUsermediaStream(): MediaStream | undefined

Defined in: src/webrtc/call.ts:591

Returns

MediaStream | undefined

state

Get Signature

get state(): CallState

Defined in: src/webrtc/call.ts:523

Returns

CallState

Set Signature

set state(state): void

Defined in: src/webrtc/call.ts:527

Parameters

state

CallState

Returns

void

type

Get Signature

get type(): CallType

Defined in: src/webrtc/call.ts:533

Returns

CallType

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, …args): void

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:103

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

…AnyRest

Returns

void

Inherited from

TypedEventEmitter.[captureRejectionSymbol]

addListener()

addListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:70

Alias for on.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

listener

Listener<CallEvent, CallEventHandlerMap, T>

Returns

this

Inherited from

TypedEventEmitter.addListener

answer()

answer(audio?, video?): Promise<void>

Defined in: src/webrtc/call.ts:1065

Answer a call.

Parameters

audio?

boolean

video?

boolean

Returns

Promise<void>

answerWithCallFeeds()

answerWithCallFeeds(callFeeds): void

Defined in: src/webrtc/call.ts:1118

Parameters

callFeeds

CallFeed[]

Returns

void

callHasEnded()

callHasEnded(): boolean

Defined in: src/webrtc/call.ts:2067

Returns

boolean

createDataChannel()

createDataChannel(label, options): RTCDataChannel

Defined in: src/webrtc/call.ts:493

Create a datachannel using this call’s peer connection.

Parameters

label

string

A human readable label for this datachannel

options

RTCDataChannelInit | undefined

An object providing configuration options for the data channel.

Returns

RTCDataChannel

emit()

Call Signature

emit<T>(event, …args): boolean

Defined in: src/models/typed-event-emitter.ts:86

Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

Type Parameters

T

T extends CallEvent

Parameters

event

T

The name of the event to emit

args

…Parameters<CallEventHandlerMap[T]>

Arguments to pass to the listener

Returns

boolean

true if the event had listeners, false otherwise.

Inherited from

TypedEventEmitter.emit

Call Signature

emit<T>(event, …args): boolean

Defined in: src/models/typed-event-emitter.ts:87

Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

Type Parameters

T

T extends CallEvent

Parameters

event

T

The name of the event to emit

args

…Parameters<CallEventHandlerMap[T]>

Arguments to pass to the listener

Returns

boolean

true if the event had listeners, false otherwise.

Inherited from

TypedEventEmitter.emit

emitPromised()

Call Signature

emitPromised<T>(event, …args): Promise<boolean>

Defined in: src/models/typed-event-emitter.ts:98

Similar to emit but calls all listeners within a Promise.all and returns the promise chain

Type Parameters

T

T extends CallEvent

Parameters

event

T

The name of the event to emit

args

…Parameters<CallEventHandlerMap[T]>

Arguments to pass to the listener

Returns

Promise<boolean>

true if the event had listeners, false otherwise.

Inherited from

TypedEventEmitter.emitPromised

Call Signature

emitPromised<T>(event, …args): Promise<boolean>

Defined in: src/models/typed-event-emitter.ts:102

Similar to emit but calls all listeners within a Promise.all and returns the promise chain

Type Parameters

T

T extends CallEvent

Parameters

event

T

The name of the event to emit

args

…Parameters<CallEventHandlerMap[T]>

Arguments to pass to the listener

Returns

Promise<boolean>

true if the event had listeners, false otherwise.

Inherited from

TypedEventEmitter.emitPromised

eventNames()

eventNames(): (string | symbol)[]

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

TypedEventEmitter.eventNames

getCurrentCallStats()

getCurrentCallStats(): Promise<any[] | undefined>

Defined in: src/webrtc/call.ts:917

Returns

Promise<any[] | undefined>

getFeeds()

getFeeds(): CallFeed[]

Defined in: src/webrtc/call.ts:607

Returns an array of all CallFeeds

Returns

CallFeed[]

CallFeeds

getLocalFeeds()

getLocalFeeds(): CallFeed[]

Defined in: src/webrtc/call.ts:615

Returns an array of all local CallFeeds

Returns

CallFeed[]

local CallFeeds

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

TypedEventEmitter.getMaxListeners

getOpponentDeviceId()

getOpponentDeviceId(): string | undefined

Defined in: src/webrtc/call.ts:503

Returns

string | undefined

getOpponentMember()

getOpponentMember(): RoomMember | undefined

Defined in: src/webrtc/call.ts:499

Returns

RoomMember | undefined

getOpponentSessionId()

getOpponentSessionId(): string | undefined

Defined in: src/webrtc/call.ts:507

Returns

string | undefined

getRemoteAssertedIdentity()

getRemoteAssertedIdentity(): AssertedIdentity | undefined

Defined in: src/webrtc/call.ts:519

Returns

AssertedIdentity | undefined

getRemoteFeeds()

getRemoteFeeds(): CallFeed[]

Defined in: src/webrtc/call.ts:623

Returns an array of all remote CallFeeds

Returns

CallFeed[]

remote CallFeeds

hangup()

hangup(reason, suppressEvent): void

Defined in: src/webrtc/call.ts:1156

Hangup a call.

Parameters

reason

CallErrorCode

The reason why the call is being hung up.

suppressEvent

boolean

True to suppress emitting an event.

Returns

void

initStats()

initStats(stats, peerId?): void

Defined in: src/webrtc/call.ts:2980

Parameters

stats

GroupCallStats

peerId?

string = "unknown"

Returns

void

initWithHangup()

initWithHangup(event): void

Defined in: src/webrtc/call.ts:1031

Configure this call from a hangup or reject event. Used by DigitalWorldClient.

Parameters

event

DigitalWorldEvent

The m.call.hangup event

Returns

void

initWithInvite()

initWithInvite(event): Promise<void>

Defined in: src/webrtc/call.ts:943

Configure this call from an invite event. Used by DigitalWorldClient.

Parameters

event

DigitalWorldEvent

The m.call.invite event

Returns

Promise<void>

isLocalOnHold()

isLocalOnHold(): boolean

Defined in: src/webrtc/call.ts:1552

Indicates whether we are ‘on hold’ to the remote party (ie. if true, they cannot hear us).

Returns

boolean

true if the other party has put us on hold

isLocalVideoMuted()

isLocalVideoMuted(): boolean

Defined in: src/webrtc/call.ts:1485

Check if local video is muted.

If there are multiple video tracks, all of the tracks need to be muted for this to return true. This means if there are no video tracks, this will return true.

Returns

boolean

True if the local preview video is muted, else false (including if the call is not set up yet).

isMicrophoneMuted()

isMicrophoneMuted(): boolean

Defined in: src/webrtc/call.ts:1519

Check if the microphone is muted.

If there are multiple audio tracks, all of the tracks need to be muted for this to return true. This means if there are no audio tracks, this will return true.

Returns

boolean

True if the mic is muted, else false (including if the call is not set up yet).

isRemoteOnHold()

isRemoteOnHold(): boolean

Defined in: src/webrtc/call.ts:1527

Returns

boolean

true if we have put the party on the other side of the call on hold (that is, we are signalling to them that we are not listening)

isScreensharing()

isScreensharing(): boolean

Defined in: src/webrtc/call.ts:1235

If there is a screensharing stream returns true, otherwise returns false

Returns

boolean

is screensharing

listenerCount()

listenerCount(event): number

Defined in: src/models/typed-event-emitter.ts:115

Returns the number of listeners listening to the event named event.

Parameters

event

EventEmitterEvents | CallEvent

The name of the event being listened for

Returns

number

Inherited from

TypedEventEmitter.listenerCount

listeners()

listeners(event): Function[]

Defined in: src/models/typed-event-emitter.ts:122

Returns a copy of the array of listeners for the event named event.

Parameters

event

EventEmitterEvents | CallEvent

Returns

Function[]

Inherited from

TypedEventEmitter.listeners

noIncomingFeeds()

noIncomingFeeds(): boolean

Defined in: src/webrtc/call.ts:671

Returns true if there are no incoming feeds, otherwise returns false

Returns

boolean

no incoming feeds

off()

off<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:129

Alias for removeListener

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

listener

Listener<CallEvent, CallEventHandlerMap, T>

Returns

this

Inherited from

TypedEventEmitter.off

on()

on<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:150

Adds the listener function to the end of the listeners array for the event named event.

No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

By default, event listeners are invoked in the order they are added. The prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

The name of the event.

listener

Listener<CallEvent, CallEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.on

onAnsweredElsewhere()

onAnsweredElsewhere(msg): void

Defined in: src/webrtc/call.ts:2464

Parameters

msg

MCallAnswer

Returns

void

onAnswerReceived()

onAnswerReceived(event): Promise<void>

Defined in: src/webrtc/call.ts:1875

Used by DigitalWorldClient.

Parameters

event

DigitalWorldEvent

Returns

Promise<void>

onAssertedIdentityReceived()

onAssertedIdentityReceived(event): Promise<void>

Defined in: src/webrtc/call.ts:2056

Parameters

event

DigitalWorldEvent

Returns

Promise<void>

once()

once<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:169

Adds a one-time listener function for the event named event. The next time event is triggered, this listener is removed and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

The name of the event.

listener

Listener<CallEvent, CallEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.once

onHangupReceived()

onHangupReceived(msg): void

Defined in: src/webrtc/call.ts:2428

Parameters

msg

MCallHangupReject

Returns

void

onNegotiateReceived()

onNegotiateReceived(event): Promise<void>

Defined in: src/webrtc/call.ts:1959

Parameters

event

DigitalWorldEvent

Returns

Promise<void>

onRejectReceived()

onRejectReceived(msg): void

Defined in: src/webrtc/call.ts:2443

Parameters

msg

MCallHangupReject

Returns

void

onRemoteIceCandidatesReceived()

onRemoteIceCandidatesReceived(ev): Promise<void>

Defined in: src/webrtc/call.ts:1831

Parameters

ev

DigitalWorldEvent

Returns

Promise<void>

onSDPStreamMetadataChangedReceived()

onSDPStreamMetadataChangedReceived(event): void

Defined in: src/webrtc/call.ts:2048

Parameters

event

DigitalWorldEvent

Returns

void

onSelectAnswerReceived()

onSelectAnswerReceived(event): Promise<void>

Defined in: src/webrtc/call.ts:1933

Parameters

event

DigitalWorldEvent

Returns

Promise<void>

opponentCanBeTransferred()

opponentCanBeTransferred(): boolean

Defined in: src/webrtc/call.ts:511

Returns

boolean

opponentSupportsDTMF()

opponentSupportsDTMF(): boolean

Defined in: src/webrtc/call.ts:515

Returns

boolean

opponentSupportsSDPStreamMetadata()

opponentSupportsSDPStreamMetadata(): boolean

Defined in: src/webrtc/call.ts:1227

Returns true if this.remoteSDPStreamMetadata is defined, otherwise returns false

Returns

boolean

can screenshare

placeCall()

placeCall(audio, video): Promise<void>

Defined in: src/webrtc/call.ts:2810

Place a call to this room.

Parameters

audio

boolean

video

boolean

Returns

Promise<void>

Throws

if you have not specified a listener for ‘error’ events.

Throws

if have passed audio=false.

placeCallWithCallFeeds()

placeCallWithCallFeeds(callFeeds, requestScreenshareFeed?): Promise<void>

Defined in: src/webrtc/call.ts:2854

Place a call to this room with call feed.

Parameters

callFeeds

CallFeed[]

to use

requestScreenshareFeed?

boolean = false

Returns

Promise<void>

Throws

if you have not specified a listener for ‘error’ events.

Throws

if have passed audio=false.

placeVideoCall()

placeVideoCall(): Promise<void>

Defined in: src/webrtc/call.ts:484

Place a video call to this room.

Returns

Promise<void>

Throws

If you have not specified a listener for ‘error’ events.

placeVoiceCall()

placeVoiceCall(): Promise<void>

Defined in: src/webrtc/call.ts:476

Place a voice call to this room.

Returns

Promise<void>

Throws

If you have not specified a listener for ‘error’ events.

prependListener()

prependListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:186

Adds the listener function to the beginning of the listeners array for the event named event.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

The name of the event.

listener

Listener<CallEvent, CallEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.prependListener

prependOnceListener()

prependOnceListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:202

Adds a one-timelistener function for the event named event to the beginning of the listeners array. The next time event is triggered, this listener is removed, and then invoked.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

The name of the event.

listener

Listener<CallEvent, CallEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.prependOnceListener

pushLocalFeed()

pushLocalFeed(callFeed, addToPeerConnection?): void

Defined in: src/webrtc/call.ts:806

Pushes supplied feed to the call

Parameters

callFeed

CallFeed

to push

addToPeerConnection?

boolean = true

whether to add the tracks to the peer connection

Returns

void

rawListeners()

rawListeners(event): Function[]

Defined in: src/models/typed-event-emitter.ts:243

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Parameters

event

EventEmitterEvents | CallEvent

Returns

Function[]

Inherited from

TypedEventEmitter.rawListeners

reject()

reject(): void

Defined in: src/webrtc/call.ts:1176

Reject a call This used to be done by calling hangup, but is a separate method and protocol event as of MSC2746.

Returns

void

removeAllListeners()

removeAllListeners(event?): this

Defined in: src/models/typed-event-emitter.ts:219

Removes all listeners, or those of the specified event.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Parameters

event?

EventEmitterEvents | CallEvent

The name of the event. If undefined, all listeners everywhere are removed.

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.removeAllListeners

removeListener()

removeListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:232

Removes the specified listener from the listener array for the event named event.

Type Parameters

T

T extends EventEmitterEvents | CallEvent

Parameters

event

T

listener

Listener<CallEvent, CallEventHandlerMap, T>

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

TypedEventEmitter.removeListener

removeLocalFeed()

removeLocalFeed(callFeed): void

Defined in: src/webrtc/call.ts:867

Removes local call feed from the call and its tracks from the peer connection

Parameters

callFeed

CallFeed

to remove

Returns

void

replacedBy()

replacedBy(newCall): void

Defined in: src/webrtc/call.ts:1129

Replace this call with a new call, e.g. for glare resolution. Used by DigitalWorldClient.

Parameters

newCall

DigitalWorldCall

The new call.

Returns

void

sendDtmfDigit()

sendDtmfDigit(digit): void

Defined in: src/webrtc/call.ts:1572

Sends a DTMF digit to the other party

Parameters

digit

string

The digit (nb. string - ‘#’ and ‘*’ are dtmf too)

Returns

void

sendMetadataUpdate()

sendMetadataUpdate(): Promise<void>

Defined in: src/webrtc/call.ts:1597

Returns

Promise<void>

setLocalVideoMuted()

setLocalVideoMuted(muted): Promise<boolean>

Defined in: src/webrtc/call.ts:1425

Set whether our outbound video should be muted or not.

Parameters

muted

boolean

True to mute the outbound video.

Returns

Promise<boolean>

the new mute state

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:813

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

TypedEventEmitter.setMaxListeners

setMicrophoneMuted()

setMicrophoneMuted(muted): Promise<boolean>

Defined in: src/webrtc/call.ts:1494

Set whether the microphone should be muted or not.

Parameters

muted

boolean

True to mute the mic.

Returns

Promise<boolean>

the new mute state

setRemoteOnHold()

setRemoteOnHold(onHold): void

Defined in: src/webrtc/call.ts:1531

Parameters

onHold

boolean

Returns

void

setScreensharingEnabled()

setScreensharingEnabled(enabled, opts?): Promise<boolean>

Defined in: src/webrtc/call.ts:1245

Starts/stops screensharing

Parameters

enabled

boolean

the desired screensharing state

opts?

IScreensharingOpts

screen sharing options

Returns

Promise<boolean>

new screensharing state

transfer()

transfer(targetUserId): Promise<void>

Defined in: src/webrtc/call.ts:2604

Parameters

targetUserId

string

Returns

Promise<void>

transferToCall()

transferToCall(transferTargetCall): Promise<void>

Defined in: src/webrtc/call.ts:2630

Parameters

transferTargetCall

DigitalWorldCall

Returns

Promise<void>

updateLocalUsermediaStream()

updateLocalUsermediaStream(stream, forceAudio?, forceVideo?): Promise<void>

Defined in: src/webrtc/call.ts:1350

Replaces/adds the tracks from the passed stream to the localUsermediaStream

Parameters

stream

MediaStream

to use a replacement for the local usermedia stream

forceAudio?

boolean = false

forceVideo?

boolean = false

Returns

Promise<void>