Class PeerConnectionOptions

Options of an AudioPeerConnection.

Inheritance
object
PeerConnectionOptions
Implements
Inherited Members
Namespace: Uniform.Matrix.WebRtc
Assembly: Uniform.Matrix.WebRtc.dll
Syntax
public sealed record PeerConnectionOptions : IEquatable<PeerConnectionOptions>

Properties

| Edit this page View Source

AudioTrackId

Track ID of the audio sent, in its msid, e.g. the cid an SFU was told of; audio when null.

Declaration
public string? AudioTrackId { get; init; }
Property Value
Type Description
string
| Edit this page View Source

ConnectTimeout

How long ICE may take to connect.

Declaration
public TimeSpan ConnectTimeout { get; init; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

IncludeLoopback

Whether to use loopback addresses, e.g. for tests on one machine.

Declaration
public bool IncludeLoopback { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

ReceiveVideo

Whether to accept an offer's VP8 video, for receiving; its frames come in VideoReceived.

Declaration
public bool ReceiveVideo { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

RelayOnly

Whether to use relayed candidates only, so the peer does not learn this side's addresses.

Declaration
public bool RelayOnly { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

SendOnly

Whether offers only send, as to an SFU that is published to, and receive nothing.

Declaration
public bool SendOnly { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

SendVideo

Whether to send VP8 video when the peer's offer receives it, with SendVideoAsync(byte[], CancellationToken, int).

Declaration
public bool SendVideo { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

Servers

STUN and TURN servers, e.g. from Matrix's /voip/turnServer.

Declaration
public IReadOnlyList<IceServer> Servers { get; init; }
Property Value
Type Description
IReadOnlyList<IceServer>
| Edit this page View Source

StreamId

Media stream ID of the tracks sent, in their msid; random when null.

Declaration
public string? StreamId { get; init; }
Property Value
Type Description
string
| Edit this page View Source

VideoTrackId

Track ID of the video sent, in its msid; video when null.

Declaration
public string? VideoTrackId { get; init; }
Property Value
Type Description
string

Implements