/ fm / liveswitch / ChannelConfig
Class: ChannelConfig
fm.liveswitch.ChannelConfig
Channel configuration.
Table of contents
Constructors
Methods
- getAudioMuted
- getAudioUnmuteDisabled
- getEnableRtmp
- getExcludedClientIds
- getExcludedConnectionIds
- getExcludedDeviceIds
- getExcludedUserIds
- getRecording
- getRecordingTag
- getTypeString
- getVideoMuted
- getVideoUnmuteDisabled
- setAudioMuted
- setAudioUnmuteDisabled
- setEnableRtmp
- setExcludedClientIds
- setExcludedConnectionIds
- setExcludedDeviceIds
- setExcludedUserIds
- setRecording
- setRecordingTag
- setVideoMuted
- setVideoUnmuteDisabled
- toJson
- fromJson
- toJson
Constructors
constructor
+ new ChannelConfig(): ChannelConfig
Returns: ChannelConfig
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:33
Methods
getAudioMuted
▸ getAudioMuted(): boolean
Gets whether to mute or unmute audio.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:153
getAudioUnmuteDisabled
▸ getAudioUnmuteDisabled(): boolean
Gets whether to disable audio unmuting.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:165
getEnableRtmp
▸ getEnableRtmp(): boolean
Gets whether to enable rtmp.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:177
getExcludedClientIds
▸ getExcludedClientIds(): string[]
Gets the client identifiers to exclude.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:189
getExcludedConnectionIds
▸ getExcludedConnectionIds(): string[]
Gets the connection identifiers to exclude.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:201
getExcludedDeviceIds
▸ getExcludedDeviceIds(): string[]
Gets the device identifiers to exclude.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:213
getExcludedUserIds
▸ getExcludedUserIds(): string[]
Gets the user identifiers to exclude.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:225
getRecording
▸ getRecording(): boolean
Gets whether to enable recording.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:237
getRecordingTag
▸ getRecordingTag(): string
Gets the tag for the recording, if recording is being enabled.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:249
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:9
getVideoMuted
▸ getVideoMuted(): boolean
Gets whether to mute or unmute video.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:261
getVideoUnmuteDisabled
▸ getVideoUnmuteDisabled(): boolean
Gets whether to disable video unmuting.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:273
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/ChannelConfig.ts:285
setAudioUnmuteDisabled
▸ setAudioUnmuteDisabled(value
: boolean): void
Sets whether to disable audio unmuting.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:297
setEnableRtmp
▸ setEnableRtmp(value
: boolean): void
Sets whether to enable rtmp.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:309
setExcludedClientIds
▸ setExcludedClientIds(value
: string[]): void
Sets the client identifiers to exclude.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:321
setExcludedConnectionIds
▸ setExcludedConnectionIds(value
: string[]): void
Sets the connection identifiers to exclude.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:333
setExcludedDeviceIds
▸ setExcludedDeviceIds(value
: string[]): void
Sets the device identifiers to exclude.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:345
setExcludedUserIds
▸ setExcludedUserIds(value
: string[]): void
Sets the user identifiers to exclude.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:357
setRecording
▸ setRecording(value
: boolean): void
Sets whether to enable recording.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:369
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/ChannelConfig.ts:381
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/ChannelConfig.ts:393
setVideoUnmuteDisabled
▸ setVideoUnmuteDisabled(value
: boolean): void
Sets whether to disable video unmuting.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:405
toJson
▸ toJson(): string
Serializes this channel configuration to JSON.
Returns: string
The channel configuration as JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:418
fromJson
▸ Static
fromJson(channelConfigJson
: string): ChannelConfig
Deserializes a channel configuration from JSON.
Parameters:
Name | Type | Description |
---|---|---|
channelConfigJson |
string | The channel configuration as JSON. |
Returns: ChannelConfig
The channel configuration.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:53
toJson
▸ Static
toJson(channelConfig
: ChannelConfig): string
Serializes a channel configuration to JSON.
Parameters:
Name | Type | Description |
---|---|---|
channelConfig |
ChannelConfig | The channel configuration. |
Returns: string
The channel configuration as JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:107