OptionaldirectionOptionalgroupOptionalhangupOptionalhangupOptionalinviteeOptionalpeerAlias for on.
Create a datachannel using this call's peer connection.
A human readable label for this datachannel
An object providing configuration options for the data channel.
Synchronously calls each of the listeners registered for the event named
event, in the order they were registered, passing the supplied arguments
to each.
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Synchronously calls each of the listeners registered for the event named
event, in the order they were registered, passing the supplied arguments
to each.
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Similar to emit but calls all listeners within a Promise.all and returns the promise chain
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Similar to emit but calls all listeners within a Promise.all and returns the promise chain
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Hangup a call.
The reason why the call is being hung up.
True to suppress emitting an event.
Configure this call from a hangup or reject event. Used by MatrixClient.
The m.call.hangup event
Configure this call from an invite event. Used by MatrixClient.
The m.call.invite event
Indicates whether we are 'on hold' to the remote party (ie. if true, they cannot hear us).
true if the other party has put us on hold
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.
True if the local preview video is muted, else false (including if the call is not set up yet).
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.
True if the mic is muted, else false (including if the call is not set up yet).
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)
If there is a screensharing stream returns true, otherwise returns false
is screensharing
Returns the number of listeners listening to the event named event.
The name of the event being listened for
Returns a copy of the array of listeners for the event named event.
Returns true if there are no incoming feeds, otherwise returns false
no incoming feeds
Alias for removeListener
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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Returns true if this.remoteSDPStreamMetadata is defined, otherwise returns false
can screenshare
Place a video call to this room.
Place a voice call to this room.
Adds the listener function to the beginning 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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Pushes supplied feed to the call
to push
whether to add the tracks to the peer connection
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
Reject a call This used to be done by calling hangup, but is a separate method and protocol event as of MSC2746.
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).
Optionalevent: EventEmitterEvents | CallEventThe name of the event. If undefined, all listeners everywhere are removed.
a reference to the EventEmitter, so that calls can be chained.
Removes the specified listener from the listener array for the event named event.
a reference to the EventEmitter, so that calls can be chained.
Removes local call feed from the call and its tracks from the peer connection
to remove
Replace this call with a new call, e.g. for glare resolution. Used by MatrixClient.
The new call.
Sends a DTMF digit to the other party
The digit (nb. string - '#' and '*' are dtmf too)
Set whether our outbound video should be muted or not.
True to mute the outbound video.
the new mute state
Set whether the microphone should be muted or not.
True to mute the mic.
the new mute state
Starts/stops screensharing
the desired screensharing state
Optionalopts: IScreensharingOptsscreen sharing options
new screensharing state
Replaces/adds the tracks from the passed stream to the localUsermediaStream
to use a replacement for the local usermedia stream
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 thisTypedEventEmitter. 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?