Class VoiceCall

A 1:1 call with another user, as the apps show it: its state, mute and camera, and the other's pictures; a LegacyCall of m.call.* events, or a RtcCall of MatrixRTC through a LiveKit SFU.

Inheritance

object

VoiceCall

LegacyCall

RtcCall

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Calls

Assembly: Uniform.Matrix.Calls.dll

Syntax

public abstract class VoiceCall : IAsyncDisposable

Remarks

The voice and video go over an IMediaConnection: VoiceMedia records and plays, a VideoReceiver decodes, and the camera's frames are sent. A call's actions and events run one at a time under Uniform.Matrix.Calls.VoiceCall.gate.

Properties

CallId

The call's ID.

Declaration

public string CallId { get; }

Property Value

Type	Description
string

CameraOff

Whether this side's camera is turned off: nothing is captured or sent until it is turned on.

Declaration

public bool CameraOff { get; set; }

Property Value

Type	Description
bool

CanSwitchCamera

Whether this side's device has another camera to switch to.

Declaration

public bool CanSwitchCamera { get; }

Property Value

Type	Description
bool

ConnectedAt

When voice started to flow; null before.

Declaration

public DateTimeOffset? ConnectedAt { get; }

Property Value

Type	Description
DateTimeOffset?

EndReason

Why the call ended, e.g. user_hangup, rejected, invite_timeout, ice_failed or answered_elsewhere; null until ended.

Declaration

public string? EndReason { get; }

Property Value

Type	Description
string

EndedByPeer

Whether the other side ended the call.

Declaration

public bool EndedByPeer { get; }

Property Value

Type	Description
bool

IsIncoming

Whether the other user called.

Declaration

public abstract bool IsIncoming { get; }

Property Value

Type	Description
bool

IsVideo

Whether the call has video, which this side can show.

Declaration

public bool IsVideo { get; }

Property Value

Type	Description
bool

Muted

Whether this side's microphone is muted.

Declaration

public bool Muted { get; set; }

Property Value

Type	Description
bool

Path

The local and remote candidates the media goes through, once connected, e.g. to show whether it is relayed.

Declaration

public virtual (IceCandidate? Local, IceCandidate? Remote) Path { get; }

Property Value

Type	Description
(IceCandidate Local, IceCandidate Remote)

PeerUserId

The other user.

Declaration

public string PeerUserId { get; }

Property Value

Type	Description
string

RoomId

Room of the call.

Declaration

public string RoomId { get; }

Property Value

Type	Description
string

SendsVideo

Whether this side sends its camera's video in the call.

Declaration

public bool SendsVideo { get; }

Property Value

Type	Description
bool

State

The state.

Declaration

public CallState State { get; }

Property Value

Type	Description
CallState

Methods

AnswerAsync(CancellationToken)

Answer an incoming call, and connect; this side sends no video.

Declaration

public Task AnswerAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

AnswerWithVideoAsync(CancellationToken)

Answer an incoming call with this side's camera too, when the platform has a camera; and connect.

Declaration

public Task AnswerWithVideoAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

DisposeAsync()

End the call without telling the peer, and release the media.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

HangupAsync(string, CancellationToken)

Hang up, or cancel an outgoing call that rings.

Declaration

public abstract Task HangupAsync(string reason = "user_hangup", CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	reason
CancellationToken	cancellationToken

Returns

Type	Description
Task

RejectAsync(CancellationToken)

Decline an incoming call.

Declaration

public abstract Task RejectAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

RestartAudioAsync()

Reopen the microphone and speaker, e.g. to switch between the earpiece and the loudspeaker, which phones choose when the speaker opens.

Declaration

public Task RestartAudioAsync()

Returns

Type	Description
Task

RestartIceAsync(string, CancellationToken)

Restart the media path, e.g. after the network changed; nothing where the call cannot.

Declaration

public virtual Task RestartIceAsync(string reason, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	reason
CancellationToken	cancellationToken

Returns

Type	Description
Task

SwitchCamera()

Switch the camera sent, e.g. from the front to the back.

Declaration

public void SwitchCamera()

Events

Changed

Raised when State or Muted changes; on any thread.

Declaration

public event Action<VoiceCall>? Changed

Event Type

Type	Description
Action<VoiceCall>

PictureReceived

Raised with each picture of the peer's video, on a decoding thread; a handler should be quick, e.g. keep the newest picture to show.

Declaration

public event Action<VoiceCall, VideoFrame>? PictureReceived

Event Type

Type	Description
Action<VoiceCall, VideoFrame>

PreviewReceived

Raised with small pictures of this side's camera, for a preview; on any thread.

Declaration

public event Action<VoiceCall, VideoFrame>? PreviewReceived

Event Type

Type	Description
Action<VoiceCall, VideoFrame>

Implements

IAsyncDisposable