FMLiveSwitchXirSysV3Client Class Reference

A XirSys v3 client. More...

Instance Methods

(NSString *) - channel
 Gets the "channel" 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:channel:
 Initializes a new instance of the FMLiveSwitchXirSysV3Client class. More...
 
(instancetype) - initWithIdent:secret:channel:secure:
 Initializes a new instance of the FMLiveSwitchXirSysV3Client class. More...
 
(NSString *) - secret
 Gets the "secret" value. More...
 
(bool) - secure
 Gets the "secure" value. More...
 
(void) - setChannel:
 Sets the "channel" value. More...
 
(void) - setEndpoint:
 Sets the HTTP endpoint. More...
 
(void) - setIdent:
 Sets the "ident" value. More...
 
(void) - setSecret:
 Sets the "secret" value. More...
 
(void) - setSecure:
 Sets the "secure" value. More...
 

Class Methods

(FMLiveSwitchXirSysV3Client *) + clientWithIdent:secret:channel:
 Initializes a new instance of the FMLiveSwitchXirSysV3Client class. More...
 
(FMLiveSwitchXirSysV3Client *) + clientWithIdent:secret:channel:secure:
 Initializes a new instance of the FMLiveSwitchXirSysV3Client class. More...
 
(NSString *) + defaultEndpoint
 Gets the default HTTP endpoint. More...
 
(void) + setDefaultEndpoint:
 Sets the default HTTP endpoint. More...
 

Detailed Description

A XirSys v3 client.

Method Documentation

◆ channel

- (NSString*) channel

Gets the "channel" value.

◆ clientWithIdent:secret:channel:

+ (FMLiveSwitchXirSysV3Client*) clientWithIdent: (NSString *)  ident
secret: (NSString *)  secret
channel: (NSString *)  channel 

Initializes a new instance of the FMLiveSwitchXirSysV3Client class.

Parameters
identThe "ident" value.
secretThe "secret" value.
channelThe "channel" value.

◆ clientWithIdent:secret:channel:secure:

+ (FMLiveSwitchXirSysV3Client*) clientWithIdent: (NSString *)  ident
secret: (NSString *)  secret
channel: (NSString *)  channel
secure: (bool)  secure 

Initializes a new instance of the FMLiveSwitchXirSysV3Client class.

Parameters
identThe "ident" value.
secretThe "secret" value.
channelThe "channel" value.
secureThe "secure" value.

◆ defaultEndpoint

+ (NSString*) defaultEndpoint

Gets the default HTTP endpoint.

Defaults to "https://global.xirsys.net/_turn".

◆ 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:channel:

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

Initializes a new instance of the FMLiveSwitchXirSysV3Client class.

Parameters
identThe "ident" value.
secretThe "secret" value.
channelThe "channel" value.

◆ initWithIdent:secret:channel:secure:

- (instancetype) initWithIdent: (NSString *)  ident
secret: (NSString *)  secret
channel: (NSString *)  channel
secure: (bool)  secure 

Initializes a new instance of the FMLiveSwitchXirSysV3Client class.

Parameters
identThe "ident" value.
secretThe "secret" value.
channelThe "channel" value.
secureThe "secure" value.

◆ secret

- (NSString*) secret

Gets the "secret" value.

◆ secure

- (bool) secure

Gets the "secure" value.

Defaults to true.

◆ setChannel:

- (void) setChannel: (NSString *)  value

Sets the "channel" value.

◆ setDefaultEndpoint:

+ (void) setDefaultEndpoint: (NSString *)  value

Sets the default HTTP endpoint.

Defaults to "https://global.xirsys.net/_turn".

◆ setEndpoint:

- (void) setEndpoint: (NSString *)  value

Sets the HTTP endpoint.

◆ setIdent:

- (void) setIdent: (NSString *)  value

Sets the "ident" value.

◆ setSecret:

- (void) setSecret: (NSString *)  value

Sets the "secret" value.

◆ setSecure:

- (void) setSecure: (bool)  value

Sets the "secure" value.

Defaults to true.