Class CandidateAttribute

The candidate attribute is a media-level attribute only. It contains a transport address for a candidate that can be used for connectivity checks.

Inheritance

System.Object

Attribute

CandidateAttribute

Inherited Members

Attribute.AttributeType

Attribute.MultiplexingCategory

Attribute.GetTypeName(Type)

Attribute.IsSessionLevel(Type)

Attribute.IsMediaLevel(Type)

Attribute.CreateAttribute(String, String)

Attribute.ToString()

Attribute.Parse(String)

Namespace: FM.LiveSwitch.Sdp.Ice

Assembly: FM.LiveSwitch.dll

Syntax

public class CandidateAttribute : Attribute

Constructors

CandidateAttribute(String, Int64, String, Int32, String, Int32)

Initializes a new instance of the CandidateAttribute class.

Declaration

public CandidateAttribute(string foundation, long priority, string connectionAddress, int port, string candidateType, int componentId)

Parameters

Type	Name	Description
System.String	foundation	The candidate's foundation.
System.Int64	priority	The priority of the candidate.
System.String	connectionAddress	The IP address of the candidate.
System.Int32	port	The port of the candidate.
System.String	candidateType	The type of the candidate. See CandidateType for possible values.
System.Int32	componentId	The component identifier.

CandidateAttribute(String, Int64, String, Int32, String, String, Int32, String, Int32)

Initializes a new instance of the CandidateAttribute class.

Declaration

public CandidateAttribute(string foundation, long priority, string connectionAddress, int port, string candidateType, string relatedAddress, int relatedPort, string protocol, int componentId)

Parameters

Type	Name	Description
System.String	foundation	The candidate's foundation.
System.Int64	priority	The priority of the candidate.
System.String	connectionAddress	The IP address of the candidate.
System.Int32	port	The port of the candidate.
System.String	candidateType	The type of the candidate. See CandidateType for possible values.
System.String	relatedAddress	The IP address related to the candidate.
System.Int32	relatedPort	The port related to the candidate.
System.String	protocol	The protocol.
System.Int32	componentId	The ID of the component for which this is a candidate.

Properties

CandidateType

Gets or sets the type of the candidate. See CandidateType for possible values.

Declaration

public string CandidateType { get; set; }

Property Value

Type	Description
System.String

ComponentId

Gets or sets the ID of the component for which this is a candidate.

Declaration

public int ComponentId { get; set; }

Property Value

Type	Description
System.Int32

ConnectionAddress

Gets or sets the IP address of the candidate.

Declaration

public string ConnectionAddress { get; set; }

Property Value

Type	Description
System.String

Extensions

Gets or sets the extensions.

Declaration

public Dictionary<string, string> Extensions { get; }

Property Value

Type	Description
Dictionary<System.String, System.String>

Foundation

Gets or sets the candidate's foundation.

Declaration

public string Foundation { get; set; }

Property Value

Type	Description
System.String

Port

Gets or sets the port of the candidate.

Declaration

public int Port { get; set; }

Property Value

Type	Description
System.Int32

Priority

Gets or sets the priority of the candidate.

Declaration

public long Priority { get; set; }

Property Value

Type	Description
System.Int64

Protocol

Gets or sets the protocol of this candidate.

Declaration

public string Protocol { get; set; }

Property Value

Type	Description
System.String

RelatedAddress

Gets or sets the IP address related to the candidate.

Declaration

public string RelatedAddress { get; set; }

Property Value

Type	Description
System.String

RelatedPort

Gets or sets the port related to the candidate.

Declaration

public int RelatedPort { get; set; }

Property Value

Type	Description
System.Int32

Methods

FromAttributeValue(String)

Initializes a new instance of the CandidateAttribute class.

Declaration

public static CandidateAttribute FromAttributeValue(string value)

Parameters

Type	Name	Description
System.String	value	The attribute as a string.

Returns

Type	Description
CandidateAttribute

GetAttributeValue()

Gets the value of the attribute.

Declaration

protected override string GetAttributeValue()

Returns

Type	Description
System.String

Overrides

Attribute.GetAttributeValue()