Class LiveKitMedia

The media of a call through LiveKit, as one IMediaConnection: this side's frames encrypted and sent on the room it publishes to, and the others' received on the rooms it subscribes to, decrypted with each sender's key.

Inheritance

object

LiveKitMedia

Implements

IMediaConnection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.LiveKit

Assembly: Uniform.LiveKit.dll

Syntax

public sealed class LiveKitMedia : IMediaConnection

Remarks

With MatrixRTC's many SFUs, each member publishes on its own homeserver's SFU, and the others subscribe there; a call has one room to publish to and a room for each SFU the others publish on, the same one when they share it. Without encryption, frames go and come as they are.

Constructors

LiveKitMedia(LiveKitRoom, bool)

Send on room's publisher connection, encrypting with OwnKey when encrypted.

Declaration

public LiveKitMedia(LiveKitRoom room, bool encrypted)

Parameters

Type	Name	Description
LiveKitRoom	room
bool	encrypted

Exceptions

Type	Condition
InvalidOperationException	When the room has not published.

Properties

Encrypted

Whether frames are encrypted end to end.

Declaration

public bool Encrypted { get; }

Property Value

Type	Description
bool

EncryptionFailures

Frames of this side that did not encrypt, and were dropped.

Declaration

public long EncryptionFailures { get; }

Property Value

Type	Description
long

FramesWithoutKey

Frames received from someone whose key is not known.

Declaration

public long FramesWithoutKey { get; }

Property Value

Type	Description
long

OwnKey

This side's key, that its frames are encrypted with; set it and send it to the others.

Declaration

public FrameCryptor OwnKey { get; }

Property Value

Type	Description
FrameCryptor

ReceivesVideo

Whether video may be received, in VideoReceived.

Declaration

public bool ReceivesVideo { get; }

Property Value

Type	Description
bool

SendsOrientation

Whether the rotation of sent frames reaches the receiver, with the video orientation extension; when not, frames must be sent upright.

Declaration

public bool SendsOrientation { get; }

Property Value

Type	Description
bool

SendsVideo

Whether video is sent, with SendVideoAsync(byte[], CancellationToken, int).

Declaration

public bool SendsVideo { get; }

Property Value

Type	Description
bool

Methods

Replace(LiveKitRoom, LiveKitRoom)

Move the media from old to replacement, a room joined again, e.g. after the network changed: publishing there when old published, and receiving there; the voice and video pipelines stay as they are.

Declaration

public void Replace(LiveKitRoom old, LiveKitRoom replacement)

Parameters

Type	Name	Description
LiveKitRoom	old
LiveKitRoom	replacement

Exceptions

Type	Condition
InvalidOperationException	When old published and replacement has not.

RequestBitrateAsync(long)

Ask the SFUs for a video layer that fits bitsPerSecond, and the senders for at most it.

Declaration

public Task RequestBitrateAsync(long bitsPerSecond)

Parameters

Type	Name	Description
long	bitsPerSecond

Returns

Type	Description
Task

RequestKeyframeAsync()

Ask the sender of the video received for a keyframe.

Declaration

public Task RequestKeyframeAsync()

Returns

Type	Description
Task

SendAudioAsync(byte[], int, CancellationToken)

Send a frame of Opus, samples long at 48 kHz.

Declaration

public ValueTask SendAudioAsync(byte[] opus, int samples = 960, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
byte[]	opus
int	samples
CancellationToken	cancellationToken

Returns

Type	Description
ValueTask

SendVideoAsync(byte[], CancellationToken, int)

Send a VP8 frame, captured now, shown upright with rotation degrees clockwise.

Declaration

public ValueTask SendVideoAsync(byte[] frame, CancellationToken cancellationToken = default, int rotation = 0)

Parameters

Type	Name	Description
byte[]	frame
CancellationToken	cancellationToken
int	rotation

Returns

Type	Description
ValueTask

SetKey(string, byte, ReadOnlySpan<byte>)

Set the key of identity, a participant on the SFUs, e.g. @bob:example.org:DEVICE, at index.

Declaration

public void SetKey(string identity, byte index, ReadOnlySpan<byte> rawKey)

Parameters

Type	Name	Description
string	identity
byte	index
ReadOnlySpan<byte>	rawKey

SkipAudio(int)

Skip samples without sending, e.g. while muted, so the timestamps stay in time.

Declaration

public void SkipAudio(int samples = 960)

Parameters

Type	Name	Description
int	samples

Subscribe(LiveKitRoom)

Receive the others' media on room, e.g. another member's SFU.

Declaration

public void Subscribe(LiveKitRoom room)

Parameters

Type	Name	Description
LiveKitRoom	room

Unsubscribe(LiveKitRoom)

Stop receiving on room, e.g. one that is left.

Declaration

public void Unsubscribe(LiveKitRoom room)

Parameters

Type	Name	Description
LiveKitRoom	room

Events

AudioReceived

Raised for each audio packet received, its payload Opus; on a network thread.

Declaration

public event Action<RtpPacket>? AudioReceived

Event Type

Type	Description
Action<RtpPacket>

BitrateRequested

Raised when the receiver asks to limit the video sent to a bitrate, in bits per second.

Declaration

public event Action<long>? BitrateRequested

Event Type

Type	Description
Action<long>

DecryptionFailed

Raised with the sender's identity when its frame did not decrypt, e.g. before its key came; on a network thread.

Declaration

public event Action<string>? DecryptionFailed

Event Type

Type	Description
Action<string>

KeyframeRequested

Raised when the receiver asks for a keyframe of the video sent.

Declaration

public event Action? KeyframeRequested

Event Type

Type	Description
Action

VideoReceived

Raised for each whole VP8 frame received, in order; on a network thread.

Declaration

public event Action<Vp8EncodedFrame>? VideoReceived

Event Type

Type	Description
Action<Vp8EncodedFrame>

Implements

IMediaConnection