FMLiveSwitchMutedConfig Class Reference

Muted configuration. More...

Instance Methods

(FMLiveSwitchNullableBool *) - audioMuted
 Gets whether audio is muted. More...
 
(FMLiveSwitchNullableBool *) - audioUnmuteDisabled
 Gets whether audio unmute is disabled. More...
 
(NSMutableArray *) - excludedClientIds
 Gets the excluded client identifiers. More...
 
(NSMutableArray *) - excludedConnectionIds
 Gets the excluded connection identifiers. More...
 
(NSMutableArray *) - excludedDeviceIds
 Gets the excluded device identifiers. More...
 
(NSMutableArray *) - excludedUserIds
 Gets the excluded user identifiers. More...
 
(instancetype) - init
 
(void) - setAudioMuted:
 Sets whether audio is muted. More...
 
(void) - setAudioUnmuteDisabled:
 Sets whether audio unmute is disabled. More...
 
(void) - setExcludedClientIds:
 Sets the excluded client identifiers. More...
 
(void) - setExcludedConnectionIds:
 Sets the excluded connection identifiers. More...
 
(void) - setExcludedDeviceIds:
 Sets the excluded device identifiers. More...
 
(void) - setExcludedUserIds:
 Sets the excluded user identifiers. More...
 
(void) - setVideoMuted:
 Sets whether video is muted. More...
 
(void) - setVideoUnmuteDisabled:
 Sets whether video unmute is disabled. More...
 
(NSString *) - toJson
 Serializes this muted configuration to JSON. More...
 
(FMLiveSwitchNullableBool *) - videoMuted
 Gets whether video is muted. More...
 
(FMLiveSwitchNullableBool *) - videoUnmuteDisabled
 Gets whether video unmute is disabled. More...
 

Class Methods

(FMLiveSwitchMutedConfig *) + fromJsonWithMutedConfigJson:
 Deserializes a muted configuration from JSON. More...
 
(FMLiveSwitchMutedConfig *) + mutedConfig
 
(NSString *) + toJsonWithMutedConfig:
 Serializes a muted configuration to JSON. More...
 

Detailed Description

Muted configuration.

Method Documentation

◆ audioMuted

- (FMLiveSwitchNullableBool*) audioMuted

Gets whether audio is muted.

◆ audioUnmuteDisabled

- (FMLiveSwitchNullableBool*) audioUnmuteDisabled

Gets whether audio unmute is disabled.

◆ excludedClientIds

- (NSMutableArray*) excludedClientIds

Gets the excluded client identifiers.

◆ excludedConnectionIds

- (NSMutableArray*) excludedConnectionIds

Gets the excluded connection identifiers.

◆ excludedDeviceIds

- (NSMutableArray*) excludedDeviceIds

Gets the excluded device identifiers.

◆ excludedUserIds

- (NSMutableArray*) excludedUserIds

Gets the excluded user identifiers.

◆ fromJsonWithMutedConfigJson:

+ (FMLiveSwitchMutedConfig*) fromJsonWithMutedConfigJson: (NSString *)  mutedConfigJson

Deserializes a muted configuration from JSON.

Parameters
mutedConfigJsonThe muted configuration as JSON.
Returns
The muted configuration.

◆ init

- (instancetype) init

◆ mutedConfig

+ (FMLiveSwitchMutedConfig*) mutedConfig

◆ setAudioMuted:

- (void) setAudioMuted: (FMLiveSwitchNullableBool *)  value

Sets whether audio is muted.

◆ setAudioUnmuteDisabled:

- (void) setAudioUnmuteDisabled: (FMLiveSwitchNullableBool *)  value

Sets whether audio unmute is disabled.

◆ setExcludedClientIds:

- (void) setExcludedClientIds: (NSMutableArray *)  value

Sets the excluded client identifiers.

◆ setExcludedConnectionIds:

- (void) setExcludedConnectionIds: (NSMutableArray *)  value

Sets the excluded connection identifiers.

◆ setExcludedDeviceIds:

- (void) setExcludedDeviceIds: (NSMutableArray *)  value

Sets the excluded device identifiers.

◆ setExcludedUserIds:

- (void) setExcludedUserIds: (NSMutableArray *)  value

Sets the excluded user identifiers.

◆ setVideoMuted:

- (void) setVideoMuted: (FMLiveSwitchNullableBool *)  value

Sets whether video is muted.

◆ setVideoUnmuteDisabled:

- (void) setVideoUnmuteDisabled: (FMLiveSwitchNullableBool *)  value

Sets whether video unmute is disabled.

◆ toJson

- (NSString*) toJson

Serializes this muted configuration to JSON.

Returns
The muted configuration as JSON.

◆ toJsonWithMutedConfig:

+ (NSString*) toJsonWithMutedConfig: (FMLiveSwitchMutedConfig *)  mutedConfig

Serializes a muted configuration to JSON.

Parameters
mutedConfigThe muted configuration.
Returns
The muted configuration as JSON.

◆ videoMuted

- (FMLiveSwitchNullableBool*) videoMuted

Gets whether video is muted.

◆ videoUnmuteDisabled

- (FMLiveSwitchNullableBool*) videoUnmuteDisabled

Gets whether video unmute is disabled.