/ fm / liveswitch / ConnectionConfig

Class: ConnectionConfig

fm.liveswitch.ConnectionConfig

Connection configuration.

Table of contents

Methods

• fmliveswitchConnectionConfigInit
• getAudioDirection
• getDataDirection
• getLocalAudioDisabled
• getLocalAudioMuted
• getLocalDataDisabled
• getLocalVideoDisabled
• getLocalVideoMuted
• getRemoteAudioDisabled
• getRemoteAudioEncoding
• getRemoteDataDisabled
• getRemoteVideoDisabled
• getRemoteVideoEncoding
• getTag
• getTypeString
• getVideoDirection
• setAudioDirection
• setDataDirection
• setLocalAudioDisabled
• setLocalAudioMuted
• setLocalDataDisabled
• setLocalVideoDisabled
• setLocalVideoMuted
• setRemoteAudioDisabled
• setRemoteAudioEncoding
• setRemoteDataDisabled
• setRemoteVideoDisabled
• setRemoteVideoEncoding
• setTag
• setVideoDirection
• toJson
• fromJson
• toJson

Methods

fmliveswitchConnectionConfigInit

▸ PrivatefmliveswitchConnectionConfigInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:29

---

getAudioDirection

▸ getAudioDirection(): string

Gets the audio direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:143

---

getDataDirection

▸ getDataDirection(): string

Gets the data direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:155

---

getLocalAudioDisabled

▸ getLocalAudioDisabled(): boolean

Gets if local audio is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:167

---

getLocalAudioMuted

▸ getLocalAudioMuted(): boolean

Gets if the local audio is muted.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:179

---

getLocalDataDisabled

▸ getLocalDataDisabled(): boolean

Gets if local data is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:191

---

getLocalVideoDisabled

▸ getLocalVideoDisabled(): boolean

Gets if local video is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:203

---

getLocalVideoMuted

▸ getLocalVideoMuted(): boolean

Gets if the local video is muted.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:215

---

getRemoteAudioDisabled

▸ getRemoteAudioDisabled(): boolean

Gets if remote audio is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:227

---

getRemoteAudioEncoding

▸ getRemoteAudioEncoding(): EncodingInfo

Gets the remote audio encoding.

Returns: EncodingInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:239

---

getRemoteDataDisabled

▸ getRemoteDataDisabled(): boolean

Gets if remote data is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:251

---

getRemoteVideoDisabled

▸ getRemoteVideoDisabled(): boolean

Gets if remote video is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:263

---

getRemoteVideoEncoding

▸ getRemoteVideoEncoding(): EncodingInfo

Gets the remote video encoding.

Returns: EncodingInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:275

---

getTag

▸ getTag(): string

Gets the tag for this connection.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:287

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

getVideoDirection

▸ getVideoDirection(): string

Gets the video direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:299

---

setAudioDirection

▸ setAudioDirection(value: string): void

Sets the audio direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:311

---

setDataDirection

▸ setDataDirection(value: string): void

Sets the data direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:323

---

setLocalAudioDisabled

▸ setLocalAudioDisabled(value: boolean): void

Sets if local audio is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:335

---

setLocalAudioMuted

▸ setLocalAudioMuted(value: boolean): void

Sets if the local audio is muted.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:347

---

setLocalDataDisabled

▸ setLocalDataDisabled(value: boolean): void

Sets if local data is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:359

---

setLocalVideoDisabled

▸ setLocalVideoDisabled(value: boolean): void

Sets if local video is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:371

---

setLocalVideoMuted

▸ setLocalVideoMuted(value: boolean): void

Sets if the local video is muted.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:383

---

setRemoteAudioDisabled

▸ setRemoteAudioDisabled(value: boolean): void

Sets if remote audio is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:395

---

setRemoteAudioEncoding

▸ setRemoteAudioEncoding(value: EncodingInfo): void

Sets the remote audio encoding.

Parameters:

Name	Type
value	EncodingInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:407

---

setRemoteDataDisabled

▸ setRemoteDataDisabled(value: boolean): void

Sets if remote data is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:419

---

setRemoteVideoDisabled

▸ setRemoteVideoDisabled(value: boolean): void

Sets if remote video is disabled.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:431

---

setRemoteVideoEncoding

▸ setRemoteVideoEncoding(value: EncodingInfo): void

Sets the remote video encoding.

Parameters:

Name	Type
value	EncodingInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:443

---

setTag

▸ setTag(value: string): void

Sets the tag for this connection.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:455

---

setVideoDirection

▸ setVideoDirection(value: string): void

Sets the video direction ("sendrecv", "sendonly", "recvonly", or "inactive").

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:467

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:479

---

fromJson

▸ StaticfromJson(connectionConfigJson: string): ConnectionConfig

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
connectionConfigJson	string	The JSON to deserialize.

Returns: ConnectionConfig

The deserialized connection config.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:59

---

toJson

▸ StatictoJson(connectionConfig: ConnectionConfig): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
connectionConfig	ConnectionConfig	The connection config to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionConfig.ts:106