/ fm / liveswitch / IceServer
Class: IceServer
fm.liveswitch.IceServer
An ICE server.
Table of contents
Constructors
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
+ 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
+ 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
Methods
getHost
▸ getHost(): string
Gets the host.
Returns: string
getIsSecure
▸ getIsSecure(): boolean
Gets a value indicating whether this represents a secure STUN or TURN server.
Returns: boolean
getIsStun
▸ getIsStun(): boolean
Gets a value indicating whether this represents a STUN server.
Returns: boolean
getIsTcp
▸ getIsTcp(): boolean
Gets a value indicating whether this represents a TCP server.
Returns: boolean
getIsTurn
▸ getIsTurn(): boolean
Gets a value indicating whether this represents a TURN server.
Returns: boolean
getIsUdp
▸ getIsUdp(): boolean
Gets a value indicating whether this represents a UDP server.
Returns: boolean
getPassword
▸ getPassword(): string
Gets the password.
Returns: string
getPort
▸ getPort(): number
Gets the port.
Returns: number
getTypeString
▸ getTypeString(): string
Returns: string
getUrl
▸ getUrl(): string
Gets the URL.
Returns: string
getUsername
▸ getUsername(): string
Gets the username.
Returns: string
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
The serialized JSON.
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.
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.
getDefaultPort
▸ StaticgetDefaultPort(): number
Gets the default non-secure port (in use for STUN and TURN).
Returns: number
getDefaultStunPort
▸ StaticgetDefaultStunPort(): number
Gets the default STUN port.
Returns: number
getDefaultStunsPort
▸ StaticgetDefaultStunsPort(): number
Gets the default STUNS port.
Returns: number
getDefaultTurnPort
▸ StaticgetDefaultTurnPort(): number
Gets the default TURN port.
Returns: number
getDefaultTurnsPort
▸ StaticgetDefaultTurnsPort(): number
Gets the default TURNS port.
Returns: number
toJson
▸ StatictoJson(iceServer: IceServer): string
Serializes an instance to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
iceServer |
IceServer | The ICE server. |
Returns: string
The serialized JSON.
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.