Class IceServer

An ICE server.

Inheritance

System.Object

IceServer

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class IceServer : object

Constructors

IceServer(String)

Initializes a new instance of the IceServer class.

Declaration

public IceServer(string url)

Parameters

Type	Name	Description
System.String	url	The URL.

IceServer(String, String, String)

Initializes a new instance of the IceServer class.

Declaration

public IceServer(string url, string username, string password)

Parameters

Type	Name	Description
System.String	url	The URL.
System.String	username	The username.
System.String	password	The password.

Properties

DefaultPort

Gets the default non-secure port (in use for STUN and TURN).

Declaration

public static int DefaultPort { get; }

Property Value

Type	Description
System.Int32

DefaultStunPort

Gets the default STUN port.

Declaration

public static int DefaultStunPort { get; }

Property Value

Type	Description
System.Int32

DefaultStunsPort

Gets the default STUNS port.

Declaration

public static int DefaultStunsPort { get; }

Property Value

Type	Description
System.Int32

DefaultTurnPort

Gets the default TURN port.

Declaration

public static int DefaultTurnPort { get; }

Property Value

Type	Description
System.Int32

DefaultTurnsPort

Gets the default TURNS port.

Declaration

public static int DefaultTurnsPort { get; }

Property Value

Type	Description
System.Int32

Host

Gets the host.

Declaration

public string Host { get; }

Property Value

Type	Description
System.String

IsSecure

Gets a value indicating whether this represents a secure STUN or TURN server.

Declaration

public bool IsSecure { get; }

Property Value

Type	Description
System.Boolean

IsStun

Gets a value indicating whether this represents a STUN server.

Declaration

public bool IsStun { get; }

Property Value

Type	Description
System.Boolean

IsTcp

Gets a value indicating whether this represents a TCP server.

Declaration

public bool IsTcp { get; }

Property Value

Type	Description
System.Boolean

IsTurn

Gets a value indicating whether this represents a TURN server.

Declaration

public bool IsTurn { get; }

Property Value

Type	Description
System.Boolean

IsUdp

Gets a value indicating whether this represents a UDP server.

Declaration

public bool IsUdp { get; }

Property Value

Type	Description
System.Boolean

Password

Gets or sets the password.

Declaration

public string Password { get; }

Property Value

Type	Description
System.String

Port

Gets the port.

Declaration

public int Port { get; }

Property Value

Type	Description
System.Int32

Url

Gets or sets the URL.

Declaration

public string Url { get; }

Property Value

Type	Description
System.String

Username

Gets or sets the username.

Declaration

public string Username { get; }

Property Value

Type	Description
System.String

Methods

FromJson(String)

Deserializes an instance from JSON.

Declaration

public static IceServer FromJson(string iceServerJson)

Parameters

Type	Name	Description
System.String	iceServerJson	The JSON to deserialize.

Returns

Type	Description
IceServer	The deserialized ICE server.

FromJsonArray(String)

Deserializes an array of instances from JSON.

Declaration

public static IceServer[] FromJsonArray(string iceServersJson)

Parameters

Type	Name	Description
System.String	iceServersJson	The JSON to deserialize.

Returns

Type	Description
IceServer[]	The deserialized ICE server array.

ToJson()

Serializes this instance to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String	The serialized JSON.

ToJson(IceServer)

Serializes an instance to JSON.

Declaration

public static string ToJson(IceServer iceServer)

Parameters

Type	Name	Description
IceServer	iceServer	The ICE server.

Returns

Type	Description
System.String	The serialized JSON.

ToJsonArray(IceServer[])

Serializes an array of instances to JSON.

Declaration

public static string ToJsonArray(IceServer[] iceServers)

Parameters

Type	Name	Description
IceServer[]	iceServers	The ICE servers.

Returns

Type	Description
System.String	The serialized JSON.