/ fm / liveswitch / ChannelUserConfig

Class: ChannelUserConfig

fm.liveswitch.ChannelUserConfig

Channel user configuration.

Table of contents

Constructors

• constructor

Methods

• getAudioMuted
• getAudioUnmuteDisabled
• getExcludedClientIds
• getExcludedConnectionIds
• getExcludedDeviceIds
• getRecording
• getRecordingMode
• getRecordingTag
• getTypeString
• getVideoMuted
• getVideoUnmuteDisabled
• setAudioMuted
• setAudioUnmuteDisabled
• setExcludedClientIds
• setExcludedConnectionIds
• setExcludedDeviceIds
• setRecording
• setRecordingMode
• setRecordingTag
• setVideoMuted
• setVideoUnmuteDisabled
• toJson
• fromJson
• toJson

Constructors

constructor

+ new ChannelUserConfig(): ChannelUserConfig

Returns: ChannelUserConfig

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:31

Methods

getAudioMuted

▸ getAudioMuted(): boolean

Gets whether to mute or unmute audio.

Returns: boolean

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

---

getAudioUnmuteDisabled

▸ getAudioUnmuteDisabled(): boolean

Gets whether to disable audio unmuting.

Returns: boolean

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

---

getExcludedClientIds

▸ getExcludedClientIds(): string[]

Gets the client identifiers to exclude.

Returns: string[]

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

---

getExcludedConnectionIds

▸ getExcludedConnectionIds(): string[]

Gets the connection identifiers to exclude.

Returns: string[]

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

---

getExcludedDeviceIds

▸ getExcludedDeviceIds(): string[]

Gets the device identifiers to exclude.

Returns: string[]

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

---

getRecording

▸ getRecording(): boolean

Gets whether to enable recording.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:205

---

getRecordingMode

▸ getRecordingMode(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:217

---

getRecordingTag

▸ getRecordingTag(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:229

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

getVideoMuted

▸ getVideoMuted(): boolean

Gets whether to mute or unmute video.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:241

---

getVideoUnmuteDisabled

▸ getVideoUnmuteDisabled(): boolean

Gets whether to disable video unmuting.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:253

---

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/ChannelUserConfig.ts:265

---

setAudioUnmuteDisabled

▸ setAudioUnmuteDisabled(value: boolean): void

Sets whether to disable audio unmuting.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:277

---

setExcludedClientIds

▸ setExcludedClientIds(value: string[]): void

Sets the client identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:289

---

setExcludedConnectionIds

▸ setExcludedConnectionIds(value: string[]): void

Sets the connection identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:301

---

setExcludedDeviceIds

▸ setExcludedDeviceIds(value: string[]): void

Sets the device identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:313

---

setRecording

▸ setRecording(value: boolean): void

Sets whether to enable recording.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:325

---

setRecordingMode

▸ setRecordingMode(value: string): void

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

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:337

---

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/ChannelUserConfig.ts:349

---

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/ChannelUserConfig.ts:361

---

setVideoUnmuteDisabled

▸ setVideoUnmuteDisabled(value: boolean): void

Sets whether to disable video unmuting.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:373

---

toJson

▸ toJson(): string

Serializes this channel user configuration to JSON.

Returns: string

The channel user configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:386

---

fromJson

▸ StaticfromJson(channelUserConfigJson: string): ChannelUserConfig

Deserializes a channel user configuration from JSON.

Parameters:

Name	Type	Description
channelUserConfigJson	string	The channel user configuration as JSON.

Returns: ChannelUserConfig

The channel user configuration.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:51

---

toJson

▸ StatictoJson(channelUserConfig: ChannelUserConfig): string

Serializes a channel user configuration to JSON.

Parameters:

Name	Type	Description
channelUserConfig	ChannelUserConfig	The channel user configuration.

Returns: string

The channel user configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserConfig.ts:102