fm.liveswitch.ChannelUserConfig Class Reference

Channel user configuration. More...

Public Member Functions

 ChannelUserConfig ()
 
fm.liveswitch.NullableBoolean getAudioMuted ()
 Gets whether to mute or unmute audio. More...
 
fm.liveswitch.NullableBoolean getAudioUnmuteDisabled ()
 Gets whether to disable audio unmuting. More...
 
String[] getExcludedClientIds ()
 Gets the client identifiers to exclude. More...
 
String[] getExcludedConnectionIds ()
 Gets the connection identifiers to exclude. More...
 
String[] getExcludedDeviceIds ()
 Gets the device identifiers to exclude. More...
 
fm.liveswitch.NullableBoolean getRecording ()
 Gets whether to enable recording. More...
 
String getRecordingTag ()
 Gets the tag for the recording, if recording is being enabled. More...
 
fm.liveswitch.NullableBoolean getVideoMuted ()
 Gets whether to mute or unmute video. More...
 
fm.liveswitch.NullableBoolean getVideoUnmuteDisabled ()
 Gets whether to disable video unmuting. More...
 
void setAudioMuted (fm.liveswitch.NullableBoolean value)
 Sets whether to mute or unmute audio. More...
 
void setAudioUnmuteDisabled (fm.liveswitch.NullableBoolean value)
 Sets whether to disable audio unmuting. More...
 
void setExcludedClientIds (String[] value)
 Sets the client identifiers to exclude. More...
 
void setExcludedConnectionIds (String[] value)
 Sets the connection identifiers to exclude. More...
 
void setExcludedDeviceIds (String[] value)
 Sets the device identifiers to exclude. More...
 
void setRecording (fm.liveswitch.NullableBoolean value)
 Sets whether to enable recording. More...
 
void setRecordingTag (String value)
 Sets the tag for the recording, if recording is being enabled. More...
 
void setVideoMuted (fm.liveswitch.NullableBoolean value)
 Sets whether to mute or unmute video. More...
 
void setVideoUnmuteDisabled (fm.liveswitch.NullableBoolean value)
 Sets whether to disable video unmuting. More...
 
String toJson ()
 Serializes this channel user configuration to JSON. More...
 

Static Public Member Functions

static fm.liveswitch.ChannelUserConfig fromJson (String channelUserConfigJson)
 Deserializes a channel user configuration from JSON. More...
 
static String toJson (fm.liveswitch.ChannelUserConfig channelUserConfig)
 Serializes a channel user configuration to JSON. More...
 

Detailed Description

Channel user configuration.

Constructor & Destructor Documentation

◆ ChannelUserConfig()

fm.liveswitch.ChannelUserConfig.ChannelUserConfig ( )

Member Function Documentation

◆ fromJson()

static fm.liveswitch.ChannelUserConfig fm.liveswitch.ChannelUserConfig.fromJson ( String  channelUserConfigJson)
static

Deserializes a channel user configuration from JSON.

Parameters
channelUserConfigJsonThe channel user configuration as JSON.
Returns
The channel user configuration.

◆ getAudioMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelUserConfig.getAudioMuted ( )

Gets whether to mute or unmute audio.

◆ getAudioUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelUserConfig.getAudioUnmuteDisabled ( )

Gets whether to disable audio unmuting.

◆ getExcludedClientIds()

String [] fm.liveswitch.ChannelUserConfig.getExcludedClientIds ( )

Gets the client identifiers to exclude.

◆ getExcludedConnectionIds()

String [] fm.liveswitch.ChannelUserConfig.getExcludedConnectionIds ( )

Gets the connection identifiers to exclude.

◆ getExcludedDeviceIds()

String [] fm.liveswitch.ChannelUserConfig.getExcludedDeviceIds ( )

Gets the device identifiers to exclude.

◆ getRecording()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelUserConfig.getRecording ( )

Gets whether to enable recording.

◆ getRecordingTag()

String fm.liveswitch.ChannelUserConfig.getRecordingTag ( )

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

◆ getVideoMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelUserConfig.getVideoMuted ( )

Gets whether to mute or unmute video.

◆ getVideoUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelUserConfig.getVideoUnmuteDisabled ( )

Gets whether to disable video unmuting.

◆ setAudioMuted()

void fm.liveswitch.ChannelUserConfig.setAudioMuted ( fm.liveswitch.NullableBoolean  value)

Sets whether to mute or unmute audio.

◆ setAudioUnmuteDisabled()

void fm.liveswitch.ChannelUserConfig.setAudioUnmuteDisabled ( fm.liveswitch.NullableBoolean  value)

Sets whether to disable audio unmuting.

◆ setExcludedClientIds()

void fm.liveswitch.ChannelUserConfig.setExcludedClientIds ( String[]  value)

Sets the client identifiers to exclude.

◆ setExcludedConnectionIds()

void fm.liveswitch.ChannelUserConfig.setExcludedConnectionIds ( String[]  value)

Sets the connection identifiers to exclude.

◆ setExcludedDeviceIds()

void fm.liveswitch.ChannelUserConfig.setExcludedDeviceIds ( String[]  value)

Sets the device identifiers to exclude.

◆ setRecording()

void fm.liveswitch.ChannelUserConfig.setRecording ( fm.liveswitch.NullableBoolean  value)

Sets whether to enable recording.

◆ setRecordingTag()

void fm.liveswitch.ChannelUserConfig.setRecordingTag ( String  value)

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

◆ setVideoMuted()

void fm.liveswitch.ChannelUserConfig.setVideoMuted ( fm.liveswitch.NullableBoolean  value)

Sets whether to mute or unmute video.

◆ setVideoUnmuteDisabled()

void fm.liveswitch.ChannelUserConfig.setVideoUnmuteDisabled ( fm.liveswitch.NullableBoolean  value)

Sets whether to disable video unmuting.

◆ toJson() [1/2]

String fm.liveswitch.ChannelUserConfig.toJson ( )

Serializes this channel user configuration to JSON.

Returns
The channel user configuration as JSON.

◆ toJson() [2/2]

static String fm.liveswitch.ChannelUserConfig.toJson ( fm.liveswitch.ChannelUserConfig  channelUserConfig)
static

Serializes a channel user configuration to JSON.

Parameters
channelUserConfigThe channel user configuration.
Returns
The channel user configuration as JSON.