Class IceOptions

Options of an IceAgent.

Inheritance

object

IceOptions

Implements

IEquatable<IceOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.WebRtc.Ice

Assembly: Uniform.Matrix.WebRtc.dll

Syntax

public sealed record IceOptions : IEquatable<IceOptions>

Properties

Controlling

Whether this agent starts as the controlling one, which nominates the pair; the caller is.

Declaration

public bool Controlling { get; init; }

Property Value

Type	Description
bool

EnableIPv6

Whether to gather and pair IPv6 host candidates, where the system has IPv6.

Declaration

public bool EnableIPv6 { get; init; }

Property Value

Type	Description
bool

IncludeLoopback

Whether to offer and pair loopback addresses, e.g. for tests on one machine.

Declaration

public bool IncludeLoopback { get; init; }

Property Value

Type	Description
bool

RelayOnly

Whether to offer and pair only relayed candidates, so the call goes through TURN; hides the addresses from the peer.

Declaration

public bool RelayOnly { get; init; }

Property Value

Type	Description
bool

ServerTimeout

How long to wait for each server while gathering.

Declaration

public TimeSpan ServerTimeout { get; init; }

Property Value

Type	Description
TimeSpan

Servers

STUN and TURN servers to gather reflexive and relayed candidates from.

Declaration

public IReadOnlyList<IceServer> Servers { get; init; }

Property Value

Type	Description
IReadOnlyList<IceServer>

Implements

IEquatable<T>