fm.liveswitch.xirsys.v2.Client Class Reference

A XirSys v2 client. More...

Public Member Functions
	Client (String ident, String secret, String domain)
	Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class. More...
	Client (String ident, String secret, String domain, String application)
	Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class. More...
	Client (String ident, String secret, String domain, String application, String room)
	Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class. More...
	Client (String ident, String secret, String domain, String application, String room, boolean secure)
	Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class. More...
String	getApplication ()
	Gets the "application" value. More...
String	getDomain ()
	Gets the "domain" value. More...
String	getEndpoint ()
	Gets the HTTP endpoint. More...
fm.liveswitch.Future< fm.liveswitch.IceServer[]>	getIceServers ()
	Gets an array of XirSys ICE servers. More...
String	getIdent ()
	Gets the "ident" value. More...
String	getRoom ()
	Gets the "room" value. More...
String	getSecret ()
	Gets the "secret" value. More...
boolean	getSecure ()
	Gets the "secure" value. More...
void	setApplication (String value)
	Sets the "application" value. More...
void	setDomain (String value)
	Sets the "domain" value. More...
void	setEndpoint (String value)
	Sets the HTTP endpoint. More...
void	setIdent (String value)
	Sets the "ident" value. More...
void	setRoom (String value)
	Sets the "room" value. More...
void	setSecret (String value)
	Sets the "secret" value. More...
void	setSecure (boolean value)
	Sets the "secure" value. More...

Static Public Member Functions
static String	getDefaultEndpoint ()
	Gets the default HTTP endpoint. More...
static void	setDefaultEndpoint (String value)
	Sets the default HTTP endpoint. More...

Detailed Description

A XirSys v2 client.

Constructor & Destructor Documentation

Client() [1/4]

fm.liveswitch.xirsys.v2.Client.Client	(	String	ident,
		String	secret,
		String	domain
	)

Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class.

Parameters

ident	The "ident" value.
secret	The "secret" value.
domain	The "domain" value.

Client() [2/4]

fm.liveswitch.xirsys.v2.Client.Client	(	String	ident,
		String	secret,
		String	domain,
		String	application
	)

Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class.

Parameters

ident	The "ident" value.
secret	The "secret" value.
domain	The "domain" value.
application	The "application" value.

Client() [3/4]

fm.liveswitch.xirsys.v2.Client.Client	(	String	ident,
		String	secret,
		String	domain,
		String	application,
		String	room
	)

Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class.

Parameters

ident	The "ident" value.
secret	The "secret" value.
domain	The "domain" value.
application	The "application" value.
room	The "room" value.

Client() [4/4]

fm.liveswitch.xirsys.v2.Client.Client	(	String	ident,
		String	secret,
		String	domain,
		String	application,
		String	room,
		boolean	secure
	)

Initializes a new instance of the fm.liveswitch.xirsys.v2.Client class.

Parameters

ident	The "ident" value.
secret	The "secret" value.
domain	The "domain" value.
application	The "application" value.
room	The "room" value.
secure	The "secure" value.

Member Function Documentation

getApplication()

String fm.liveswitch.xirsys.v2.Client.getApplication

(

)

Gets the "application" value.

Defaults to "default".

getDefaultEndpoint()

static String fm.liveswitch.xirsys.v2.Client.getDefaultEndpoint ( )

static

Gets the default HTTP endpoint.

Defaults to "https://service.xirsys.com/ice".

getDomain()

String fm.liveswitch.xirsys.v2.Client.getDomain

(

)

Gets the "domain" value.

getEndpoint()

String fm.liveswitch.xirsys.v2.Client.getEndpoint

(

)

Gets the HTTP endpoint.

getIceServers()

fm.liveswitch.Future<fm.liveswitch.IceServer[]> fm.liveswitch.xirsys.v2.Client.getIceServers

(

)

Gets an array of XirSys ICE servers.

getIdent()

String fm.liveswitch.xirsys.v2.Client.getIdent

(

)

Gets the "ident" value.

getRoom()

String fm.liveswitch.xirsys.v2.Client.getRoom

(

)

Gets the "room" value.

Defaults to "default".

getSecret()

String fm.liveswitch.xirsys.v2.Client.getSecret

(

)

Gets the "secret" value.

getSecure()

boolean fm.liveswitch.xirsys.v2.Client.getSecure

(

)

Gets the "secure" value.

Defaults to

true  

.

setApplication()

void fm.liveswitch.xirsys.v2.Client.setApplication

(

String

value

)

Sets the "application" value.

Defaults to "default".

setDefaultEndpoint()

static void fm.liveswitch.xirsys.v2.Client.setDefaultEndpoint ( String  value )

static

Sets the default HTTP endpoint.

Defaults to "https://service.xirsys.com/ice".

setDomain()

void fm.liveswitch.xirsys.v2.Client.setDomain

(

String

value

)

Sets the "domain" value.

setEndpoint()

void fm.liveswitch.xirsys.v2.Client.setEndpoint

(

String

value

)

Sets the HTTP endpoint.

setIdent()

void fm.liveswitch.xirsys.v2.Client.setIdent

(

String

value

)

Sets the "ident" value.

setRoom()

void fm.liveswitch.xirsys.v2.Client.setRoom

(

String

value

)

Sets the "room" value.

Defaults to "default".

setSecret()

void fm.liveswitch.xirsys.v2.Client.setSecret

(

String

value

)

Sets the "secret" value.

setSecure()

void fm.liveswitch.xirsys.v2.Client.setSecure

(

boolean

value

)

Sets the "secure" value.

Defaults to

true  

.