Class Client

A XirSys v2 client.

Inheritance

System.Object

Client

Namespace: FM.LiveSwitch.XirSys.V2

Assembly: FM.LiveSwitch.XirSys.dll

Syntax

public class Client : object

Constructors

Client(String, String, String)

Initializes a new instance of the Client class.

Declaration

public Client(string ident, string secret, string domain)

Parameters

Type	Name	Description
System.String	ident	The "ident" value.
System.String	secret	The "secret" value.
System.String	domain	The "domain" value.

Client(String, String, String, String)

Initializes a new instance of the Client class.

Declaration

public Client(string ident, string secret, string domain, string application)

Parameters

Type	Name	Description
System.String	ident	The "ident" value.
System.String	secret	The "secret" value.
System.String	domain	The "domain" value.
System.String	application	The "application" value.

Client(String, String, String, String, String)

Initializes a new instance of the Client class.

Declaration

public Client(string ident, string secret, string domain, string application, string room)

Parameters

Type	Name	Description
System.String	ident	The "ident" value.
System.String	secret	The "secret" value.
System.String	domain	The "domain" value.
System.String	application	The "application" value.
System.String	room	The "room" value.

Client(String, String, String, String, String, Boolean)

Initializes a new instance of the Client class.

Declaration

public Client(string ident, string secret, string domain, string application, string room, bool secure)

Parameters

Type	Name	Description
System.String	ident	The "ident" value.
System.String	secret	The "secret" value.
System.String	domain	The "domain" value.
System.String	application	The "application" value.
System.String	room	The "room" value.
System.Boolean	secure	The "secure" value.

Properties

Application

Gets or sets the "application" value. Defaults to "default".

Declaration

public string Application { get; set; }

Property Value

Type	Description
System.String

DefaultEndpoint

Gets or sets the default HTTP endpoint. Defaults to "https://service.xirsys.com/ice".

Declaration

public static string DefaultEndpoint { get; set; }

Property Value

Type	Description
System.String

Domain

Gets or sets the "domain" value.

Declaration

public string Domain { get; set; }

Property Value

Type	Description
System.String

Endpoint

Gets or sets the HTTP endpoint.

Declaration

public string Endpoint { get; set; }

Property Value

Type	Description
System.String

Ident

Gets or sets the "ident" value.

Declaration

public string Ident { get; set; }

Property Value

Type	Description
System.String

Room

Gets or sets the "room" value. Defaults to "default".

Declaration

public string Room { get; set; }

Property Value

Type	Description
System.String

Secret

Gets or sets the "secret" value.

Declaration

public string Secret { get; set; }

Property Value

Type	Description
System.String

Secure

Gets or sets the "secure" value. Defaults to true.

Declaration

public bool Secure { get; set; }

Property Value

Type	Description
System.Boolean

Methods

GetIceServers()

Gets an array of XirSys ICE servers.

Declaration

public Future<IceServer[]> GetIceServers()

Returns

Type	Description
Future<IceServer[]>