/ fm / liveswitch / IceServer

Class: IceServer

fm.liveswitch.IceServer

An ICE server.

Table of contents

Constructors

• constructor

Methods

• getHost
• getIsSecure
• getIsStun
• getIsTcp
• getIsTurn
• getIsUdp
• getPassword
• getPort
• getTypeString
• getUrl
• getUsername
• toJson
• fromJson
• fromJsonArray
• getDefaultPort
• getDefaultStunPort
• getDefaultStunsPort
• getDefaultTurnPort
• getDefaultTurnsPort
• toJson
• toJsonArray

Constructors

constructor

+ new IceServer(): IceServer

Returns: IceServer

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:21

+ new IceServer(url: string): IceServer

Initializes a new instance of the [[fm.liveswitch.iceServer]] class.

Parameters:

Name	Type	Description
url	string	The URL.

Returns: IceServer

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:23

+ new IceServer(url: string, username: string, password: string): IceServer

Initializes a new instance of the [[fm.liveswitch.iceServer]] class.

Parameters:

Name	Type	Description
url	string	The URL.
username	string	The username.
password	string	The password.

Returns: IceServer

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:30

Methods

getHost

▸ getHost(): string

Gets the host.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:302

---

getIsSecure

▸ getIsSecure(): boolean

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

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:343

---

getIsStun

▸ getIsStun(): boolean

Gets a value indicating whether this represents a STUN server.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:355

---

getIsTcp

▸ getIsTcp(): boolean

Gets a value indicating whether this represents a TCP server.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:367

---

getIsTurn

▸ getIsTurn(): boolean

Gets a value indicating whether this represents a TURN server.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:379

---

getIsUdp

▸ getIsUdp(): boolean

Gets a value indicating whether this represents a UDP server.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:391

---

getPassword

▸ getPassword(): string

Gets the password.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:403

---

getPort

▸ getPort(): number

Gets the port.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:415

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:9

---

getUrl

▸ getUrl(): string

Gets the URL.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:446

---

getUsername

▸ getUsername(): string

Gets the username.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:458

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:513

---

fromJson

▸ StaticfromJson(iceServerJson: string): IceServer

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
iceServerJson	string	The JSON to deserialize.

Returns: IceServer

The deserialized ICE server.

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:97

---

fromJsonArray

▸ StaticfromJsonArray(iceServersJson: string): IceServer[]

Deserializes an array of instances from JSON.

Parameters:

Name	Type	Description
iceServersJson	string	The JSON to deserialize.

Returns: IceServer[]

The deserialized ICE server array.

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:128

---

getDefaultPort

▸ StaticgetDefaultPort(): number

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

deprecated Use DefaultStunPort, DefaultTurnPort, DefaultStunsPort, or DefaultTurnsPort instead.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:145

---

getDefaultStunPort

▸ StaticgetDefaultStunPort(): number

Gets the default STUN port.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:157

---

getDefaultStunsPort

▸ StaticgetDefaultStunsPort(): number

Gets the default STUNS port.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:169

---

getDefaultTurnPort

▸ StaticgetDefaultTurnPort(): number

Gets the default TURN port.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:181

---

getDefaultTurnsPort

▸ StaticgetDefaultTurnsPort(): number

Gets the default TURNS port.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:193

---

toJson

▸ StatictoJson(iceServer: IceServer): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
iceServer	IceServer	The ICE server.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:264

---

toJsonArray

▸ StatictoJsonArray(iceServers: IceServer[]): string

Serializes an array of instances to JSON.

Parameters:

Name	Type	Description
iceServers	IceServer[]	The ICE servers.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/IceServer.ts:290