fm.liveswitch.ChannelDeviceConfig Class Reference

Channel device configuration. More...

Public Member Functions

 ChannelDeviceConfig ()
 
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...
 
fm.liveswitch.NullableBoolean getRecording ()
 Gets whether to enable recording. More...
 
String getRecordingMode ()
 Gets the mode for the recording, if recording is being enabled. 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 setRecording (fm.liveswitch.NullableBoolean value)
 Sets whether to enable recording. More...
 
void setRecordingMode (String value)
 Sets the mode for the recording, if recording is being enabled. 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 device configuration to JSON. More...
 

Static Public Member Functions

static fm.liveswitch.ChannelDeviceConfig fromJson (String channelDeviceConfigJson)
 Deserializes a channel device configuration from JSON. More...
 
static String toJson (fm.liveswitch.ChannelDeviceConfig channelDeviceConfig)
 Serializes a channel device configuration to JSON. More...
 

Detailed Description

Channel device configuration.

Constructor & Destructor Documentation

◆ ChannelDeviceConfig()

fm.liveswitch.ChannelDeviceConfig.ChannelDeviceConfig ( )

Member Function Documentation

◆ fromJson()

static fm.liveswitch.ChannelDeviceConfig fm.liveswitch.ChannelDeviceConfig.fromJson ( String  channelDeviceConfigJson)
static

Deserializes a channel device configuration from JSON.

Parameters
channelDeviceConfigJsonThe channel device configuration as JSON.
Returns
The channel device configuration.

◆ getAudioMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelDeviceConfig.getAudioMuted ( )

Gets whether to mute or unmute audio.

◆ getAudioUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelDeviceConfig.getAudioUnmuteDisabled ( )

Gets whether to disable audio unmuting.

◆ getExcludedClientIds()

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

Gets the client identifiers to exclude.

◆ getExcludedConnectionIds()

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

Gets the connection identifiers to exclude.

◆ getRecording()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelDeviceConfig.getRecording ( )

Gets whether to enable recording.

◆ getRecordingMode()

String fm.liveswitch.ChannelDeviceConfig.getRecordingMode ( )

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

◆ getRecordingTag()

String fm.liveswitch.ChannelDeviceConfig.getRecordingTag ( )

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

◆ getVideoMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelDeviceConfig.getVideoMuted ( )

Gets whether to mute or unmute video.

◆ getVideoUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelDeviceConfig.getVideoUnmuteDisabled ( )

Gets whether to disable video unmuting.

◆ setAudioMuted()

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

Sets whether to mute or unmute audio.

◆ setAudioUnmuteDisabled()

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

Sets whether to disable audio unmuting.

◆ setExcludedClientIds()

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

Sets the client identifiers to exclude.

◆ setExcludedConnectionIds()

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

Sets the connection identifiers to exclude.

◆ setRecording()

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

Sets whether to enable recording.

◆ setRecordingMode()

void fm.liveswitch.ChannelDeviceConfig.setRecordingMode ( String  value)

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

◆ setRecordingTag()

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

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

◆ setVideoMuted()

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

Sets whether to mute or unmute video.

◆ setVideoUnmuteDisabled()

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

Sets whether to disable video unmuting.

◆ toJson() [1/2]

String fm.liveswitch.ChannelDeviceConfig.toJson ( )

Serializes this channel device configuration to JSON.

Returns
The channel device configuration as JSON.

◆ toJson() [2/2]

static String fm.liveswitch.ChannelDeviceConfig.toJson ( fm.liveswitch.ChannelDeviceConfig  channelDeviceConfig)
static

Serializes a channel device configuration to JSON.

Parameters
channelDeviceConfigThe channel device configuration.
Returns
The channel device configuration as JSON.