FMLiveSwitchChannelConfig Class Reference

Channel configuration. More...

Instance Methods

(FMLiveSwitchNullableBool *) - audioMuted
 Gets whether to mute or unmute audio. More...
 
(FMLiveSwitchNullableBool *) - audioUnmuteDisabled
 Gets whether to disable audio unmuting. More...
 
(FMLiveSwitchNullableBool *) - enableRtmp
 Gets whether to enable rtmp. 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...
 
(NSMutableArray *) - excludedUserIds
 Gets the user 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) - setEnableRtmp:
 Sets whether to enable rtmp. 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) - setExcludedUserIds:
 Sets the user 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 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

(FMLiveSwitchChannelConfig *) + channelConfig
 
(FMLiveSwitchChannelConfig *) + fromJsonWithChannelConfigJson:
 Deserializes a channel configuration from JSON. More...
 
(NSString *) + toJsonWithChannelConfig:
 Serializes a channel configuration to JSON. More...
 

Detailed Description

Channel configuration.

Method Documentation

◆ audioMuted

- (FMLiveSwitchNullableBool*) audioMuted

Gets whether to mute or unmute audio.

◆ audioUnmuteDisabled

- (FMLiveSwitchNullableBool*) audioUnmuteDisabled

Gets whether to disable audio unmuting.

◆ channelConfig

+ (FMLiveSwitchChannelConfig*) channelConfig

◆ enableRtmp

- (FMLiveSwitchNullableBool*) enableRtmp

Gets whether to enable rtmp.

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

◆ excludedUserIds

- (NSMutableArray*) excludedUserIds

Gets the user identifiers to exclude.

◆ fromJsonWithChannelConfigJson:

+ (FMLiveSwitchChannelConfig*) fromJsonWithChannelConfigJson: (NSString *)  channelConfigJson

Deserializes a channel configuration from JSON.

Parameters
channelConfigJsonThe channel configuration as JSON.
Returns
The channel 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.

◆ setEnableRtmp:

- (void) setEnableRtmp: (FMLiveSwitchNullableBool *)  value

Sets whether to enable rtmp.

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

◆ setExcludedUserIds:

- (void) setExcludedUserIds: (NSMutableArray *)  value

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

Returns
The channel configuration as JSON.

◆ toJsonWithChannelConfig:

+ (NSString*) toJsonWithChannelConfig: (FMLiveSwitchChannelConfig *)  channelConfig

Serializes a channel configuration to JSON.

Parameters
channelConfigThe channel configuration.
Returns
The channel configuration as JSON.

◆ videoMuted

- (FMLiveSwitchNullableBool*) videoMuted

Gets whether to mute or unmute video.

◆ videoUnmuteDisabled

- (FMLiveSwitchNullableBool*) videoUnmuteDisabled

Gets whether to disable video unmuting.