FMLiveSwitchXirSysV2Client Class Reference

A XirSys v2 client. More...

Instance Methods
(NSString *)	- application
	Gets the "application" value. More...
(NSString *)	- domain
	Gets the "domain" value. More...
(NSString *)	- endpoint
	Gets the HTTP endpoint. More...
(FMLiveSwitchFuture< NSMutableArray * > *)	- getIceServers
	Gets an array of XirSys ICE servers. More...
(NSString *)	- ident
	Gets the "ident" value. More...
(instancetype)	- initWithIdent:secret:domain:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(instancetype)	- initWithIdent:secret:domain:application:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(instancetype)	- initWithIdent:secret:domain:application:room:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(instancetype)	- initWithIdent:secret:domain:application:room:secure:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(NSString *)	- room
	Gets the "room" value. More...
(NSString *)	- secret
	Gets the "secret" value. More...
(bool)	- secure
	Gets the "secure" value. More...
(void)	- setApplication:
	Sets the "application" value. More...
(void)	- setDomain:
	Sets the "domain" value. More...
(void)	- setEndpoint:
	Sets the HTTP endpoint. More...
(void)	- setIdent:
	Sets the "ident" value. More...
(void)	- setRoom:
	Sets the "room" value. More...
(void)	- setSecret:
	Sets the "secret" value. More...
(void)	- setSecure:
	Sets the "secure" value. More...

Class Methods
(FMLiveSwitchXirSysV2Client *)	+ clientWithIdent:secret:domain:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(FMLiveSwitchXirSysV2Client *)	+ clientWithIdent:secret:domain:application:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(FMLiveSwitchXirSysV2Client *)	+ clientWithIdent:secret:domain:application:room:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(FMLiveSwitchXirSysV2Client *)	+ clientWithIdent:secret:domain:application:room:secure:
	Initializes a new instance of the FMLiveSwitchXirSysV2Client class. More...
(NSString *)	+ defaultEndpoint
	Gets the default HTTP endpoint. More...
(void)	+ setDefaultEndpoint:
	Sets the default HTTP endpoint. More...

Detailed Description

A XirSys v2 client.

Method Documentation

application

- (NSString*) application

Gets the "application" value.

Defaults to "default".

clientWithIdent:secret:domain:

+ (FMLiveSwitchXirSysV2Client*) clientWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

clientWithIdent:secret:domain:application:

+ (FMLiveSwitchXirSysV2Client*) clientWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

clientWithIdent:secret:domain:application:room:

+ (FMLiveSwitchXirSysV2Client*) clientWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application
room:		(NSString *)	room

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

clientWithIdent:secret:domain:application:room:secure:

+ (FMLiveSwitchXirSysV2Client*) clientWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application
room:		(NSString *)	room
secure:		(bool)	secure

Initializes a new instance of the FMLiveSwitchXirSysV2Client 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.

defaultEndpoint

+ (NSString*) defaultEndpoint

Gets the default HTTP endpoint.

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

domain

- (NSString*) domain

Gets the "domain" value.

endpoint

- (NSString*) endpoint

Gets the HTTP endpoint.

getIceServers

- (FMLiveSwitchFuture<NSMutableArray*>*) getIceServers

Gets an array of XirSys ICE servers.

ident

- (NSString*) ident

Gets the "ident" value.

initWithIdent:secret:domain:

- (instancetype) initWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

initWithIdent:secret:domain:application:

- (instancetype) initWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

initWithIdent:secret:domain:application:room:

- (instancetype) initWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application
room:		(NSString *)	room

Initializes a new instance of the FMLiveSwitchXirSysV2Client class.

Parameters

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

initWithIdent:secret:domain:application:room:secure:

- (instancetype) initWithIdent:		(NSString *)	ident
secret:		(NSString *)	secret
domain:		(NSString *)	domain
application:		(NSString *)	application
room:		(NSString *)	room
secure:		(bool)	secure

Initializes a new instance of the FMLiveSwitchXirSysV2Client 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.

room

- (NSString*) room

Gets the "room" value.

Defaults to "default".

secret

- (NSString*) secret

Gets the "secret" value.

secure

- (bool) secure

Gets the "secure" value.

Defaults to true.

setApplication:

- (void) setApplication:

(NSString *)

value

Sets the "application" value.

Defaults to "default".

setDefaultEndpoint:

+ (void) setDefaultEndpoint:

(NSString *)

value

Sets the default HTTP endpoint.

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

setDomain:

- (void) setDomain:

(NSString *)

value

Sets the "domain" value.

setEndpoint:

- (void) setEndpoint:

(NSString *)

value

Sets the HTTP endpoint.

setIdent:

- (void) setIdent:

(NSString *)

value

Sets the "ident" value.

setRoom:

- (void) setRoom:

(NSString *)

value

Sets the "room" value.

Defaults to "default".

setSecret:

- (void) setSecret:

(NSString *)

value

Sets the "secret" value.

setSecure:

- (void) setSecure:

(bool)

value

Sets the "secure" value.

Defaults to true.