Class CallService

Matrix 1:1 calls of the logged-in user: places calls, raises incoming ones, and routes the events of the synced timelines to their VoiceCall; sends through the outbox, which encrypts in encrypted rooms.

Inheritance

object

CallService

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Calls

Assembly: Uniform.Matrix.Calls.dll

Syntax

public sealed class CallService : IAsyncDisposable

Remarks

Register it as a singleton beside the client engine; it follows Applied from construction. TURN credentials come from the homeserver, and are kept until shortly before they expire. Calls go over MatrixRTC, as RtcCall, when the homeserver has a LiveKit transport, as Element X can only take those; else as LegacyCall of m.call.* events. Both kinds of incoming call ring.

Constructors

CallService(SyncProcessor, OutboxSender, ClientSession, NetworkMonitor, ILogger<CallService>, CryptoService?)

Follow the synced timelines for call events, and the to-device messages for MatrixRTC's keys.

Declaration

public CallService(SyncProcessor processor, OutboxSender outbox, ClientSession session, NetworkMonitor network, ILogger<CallService> logger, CryptoService? crypto = null)

Parameters

Type	Name	Description
SyncProcessor	processor
OutboxSender	outbox
ClientSession	session
NetworkMonitor	network
ILogger<CallService>	logger
CryptoService	crypto

Properties

ActiveCalls

The calls not yet ended.

Declaration

public IReadOnlyList<VoiceCall> ActiveCalls { get; }

Property Value

Type	Description
IReadOnlyList<VoiceCall>

Camera

Opens the platform's camera, for calls answered with video; null where there is none, as on desktops for now.

Declaration

public Func<IVideoCamera?>? Camera { get; set; }

Property Value

Type	Description
Func<IVideoCamera>

Devices

Open the microphone and speaker of a call; the platform's devices by default, which Android replaces.

Declaration

public Func<IAudioDevices?> Devices { get; set; }

Property Value

Type	Description
Func<IAudioDevices>

ReceiveVideo

Whether to accept the video a caller offers, to show it; this side sends none. On by default.

Declaration

public bool ReceiveVideo { get; set; }

Property Value

Type	Description
bool

RelayOnly

Whether calls go through TURN only, so the peer does not learn this device's addresses.

Declaration

public bool RelayOnly { get; set; }

Property Value

Type	Description
bool

UseMatrixRtc

Whether to place calls over MatrixRTC when the homeserver has a LiveKit transport; on by default. Off places m.call.* calls only.

Declaration

public bool UseMatrixRtc { get; set; }

Property Value

Type	Description
bool

VideoDecoder

Makes a decoder of a peer's video, e.g. the platform's hardware one; null for the C# decoder, as on desktops.

Declaration

public Func<IVideoDecoder?>? VideoDecoder { get; set; }

Property Value

Type	Description
Func<IVideoDecoder>

Methods

DisposeAsync()

Hang up all calls, and stop following the timelines; a server that does not answer holds each hangup for a few seconds at most.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

FindCall(string)

Return the call in a room that has not ended, or null.

Declaration

public VoiceCall? FindCall(string roomId)

Parameters

Type	Name	Description
string	roomId

Returns

Type	Description
VoiceCall

PlaceCallAsync(string, CancellationToken)

Call the other member of a room with two members, e.g. a direct chat.

Declaration

public Task<VoiceCall> PlaceCallAsync(string roomId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	roomId
CancellationToken	cancellationToken

Returns

Type	Description
Task<VoiceCall>

Exceptions

Type	Condition
InvalidOperationException	When the room is unknown, has not exactly one other member, or already has a call.

PlaceVideoCallAsync(string, CancellationToken)

Call the other member of a direct room with video too: this side's camera, when Camera has one, and the peer's when it sends; or answer their call that rings, with video.

Declaration

public Task<VoiceCall> PlaceVideoCallAsync(string roomId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	roomId
CancellationToken	cancellationToken

Returns

Type	Description
Task<VoiceCall>

RingExpiry(long, long, long)

Return when a ring of lifetime milliseconds stops ringing: from its sender's time, or from the server's when the two differ by more than 20 seconds either way, as a sender's clock may be off, e.g. by its time zone; at most two minutes.

Declaration

public static DateTimeOffset RingExpiry(long senderTs, long originServerTs, long lifetime)

Parameters

Type	Name	Description
long	senderTs
long	originServerTs
long	lifetime

Returns

Type	Description
DateTimeOffset

Events

CallChanged

Raised when a call changes state or mute; on any thread.

Declaration

public event Action<VoiceCall>? CallChanged

Event Type

Type	Description
Action<VoiceCall>

IncomingCall

Raised for a new incoming call that rings.

Declaration

public event Action<VoiceCall>? IncomingCall

Event Type

Type	Description
Action<VoiceCall>

Implements

IAsyncDisposable