FMLiveSwitchChannelUserConfig Class Reference

Channel user configuration. More...

Instance Methods

(FMLiveSwitchNullableBool *) - audioMuted
 Gets whether to mute or unmute audio. More...
 
(FMLiveSwitchNullableBool *) - audioUnmuteDisabled
 Gets whether to disable audio unmuting. More...
 
(NSMutableArray *) - excludedClientIds
 Gets the client identifiers to exclude. More...
 
(NSMutableArray *) - excludedConnectionIds
 Gets the connection identifiers to exclude. More...
 
(NSMutableArray *) - excludedDeviceIds
 Gets the device identifiers to exclude. More...
 
(instancetype) - init
 
(FMLiveSwitchNullableBool *) - recording
 Gets whether to enable recording. More...
 
(NSString *) - recordingMode
 Gets the mode for the recording, if recording is being enabled. 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) - setExcludedClientIds:
 Sets the client identifiers to exclude. More...
 
(void) - setExcludedConnectionIds:
 Sets the connection identifiers to exclude. More...
 
(void) - setExcludedDeviceIds:
 Sets the device identifiers to exclude. More...
 
(void) - setRecording:
 Sets whether to enable recording. More...
 
(void) - setRecordingMode:
 Sets the mode for the recording, if recording is being enabled. 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 user 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

(FMLiveSwitchChannelUserConfig *) + channelUserConfig
 
(FMLiveSwitchChannelUserConfig *) + fromJsonWithChannelUserConfigJson:
 Deserializes a channel user configuration from JSON. More...
 
(NSString *) + toJsonWithChannelUserConfig:
 Serializes a channel user configuration to JSON. More...
 

Detailed Description

Channel user configuration.

Method Documentation

◆ audioMuted

- (FMLiveSwitchNullableBool*) audioMuted

Gets whether to mute or unmute audio.

◆ audioUnmuteDisabled

- (FMLiveSwitchNullableBool*) audioUnmuteDisabled

Gets whether to disable audio unmuting.

◆ channelUserConfig

+ (FMLiveSwitchChannelUserConfig*) channelUserConfig

◆ excludedClientIds

- (NSMutableArray*) excludedClientIds

Gets the client identifiers to exclude.

◆ excludedConnectionIds

- (NSMutableArray*) excludedConnectionIds

Gets the connection identifiers to exclude.

◆ excludedDeviceIds

- (NSMutableArray*) excludedDeviceIds

Gets the device identifiers to exclude.

◆ fromJsonWithChannelUserConfigJson:

+ (FMLiveSwitchChannelUserConfig*) fromJsonWithChannelUserConfigJson: (NSString *)  channelUserConfigJson

Deserializes a channel user configuration from JSON.

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

◆ init

- (instancetype) init

◆ recording

- (FMLiveSwitchNullableBool*) recording

Gets whether to enable recording.

◆ recordingMode

- (NSString*) recordingMode

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

◆ 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.

◆ setExcludedClientIds:

- (void) setExcludedClientIds: (NSMutableArray *)  value

Sets the client identifiers to exclude.

◆ setExcludedConnectionIds:

- (void) setExcludedConnectionIds: (NSMutableArray *)  value

Sets the connection identifiers to exclude.

◆ setExcludedDeviceIds:

- (void) setExcludedDeviceIds: (NSMutableArray *)  value

Sets the device identifiers to exclude.

◆ setRecording:

- (void) setRecording: (FMLiveSwitchNullableBool *)  value

Sets whether to enable recording.

◆ setRecordingMode:

- (void) setRecordingMode: (NSString *)  value

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

◆ 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 user configuration to JSON.

Returns
The channel user configuration as JSON.

◆ toJsonWithChannelUserConfig:

+ (NSString*) toJsonWithChannelUserConfig: (FMLiveSwitchChannelUserConfig *)  channelUserConfig

Serializes a channel user configuration to JSON.

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

◆ videoMuted

- (FMLiveSwitchNullableBool*) videoMuted

Gets whether to mute or unmute video.

◆ videoUnmuteDisabled

- (FMLiveSwitchNullableBool*) videoUnmuteDisabled

Gets whether to disable video unmuting.