FMLiveSwitchChannelClientConfig Class Reference

Channel client configuration. More...

Instance Methods

(FMLiveSwitchNullableBool *) - audioMuted
 Gets whether to mute or unmute audio. More...
 
(FMLiveSwitchNullableBool *) - audioUnmuteDisabled
 Gets whether to disable audio unmuting. More...
 
(NSMutableArray *) - excludedConnectionIds
 Gets the connection identifiers to exclude. More...
 
(instancetype) - init
 
(FMLiveSwitchNullableBool *) - recording
 Gets whether to enable recording. More...
 
(NSString *) - recordingTag
 Gets the tag for the recording, if recording is being enabled. More...
 
(void) - setAudioMuted:
 Sets whether to mute or unmute audio. More...
 
(void) - setAudioUnmuteDisabled:
 Sets whether to disable audio unmuting. More...
 
(void) - setExcludedConnectionIds:
 Sets the connection identifiers to exclude. More...
 
(void) - setRecording:
 Sets whether to enable recording. More...
 
(void) - setRecordingTag:
 Sets the tag for the recording, if recording is being enabled. More...
 
(void) - setVideoMuted:
 Sets whether to mute or unmute video. More...
 
(void) - setVideoUnmuteDisabled:
 Sets whether to disable video unmuting. More...
 
(NSString *) - toJson
 Serializes this channel client configuration to JSON. More...
 
(FMLiveSwitchNullableBool *) - videoMuted
 Gets whether to mute or unmute video. More...
 
(FMLiveSwitchNullableBool *) - videoUnmuteDisabled
 Gets whether to disable video unmuting. More...
 

Class Methods

(FMLiveSwitchChannelClientConfig *) + channelClientConfig
 
(FMLiveSwitchChannelClientConfig *) + fromJsonWithChannelClientConfigJson:
 Deserializes a channel client configuration from JSON. More...
 
(NSString *) + toJsonWithChannelClientConfig:
 Serializes a channel client configuration to JSON. More...
 

Detailed Description

Channel client configuration.

Method Documentation

◆ audioMuted

- (FMLiveSwitchNullableBool*) audioMuted

Gets whether to mute or unmute audio.

◆ audioUnmuteDisabled

- (FMLiveSwitchNullableBool*) audioUnmuteDisabled

Gets whether to disable audio unmuting.

◆ channelClientConfig

+ (FMLiveSwitchChannelClientConfig*) channelClientConfig

◆ excludedConnectionIds

- (NSMutableArray*) excludedConnectionIds

Gets the connection identifiers to exclude.

◆ fromJsonWithChannelClientConfigJson:

+ (FMLiveSwitchChannelClientConfig*) fromJsonWithChannelClientConfigJson: (NSString *)  channelClientConfigJson

Deserializes a channel client configuration from JSON.

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

◆ init

- (instancetype) init

◆ recording

- (FMLiveSwitchNullableBool*) recording

Gets whether to enable recording.

◆ recordingTag

- (NSString*) recordingTag

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

◆ setAudioMuted:

- (void) setAudioMuted: (FMLiveSwitchNullableBool *)  value

Sets whether to mute or unmute audio.

◆ setAudioUnmuteDisabled:

- (void) setAudioUnmuteDisabled: (FMLiveSwitchNullableBool *)  value

Sets whether to disable audio unmuting.

◆ setExcludedConnectionIds:

- (void) setExcludedConnectionIds: (NSMutableArray *)  value

Sets the connection identifiers to exclude.

◆ setRecording:

- (void) setRecording: (FMLiveSwitchNullableBool *)  value

Sets whether to enable recording.

◆ setRecordingTag:

- (void) setRecordingTag: (NSString *)  value

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

◆ setVideoMuted:

- (void) setVideoMuted: (FMLiveSwitchNullableBool *)  value

Sets whether to mute or unmute video.

◆ setVideoUnmuteDisabled:

- (void) setVideoUnmuteDisabled: (FMLiveSwitchNullableBool *)  value

Sets whether to disable video unmuting.

◆ toJson

- (NSString*) toJson

Serializes this channel client configuration to JSON.

Returns
The channel client configuration as JSON.

◆ toJsonWithChannelClientConfig:

+ (NSString*) toJsonWithChannelClientConfig: (FMLiveSwitchChannelClientConfig *)  channelClientConfig

Serializes a channel client configuration to JSON.

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

◆ videoMuted

- (FMLiveSwitchNullableBool*) videoMuted

Gets whether to mute or unmute video.

◆ videoUnmuteDisabled

- (FMLiveSwitchNullableBool*) videoUnmuteDisabled

Gets whether to disable video unmuting.