FMIceLinkXirSysV3Client Class Reference

Inherits from NSObject
Declared in FMIceLinkXirSysV3Client.h
FMIceLinkXirSysV3Client.m

Overview

A XirSys v3 client.

– channel

Gets the "channel" value.
- (NSString *)channel

Discussion

Gets the "channel" value.

Declared In

FMIceLinkXirSysV3Client.h

+ clientWithIdent:secret:channel:

Initializes a new instance of the FMIceLinkXirSysV3Client class.
+ (FMIceLinkXirSysV3Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret channel:(NSString *)channel

Parameters

ident

The “ident” value.
secret

The “secret” value.
channel

The “channel” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV3Client class.

Declared In

FMIceLinkXirSysV3Client.h

+ clientWithIdent:secret:channel:secure:

Initializes a new instance of the FMIceLinkXirSysV3Client class.
+ (FMIceLinkXirSysV3Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret channel:(NSString *)channel secure:(bool)secure

Parameters

ident

The “ident” value.
secret

The “secret” value.
channel

The “channel” value.
secure

The “secure” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV3Client class.

Declared In

FMIceLinkXirSysV3Client.h

+ defaultEndpoint

Gets the default HTTP endpoint. Defaults to "[https://global.xirsys.net/_turn](https://global.xirsys.net/_turn)".
+ (NSString *)defaultEndpoint

Discussion

Gets the default HTTP endpoint. Defaults to "[https://global.xirsys.net/_turn](https://global.xirsys.net/_turn)".

Declared In

FMIceLinkXirSysV3Client.h

– endpoint

Gets the HTTP endpoint.
- (NSString *)endpoint

Discussion

Gets the HTTP endpoint.

Declared In

FMIceLinkXirSysV3Client.h

– getIceServers

Gets an array of XirSys ICE servers.

@return

- (FMIceLinkFuture<NSMutableArray*> *)getIceServers

Discussion

Gets an array of XirSys ICE servers.

@return

Declared In

FMIceLinkXirSysV3Client.h

– ident

Gets the "ident" value.
- (NSString *)ident

Discussion

Gets the "ident" value.

Declared In

FMIceLinkXirSysV3Client.h

– initWithIdent:secret:channel:

Initializes a new instance of the FMIceLinkXirSysV3Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret channel:(NSString *)channel

Parameters

ident

The “ident” value.
secret

The “secret” value.
channel

The “channel” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV3Client class.

Declared In

FMIceLinkXirSysV3Client.h

– initWithIdent:secret:channel:secure:

Initializes a new instance of the FMIceLinkXirSysV3Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret channel:(NSString *)channel secure:(bool)secure

Parameters

ident

The “ident” value.
secret

The “secret” value.
channel

The “channel” value.
secure

The “secure” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV3Client class.

Declared In

FMIceLinkXirSysV3Client.h

– secret

Gets the "secret" value.
- (NSString *)secret

Discussion

Gets the "secret" value.

Declared In

FMIceLinkXirSysV3Client.h

– secure

Gets the "secure" value. Defaults to true.
- (bool)secure

Discussion

Gets the "secure" value. Defaults to true.

Declared In

FMIceLinkXirSysV3Client.h

– setChannel:

Sets the "channel" value.
- (void)setChannel:(NSString *)value

Discussion

Sets the "channel" value.

Declared In

FMIceLinkXirSysV3Client.h

+ setDefaultEndpoint:

Sets the default HTTP endpoint. Defaults to "[https://global.xirsys.net/_turn](https://global.xirsys.net/_turn)".
+ (void)setDefaultEndpoint:(NSString *)value

Discussion

Sets the default HTTP endpoint. Defaults to "[https://global.xirsys.net/_turn](https://global.xirsys.net/_turn)".

Declared In

FMIceLinkXirSysV3Client.h

– setEndpoint:

Sets the HTTP [endpoint](#//api/name/endpoint).
- (void)setEndpoint:(NSString *)value

Discussion

Sets the HTTP [endpoint](#//api/name/endpoint).

Declared In

FMIceLinkXirSysV3Client.h

– setIdent:

Sets the "ident" value.
- (void)setIdent:(NSString *)value

Discussion

Sets the "ident" value.

Declared In

FMIceLinkXirSysV3Client.h

– setSecret:

Sets the "secret" value.
- (void)setSecret:(NSString *)value

Discussion

Sets the "secret" value.

Declared In

FMIceLinkXirSysV3Client.h

– setSecure:

Sets the "secure" value. Defaults to true.
- (void)setSecure:(bool)value

Discussion

Sets the "secure" value. Defaults to true.

Declared In

FMIceLinkXirSysV3Client.h