Interface IMediaConnection

The media of a call, as its voice and video pipelines see it: Opus frames and VP8 frames each way, with the feedback of the video; a AudioPeerConnection to the peer, or the connections of an SFU call together.

Namespace: Uniform.Matrix.WebRtc

Assembly: Uniform.Matrix.WebRtc.dll

Syntax

public interface IMediaConnection

Properties

ReceivesVideo

Whether video may be received, in VideoReceived.

Declaration

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

bool SendsOrientation { get; }

Property Value

Type	Description
bool

SendsVideo

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

Declaration

bool SendsVideo { get; }

Property Value

Type	Description
bool

Methods

RequestBitrateAsync(long)

Ask the sender of the video received to send at most bitsPerSecond.

Declaration

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

Task RequestKeyframeAsync()

Returns

Type	Description
Task

SendAudioAsync(byte[], int, CancellationToken)

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

Declaration

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

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

Parameters

Type	Name	Description
byte[]	frame
CancellationToken	cancellationToken
int	rotation

Returns

Type	Description
ValueTask

SkipAudio(int)

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

Declaration

void SkipAudio(int samples = 960)

Parameters

Type	Name	Description
int	samples

Events

AudioReceived

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

Declaration

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

event Action<long>? BitrateRequested

Event Type

Type	Description
Action<long>

KeyframeRequested

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

Declaration

event Action? KeyframeRequested

Event Type

Type	Description
Action

VideoReceived

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

Declaration

event Action<Vp8EncodedFrame>? VideoReceived

Event Type

Type	Description
Action<Vp8EncodedFrame>