Class IceCandidate

An ICE candidate over UDP: where a peer may be reached, written as the candidate attribute of SDP.

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

Properties

| Edit this page View Source

Address

Address and port.

Declaration
public required IPEndPoint Address { get; init; }
Property Value
Type Description
IPEndPoint
| Edit this page View Source

Component

Component; always 1, RTP, with RTCP multiplexed.

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

Foundation

Groups candidates of the same type, base and server; the same for those that would fail alike.

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

Priority

Priority; higher is preferred.

Declaration
public required uint Priority { get; init; }
Property Value
Type Description
uint
| Edit this page View Source

RelatedAddress

The address it derives from, for reflexive and relayed candidates.

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

Type

Type.

Declaration
public required IceCandidateType Type { get; init; }
Property Value
Type Description
IceCandidateType

Methods

| Edit this page View Source

ComputePriority(IceCandidateType, ushort)

Return the priority of RFC 8445 5.1.2 for a type, a local preference, and component 1.

Declaration
public static uint ComputePriority(IceCandidateType type, ushort localPreference = 65535)
Parameters
Type Name Description
IceCandidateType type
ushort localPreference
Returns
Type Description
uint
| Edit this page View Source

Parse(string)

Parse a candidate attribute, with or without its a=; null when malformed, not UDP, or its address is a name, e.g. the mDNS names browsers give host candidates.

Declaration
public static IceCandidate? Parse(string attribute)
Parameters
Type Name Description
string attribute
Returns
Type Description
IceCandidate
Examples
IceCandidate? candidate = IceCandidate.Parse("candidate:1 1 udp 2130706431 192.0.2.1 50000 typ host");
| Edit this page View Source

ToString()

Return the candidate attribute, without a=, as Matrix's m.call.candidates and browsers' trickle carry it.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

TypePreference(IceCandidateType)

Return the type preference RFC 8445 recommends.

Declaration
public static byte TypePreference(IceCandidateType type)
Parameters
Type Name Description
IceCandidateType type
Returns
Type Description
byte

Implements