Class Candidate
A candidate.
Inheritance
System.Object
Candidate
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class Candidate
Properties
Dispatched
Gets or sets a value indicating whether this candidate has been already been dispatched as a part of a session description.
Declaration
public bool Dispatched { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
RelayProtocol
Gets or sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.
Declaration
public ProtocolType RelayProtocol { get; set; }
Property Value
Type | Description |
---|---|
ProtocolType |
SdpCandidateAttribute
Gets or sets the SDP candidate attribute.
Declaration
public CandidateAttribute SdpCandidateAttribute { get; set; }
Property Value
Type | Description |
---|---|
CandidateAttribute |
SdpMediaIndex
Gets or sets the media index.
Declaration
public int SdpMediaIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
TurnTransportProtocol
Gets or sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.
Declaration
[Obsolete("Use RelayProtocol instead.")]
public ProtocolType TurnTransportProtocol { get; set; }
Property Value
Type | Description |
---|---|
ProtocolType |
Methods
FromJson(String)
Deserializes an instance from JSON.
Declaration
public static Candidate FromJson(string candidateJson)
Parameters
Type | Name | Description |
---|---|---|
System.String | candidateJson | The JSON to deserialize. |
Returns
Type | Description |
---|---|
Candidate | The deserialized candidate. |
ToJson()
Serializes this instance to JSON.
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String |
ToJson(Candidate)
Serializes an instance to JSON.
Declaration
public static string ToJson(Candidate candidate)
Parameters
Type | Name | Description |
---|---|---|
Candidate | candidate | The candidate to serialize. |
Returns
Type | Description |
---|---|
System.String | The serialized JSON. |