Class RtcCall

A 1:1 call over MatrixRTC, as Element X and Element Call make them: each side's membership in the room's call as a state event, a ring notification, the media through LiveKit SFUs, and the frames encrypted with keys sent to each member's device.

Inheritance
object
VoiceCall
RtcCall
Implements
Inherited Members
Namespace: Uniform.Matrix.Calls
Assembly: Uniform.Matrix.Calls.dll
Syntax
public sealed class RtcCall : VoiceCall, IAsyncDisposable
Remarks
  • Joining: an OpenID token buys a LiveKit token from the homeserver's authorization service, this side publishes on its SFU, and writes its membership, _{user}_{device}_m.call, with a delayed event that empties it unless restarted every few seconds.
  • The caller rings the room with rtc.notification; the callee declines with rtc.decline, or answers by joining.
  • Each side sends its media key in io.element.call.encryption_keys to the other's call devices over Olm, and subscribes to the other on its SFU, the same one when they share a homeserver.
  • The call ends when the peer's membership goes, empty or expired.

Fields

| Edit this page View Source

HandedLeaveDelay

The delay of a leave handed to the authorization service, which keeps it while this side is on LiveKit, as Element Call has it.

Declaration
public static readonly TimeSpan HandedLeaveDelay
Field Value
Type Description
TimeSpan
| Edit this page View Source

HandedLeaveRestart

How often a handed-over leave is restarted by this side too.

Declaration
public static readonly TimeSpan HandedLeaveRestart
Field Value
Type Description
TimeSpan
| Edit this page View Source

LeaveDelay

How long after the device disappears its membership ends, as Element Call has it.

Declaration
public static readonly TimeSpan LeaveDelay
Field Value
Type Description
TimeSpan
| Edit this page View Source

LeaveRestart

How often the delayed leave is restarted.

Declaration
public static readonly TimeSpan LeaveRestart
Field Value
Type Description
TimeSpan
| Edit this page View Source

MembershipExpiry

How long a membership holds unless renewed.

Declaration
public static readonly TimeSpan MembershipExpiry
Field Value
Type Description
TimeSpan
| Edit this page View Source

RingLifetime

How long the caller rings.

Declaration
public static readonly TimeSpan RingLifetime
Field Value
Type Description
TimeSpan

Properties

| Edit this page View Source

IsIncoming

Whether the other user called.

Declaration
public override bool IsIncoming { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Path

The path of the media to this side's SFU, once connected.

Declaration
public override (IceCandidate? Local, IceCandidate? Remote) Path { get; }
Property Value
Type Description
(IceCandidate Local, IceCandidate Remote)
Overrides

Methods

| Edit this page View Source

HangupAsync(string, CancellationToken)

Hang up, or cancel an outgoing call that rings.

Declaration
public override Task HangupAsync(string reason = "user_hangup", CancellationToken cancellationToken = default)
Parameters
Type Name Description
string reason
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
| Edit this page View Source

Members(Room, DateTimeOffset)

Return the members' devices of a room's call, without expired ones; their memberships by user and device.

Declaration
public static IReadOnlyList<(string UserId, string DeviceId, CallMemberContent Membership)> Members(Room room, DateTimeOffset now)
Parameters
Type Name Description
Room room
DateTimeOffset now
Returns
Type Description
IReadOnlyList<(string UserId, string DeviceId, CallMemberContent Membership)>
| Edit this page View Source

MembershipStateKey(string, string)

Return the state key of a device's membership in a room's call.

Declaration
public static string MembershipStateKey(string userId, string deviceId)
Parameters
Type Name Description
string userId
string deviceId
Returns
Type Description
string
| Edit this page View Source

RejectAsync(CancellationToken)

Decline an incoming call.

Declaration
public override Task RejectAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
| Edit this page View Source

RestartIceAsync(string, CancellationToken)

Restart the media path after the network changed: join the SFUs again.

Declaration
public override Task RestartIceAsync(string reason, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string reason
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

Implements