/ fm / liveswitch / ChannelConnectionConfig

Class: ChannelConnectionConfig

fm.liveswitch.ChannelConnectionConfig

Channel connection configuration.

Table of contents

Constructors

• constructor

Methods

• getAudioMuted
• getAudioUnmuteDisabled
• getRecording
• getRecordingTag
• getTypeString
• getVideoMuted
• getVideoUnmuteDisabled
• setAudioMuted
• setAudioUnmuteDisabled
• setRecording
• setRecordingTag
• setVideoMuted
• setVideoUnmuteDisabled
• toJson
• fromJson
• toJson

Constructors

constructor

+ new ChannelConnectionConfig(): ChannelConnectionConfig

Returns: ChannelConnectionConfig

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

Methods

getAudioMuted

▸ getAudioMuted(): boolean

Gets whether to mute or unmute audio.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:117

---

getAudioUnmuteDisabled

▸ getAudioUnmuteDisabled(): boolean

Gets whether to disable audio unmuting.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:129

---

getRecording

▸ getRecording(): boolean

Gets whether to enable recording.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:141

---

getRecordingTag

▸ getRecordingTag(): string

Gets the tag for the recording, if recording is being enabled.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:153

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

getVideoMuted

▸ getVideoMuted(): boolean

Gets whether to mute or unmute video.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:165

---

getVideoUnmuteDisabled

▸ getVideoUnmuteDisabled(): boolean

Gets whether to disable video unmuting.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:177

---

setAudioMuted

▸ setAudioMuted(value: boolean): void

Sets whether to mute or unmute audio.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:189

---

setAudioUnmuteDisabled

▸ setAudioUnmuteDisabled(value: boolean): void

Sets whether to disable audio unmuting.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:201

---

setRecording

▸ setRecording(value: boolean): void

Sets whether to enable recording.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:213

---

setRecordingTag

▸ setRecordingTag(value: string): void

Sets the tag for the recording, if recording is being enabled.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:225

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Sets whether to mute or unmute video.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:237

---

setVideoUnmuteDisabled

▸ setVideoUnmuteDisabled(value: boolean): void

Sets whether to disable video unmuting.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:249

---

toJson

▸ toJson(): string

Serializes this channel client configuration to JSON.

Returns: string

The channel client configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:262

---

fromJson

▸ StaticfromJson(channelConnectionConfigJson: string): ChannelConnectionConfig

Deserializes a channel connection configuration from JSON.

Parameters:

Name	Type	Description
channelConnectionConfigJson	string	The channel connection configuration as JSON.

Returns: ChannelConnectionConfig

The channel connection configuration.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:43

---

toJson

▸ StatictoJson(channelConnectionConfig: ChannelConnectionConfig): string

Serializes a channel connection configuration to JSON.

Parameters:

Name	Type	Description
channelConnectionConfig	ChannelConnectionConfig	The channel connection configuration.

Returns: string

The channel connection configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelConnectionConfig.ts:86