/ fm / liveswitch / ChannelClientConfig
Class: ChannelClientConfig
fm.liveswitch.ChannelClientConfig
Channel client configuration.
Table of contents
Constructors
Methods
- getAudioMuted
- getAudioUnmuteDisabled
- getExcludedConnectionIds
- getRecording
- getRecordingTag
- getTypeString
- getVideoMuted
- getVideoUnmuteDisabled
- setAudioMuted
- setAudioUnmuteDisabled
- setExcludedConnectionIds
- setRecording
- setRecordingTag
- setVideoMuted
- setVideoUnmuteDisabled
- toJson
- fromJson
- toJson
Constructors
constructor
+ new ChannelClientConfig(): ChannelClientConfig
Returns: ChannelClientConfig
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:25
Methods
getAudioMuted
▸ getAudioMuted(): boolean
Gets whether to mute or unmute audio.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:121
getAudioUnmuteDisabled
▸ getAudioUnmuteDisabled(): boolean
Gets whether to disable audio unmuting.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:133
getExcludedConnectionIds
▸ getExcludedConnectionIds(): string[]
Gets the connection identifiers to exclude.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:145
getRecording
▸ getRecording(): boolean
Gets whether to enable recording.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:157
getRecordingTag
▸ getRecordingTag(): string
Gets the tag for the recording, if recording is being enabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:169
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:9
getVideoMuted
▸ getVideoMuted(): boolean
Gets whether to mute or unmute video.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:181
getVideoUnmuteDisabled
▸ getVideoUnmuteDisabled(): boolean
Gets whether to disable video unmuting.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:193
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/ChannelClientConfig.ts:205
setAudioUnmuteDisabled
▸ setAudioUnmuteDisabled(value
: boolean): void
Sets whether to disable audio unmuting.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:217
setExcludedConnectionIds
▸ setExcludedConnectionIds(value
: string[]): void
Sets the connection identifiers to exclude.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:229
setRecording
▸ setRecording(value
: boolean): void
Sets whether to enable recording.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:241
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/ChannelClientConfig.ts:253
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/ChannelClientConfig.ts:265
setVideoUnmuteDisabled
▸ setVideoUnmuteDisabled(value
: boolean): void
Sets whether to disable video unmuting.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:277
toJson
▸ toJson(): string
Serializes this channel client configuration to JSON.
Returns: string
The channel client configuration as JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:290
fromJson
▸ Static
fromJson(channelClientConfigJson
: string): ChannelClientConfig
Deserializes a channel client configuration from JSON.
Parameters:
Name | Type | Description |
---|---|---|
channelClientConfigJson |
string | The channel client configuration as JSON. |
Returns: ChannelClientConfig
The channel client configuration.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:45
toJson
▸ Static
toJson(channelClientConfig
: ChannelClientConfig): string
Serializes a channel client configuration to JSON.
Parameters:
Name | Type | Description |
---|---|---|
channelClientConfig |
ChannelClientConfig | The channel client configuration. |
Returns: string
The channel client configuration as JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelClientConfig.ts:87