fm.liveswitch.ChannelClientConfig Class Reference

Channel client configuration. More...

Public Member Functions

 ChannelClientConfig ()
 
fm.liveswitch.NullableBoolean getAudioMuted ()
 Gets whether to mute or unmute audio. More...
 
fm.liveswitch.NullableBoolean getAudioUnmuteDisabled ()
 Gets whether to disable audio unmuting. More...
 
String[] getExcludedConnectionIds ()
 Gets the connection 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 setExcludedConnectionIds (String[] value)
 Sets the connection 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 client configuration to JSON. More...
 

Static Public Member Functions

static fm.liveswitch.ChannelClientConfig fromJson (String channelClientConfigJson)
 Deserializes a channel client configuration from JSON. More...
 
static String toJson (fm.liveswitch.ChannelClientConfig channelClientConfig)
 Serializes a channel client configuration to JSON. More...
 

Detailed Description

Channel client configuration.

Constructor & Destructor Documentation

◆ ChannelClientConfig()

fm.liveswitch.ChannelClientConfig.ChannelClientConfig ( )

Member Function Documentation

◆ fromJson()

static fm.liveswitch.ChannelClientConfig fm.liveswitch.ChannelClientConfig.fromJson ( String  channelClientConfigJson)
static

Deserializes a channel client configuration from JSON.

Parameters
channelClientConfigJsonThe channel client configuration as JSON.
Returns
The channel client configuration.

◆ getAudioMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelClientConfig.getAudioMuted ( )

Gets whether to mute or unmute audio.

◆ getAudioUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelClientConfig.getAudioUnmuteDisabled ( )

Gets whether to disable audio unmuting.

◆ getExcludedConnectionIds()

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

Gets the connection identifiers to exclude.

◆ getRecording()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelClientConfig.getRecording ( )

Gets whether to enable recording.

◆ getRecordingTag()

String fm.liveswitch.ChannelClientConfig.getRecordingTag ( )

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

◆ getVideoMuted()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelClientConfig.getVideoMuted ( )

Gets whether to mute or unmute video.

◆ getVideoUnmuteDisabled()

fm.liveswitch.NullableBoolean fm.liveswitch.ChannelClientConfig.getVideoUnmuteDisabled ( )

Gets whether to disable video unmuting.

◆ setAudioMuted()

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

Sets whether to mute or unmute audio.

◆ setAudioUnmuteDisabled()

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

Sets whether to disable audio unmuting.

◆ setExcludedConnectionIds()

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

Sets the connection identifiers to exclude.

◆ setRecording()

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

Sets whether to enable recording.

◆ setRecordingTag()

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

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

◆ setVideoMuted()

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

Sets whether to mute or unmute video.

◆ setVideoUnmuteDisabled()

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

Sets whether to disable video unmuting.

◆ toJson() [1/2]

String fm.liveswitch.ChannelClientConfig.toJson ( )

Serializes this channel client configuration to JSON.

Returns
The channel client configuration as JSON.

◆ toJson() [2/2]

static String fm.liveswitch.ChannelClientConfig.toJson ( fm.liveswitch.ChannelClientConfig  channelClientConfig)
static

Serializes a channel client configuration to JSON.

Parameters
channelClientConfigThe channel client configuration.
Returns
The channel client configuration as JSON.