FMLiveSwitchIceServer Class Reference

An ICE server. More...

Instance Methods
(NSString *)	- host
	Gets the host. More...
(instancetype)	- initWithUrl:
	Initializes a new instance of the FMLiveSwitchIceServer class. More...
(instancetype)	- initWithUrl:username:password:
	Initializes a new instance of the FMLiveSwitchIceServer class. More...
(bool)	- isSecure
	Gets a value indicating whether this represents a secure STUN or TURN server. More...
(bool)	- isStun
	Gets a value indicating whether this represents a STUN server. More...
(bool)	- isTcp
	Gets a value indicating whether this represents a TCP server. More...
(bool)	- isTurn
	Gets a value indicating whether this represents a TURN server. More...
(bool)	- isUdp
	Gets a value indicating whether this represents a UDP server. More...
(NSString *)	- password
	Gets the password. More...
(int)	- port
	Gets the port. More...
(NSString *)	- toJson
	Serializes this instance to JSON. More...
(NSString *)	- url
	Gets the URL. More...
(NSString *)	- username
	Gets the username. More...

Class Methods
(int)	+ defaultPort
	Gets the default non-secure port (in use for STUN and TURN). More...
(int)	+ defaultStunPort
	Gets the default STUN port. More...
(int)	+ defaultStunsPort
	Gets the default STUNS port. More...
(int)	+ defaultTurnPort
	Gets the default TURN port. More...
(int)	+ defaultTurnsPort
	Gets the default TURNS port. More...
(NSMutableArray *)	+ fromJsonArrayWithIceServersJson:
	Deserializes an array of instances from JSON. More...
(FMLiveSwitchIceServer *)	+ fromJsonWithIceServerJson:
	Deserializes an instance from JSON. More...
(FMLiveSwitchIceServer *)	+ iceServerWithUrl:
	Initializes a new instance of the FMLiveSwitchIceServer class. More...
(FMLiveSwitchIceServer *)	+ iceServerWithUrl:username:password:
	Initializes a new instance of the FMLiveSwitchIceServer class. More...
(NSString *)	+ toJsonArrayWithIceServers:
	Serializes an array of instances to JSON. More...
(NSString *)	+ toJsonWithIceServer:
	Serializes an instance to JSON. More...

Detailed Description

An ICE server.

Method Documentation

defaultPort

+ (int) defaultPort

Gets the default non-secure port (in use for STUN and TURN).

Deprecated:

Use DefaultStunPort, DefaultTurnPort, DefaultStunsPort, or DefaultTurnsPort instead.

defaultStunPort

+ (int) defaultStunPort

Gets the default STUN port.

defaultStunsPort

+ (int) defaultStunsPort

Gets the default STUNS port.

defaultTurnPort

+ (int) defaultTurnPort

Gets the default TURN port.

defaultTurnsPort

+ (int) defaultTurnsPort

Gets the default TURNS port.

fromJsonArrayWithIceServersJson:

+ (NSMutableArray*) fromJsonArrayWithIceServersJson:

(NSString *)

iceServersJson

Deserializes an array of instances from JSON.

Parameters

iceServersJson

The JSON to deserialize.

Returns

The deserialized ICE server array.

fromJsonWithIceServerJson:

+ (FMLiveSwitchIceServer*) fromJsonWithIceServerJson:

(NSString *)

iceServerJson

Deserializes an instance from JSON.

Parameters

iceServerJson

The JSON to deserialize.

Returns

The deserialized ICE server.

host

- (NSString*) host

Gets the host.

iceServerWithUrl:

+ (FMLiveSwitchIceServer*) iceServerWithUrl:

(NSString *)

url

Initializes a new instance of the FMLiveSwitchIceServer class.

Parameters

url

The URL.

iceServerWithUrl:username:password:

+ (FMLiveSwitchIceServer*) iceServerWithUrl:		(NSString *)	url
username:		(NSString *)	username
password:		(NSString *)	password

Initializes a new instance of the FMLiveSwitchIceServer class.

Parameters

url	The URL.
username	The username.
password	The password.

initWithUrl:

- (instancetype) initWithUrl:

(NSString *)

url

Initializes a new instance of the FMLiveSwitchIceServer class.

Parameters

url

The URL.

initWithUrl:username:password:

- (instancetype) initWithUrl:		(NSString *)	url
username:		(NSString *)	username
password:		(NSString *)	password

Initializes a new instance of the FMLiveSwitchIceServer class.

Parameters

url	The URL.
username	The username.
password	The password.

isSecure

- (bool) isSecure

Gets a value indicating whether this represents a secure STUN or TURN server.

isStun

- (bool) isStun

Gets a value indicating whether this represents a STUN server.

isTcp

- (bool) isTcp

Gets a value indicating whether this represents a TCP server.

isTurn

- (bool) isTurn

Gets a value indicating whether this represents a TURN server.

isUdp

- (bool) isUdp

Gets a value indicating whether this represents a UDP server.

password

- (NSString*) password

Gets the password.

port

- (int) port

Gets the port.

toJson

- (NSString*) toJson

Serializes this instance to JSON.

Returns

The serialized JSON.

toJsonArrayWithIceServers:

+ (NSString*) toJsonArrayWithIceServers:

(NSMutableArray *)

iceServers

Serializes an array of instances to JSON.

Parameters

iceServers

The ICE servers.

Returns

The serialized JSON.

toJsonWithIceServer:

+ (NSString*) toJsonWithIceServer:

(FMLiveSwitchIceServer *)

iceServer

Serializes an instance to JSON.

Parameters

iceServer

The ICE server.

Returns

The serialized JSON.

url

- (NSString*) url

Gets the URL.

username

- (NSString*) username

Gets the username.