This constructs a room session. When using MatrixRTC inside the js-sdk this is expected to be used with the MatrixRTCSessionManager exclusively.
In cases where you don't use the js-sdk but build on top of another Matrix stack this class can be used standalone to manage a joined MatrixRTC session.
A subset of the MatrixClient that lets the session interact with the Matrix room.
The room this session is attached to. A subset of a js-sdk Room that the session needs.
The list of memberships this session currently has.
The callId (sessionId) of the call.
It can be undefined since the callId is only known once the first membership joins. The callId is the property that, per definition, groups memberships into one call.
WARN: this can in theory only be a subset of the room with the properties required by this class. Outside of tests this most likely will be a full room, however.
The statistics for this session.
Alias for on.
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.
Get the active focus from the current CallMemberState event
The focus that is currently in use to connect to this session. This is undefined if the client is not connected to this session.
A map of keys used to encrypt and decrypt (we are using a symmetric cipher) given participant's media. This also includes our own key
This method is used when the user is not yet connected to the Session but wants to know what focus the users in the session are using to make a decision how it wants/should connect.
See also getActiveFocus
The focus which should be used when joining this session.
Announces this user and device as joined to the MatrixRTC session, and continues to update the membership event to keep it valid until leaveRoomSession() is called This will not subscribe to updates: remember to call subscribe() separately if desired. This method will return immediately and the session will be joined in the background.
The list of preferred foci this member proposes to use/knows/has access to. For the livekit case this is a list of foci generated from the homeserver well-known, the current rtc session, or optionally other room members homeserver well known.
OptionalfociActive: FocusThe object representing the active focus. (This depends on the focus type.)
OptionaljoinConfig: JoinSessionConfigAdditional configuration for the joined session.
Announces this user and device as having left the MatrixRTC session and stops scheduled updates. This will not unsubscribe from updates: remember to call unsubscribe() separately if desired. The membership update required to leave the session will retry if it fails. Without network connection the promise will never resolve. A timeout can be provided so that there is a guarantee for the promise to resolve.
Whether the membership update was attempted and did not time out.
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.
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.
Process m.call.encryption_keys events to track the encryption keys for call participants.
This should be called each time the relevant event is received from a room timeline.
If the event is malformed then it will be logged and ignored.
the event to process
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.
Call this when the Matrix room members have changed.
Call this when something changed that may impacts the current MatrixRTC members in this session.
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.
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
Re-emit an EncryptionKeyChanged event for each tracked encryption key. This can be used to export the keys.
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 | MatrixRTCSessionEventThe 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.
Performs cleanup & removes timers for client shutdown
StaticcallReturns all the call memberships for a room, oldest first
StaticroomReturn the MatrixRTC session for the room, whether there are currently active members or not
A MatrixRTCSession manages the membership & properties of a MatrixRTC session. This class doesn't deal with media at all, just membership & properties of a session.