Hard Muting: iOS SDK – Video API

Table of Contents

Hard Mute / Unmute Room

The EnxRoom.muteAllUser() method allows the Moderator to hard-mute the Room where all the participants are muted. A new participant joining a Room in a hard-mute state would also be muted by default. The right to unmute a hard-mute Room lies only with the Moderator and participants cannot unmute their Local Streams either. The EnxRoom.unMuteAllUser() method is used to put the Room off a hard-mute state.

Class: EnxRoom

Methods:

  • - (void)muteAllUser; – No Parameter required.
  • - (void)unMuteAllUser; – No Parameter required.

Delegate Methods:

  • – didHardMutedAll: – Notification to all the participants in the Room when Room is hard-muted.
  • – didHardUnMuteAllUser: – Notification to all the participants in the Room when Room is put off hard- mute state.
  • – didMutedAllUser:– Acknowledgment to the Moderator when Room is hard-muted.
  • – didUnMutedAllUser: – Acknowledgment to the Moderator when Room is put off hard-mute state.
[room muteAllUser]; // To hard-mute Room
[room unMuteAllUser]; // To hard-unmute Room

- (void) didMutedAllUser:(NSArray *Data){
 // You hard-muted Room
}

- (void) didUnMutedAllUser:(NSArray *Data){
 // You hard-unuted Room
}

- (void)didHardMutedAll:(NSArray *Data){
 // Room is hard-muted - to all
} 

- (void)didHardUnMuteAllUser:(NSArray *Data){
 // Room is hard-unmuted - to all
}

Error Codes / Exceptions

CodeDescription
5001Unauthorized Access. When a user with a participant role invokes muteAllUser().
5002Unauthorized Access. When a user with a participant role invokes unMuteAllUser().
5037Repeated muteAllUser() request while the previous request is in process.
5038Invalid muteAllUser() request While the Room is already in a hard-mute state.
5039Invalid unMuteAllUser() request while the Room is NOT in a hard-mute state.
5040Repeated unMuteAllUser() request while the previous request is in process.

Hard Mute / Unmute Participant

The EnxStream.hardMuteAudio() and EnxStream.hardMuteVideo() methods allow the Moderator to hard-mute a Participant’s Audio and Video Streams respectively. The affected Participant cannot unmute their Audio or Video Streams. The Moderator can unmute the Participant’s Audio or Video Streams using EnxStream.hardUnMuteAudio() and EnxStream.hardUnMuteVideo() methods respectively.

Note: For iOS SDK v2.1.3+, refer to the section below for more details.

Class: EnxStream

Methods:

  • - (void)hardMuteAudio:(NSString *)clientId
  • - (void)hardMuteVideo:(NSString *)clientId
  • - (void)hardUnMuteAudio:(NSString *)clientId
  • - (void)hardUnMuteVideo:(NSString *)clientId

Parameters:

clientId – The user whose audio/video needs to be hard muted/unmuted.

Delegate Methods:

  • - didReceiveHardMutedAudio – Notification to the affected participant when their Audio is hard-muted.
  • - didReceiveHardUnmutedAudio – Notification to the affected participant when their Audio is lifted off the hard-mute state.
  • - didReceiveHardMutedVideo – Notification to the affected participant when their Video is hard-muted.
  • - didReceiveHardUnmutedVideo – Notification to the affected participant when their Video is lifted off the hard-mute state.
  • - didHardMuteAudio – Acknowledgment to the Moderator when a user’s Audio is hard-muted.
  • - didHardUnMuteAudio – Acknowledgment to the Moderator when a user’s Audio is lifted off the hard-mute state.
  • – didHardMuteVideo – Acknowledgment to the Moderator when a user’s Video is hard-muted.
  • - didHardUnMuteVideo – Acknowledgment to the Moderator when a user’s Video is lifted off the hard-mute state.
[stream hardMuteAudio:@”clientId”];	// To hard-mute user's audio

-(void)didReceiveHardMutedAudio:(NSArray *)Data{
	// Your audio is hard-muted
}
-(void)didHardMuteAudio:(NSArray *)Data{
	// You hard-muted the user's audio
}

[stream hardUnMuteAudio:@”clientId”];	//To hard un-mute user's audio
-(void)didReceivedHardUnmutedAudio:(NSArray *)Data{
	// Your audio is hard-unmuted
}

-(void)didHardUnMuteAudio:(NSArray *)Data{
	// You hard-unmuted user's audio
}

// Video Hard-Mute/Hard-Unmute will be used in the same way as Audio.

Error Codes / Exceptions

CodeDescription
5009Unauthorized Access. When a user with a participant role invokes hardMuteAudio().
5010Unauthorized Access. When a user with a participant role invokes hardUnMuteAudio().
5011Unauthorized Access. When a user with a participant role invokes hardMuteVideo().
5012Unauthorized Access. When a user with a participant role invokes hardUnMuteVideo().

Hard Mute / Unmute Participant

Availability: iOS SDK v2.1.3+

The EnxRoom.hardMuteUserAudio() and EnxRoom.hardMuteUserVideo() methods allow the Moderator to hard-mute a Participant’s Audio and Video Streams respectively. The affected Participant cannot unmute their Audio or Video Streams. The Moderator can unmute the Participant’s Audio or Video Streams using EnxRoom.hardUnMuteUserAudio() and EnxRoom.hardUnMuteUserVideo() methods respectively.

Class: EnxRoom

Methods:

  • -(void)hardMuteUserAudio:(NSString*_Nonnull)clientId
  • -(void)hardMuteUserVideo(NSString*_Nonnull)clientId
  • -(void)hardUnmuteUserAudio:(NSString*_Nonnull)clientId
  • -(void)hardUnmuteUserVideo:(NSString*_Nonnull)clientId

Parameters:

clientId – The user whose audio/video needs to be hard muted/unmuted.

Delegate Methods:

  • - didReceiveHardMutedAudio – Notification to the affected participant when their Audio is hard-muted.
  • - didReceiveHardUnmutedAudio – Notification to the affected participant when their Audio is lifted off the hard-mute state.
  • - didReceiveHardMutedVideo – Notification to the affected participant when their Video is hard-muted.
  • - didReceiveHardUnmutedVideo – Notification to the affected participant when their Video is lifted off the hard-mute state.
  • - didAckHardMuteUserAudio – Acknowledgment to the Moderator when a user’s Audio is hard-muted.
  • - didAckHardunMuteUserAudio – Acknowledgment to the Moderator when a user’s Audio is lifted off the hard-mute state.
  • – didAckHardMuteUserVideo – Acknowledgment to the Moderator when a user’s Video is hard-muted.
  • - didAckHardUnMuteUserVideo – Acknowledgment to the Moderator when a user’s Video is lifted off the hard-mute state.
[enxRoom hardMuteUserAudio:”clientID”]; 	// To hard-mute user's audio

-(void)didReceiveHardMutedAudio:(NSArray *)Data{
	// Your audio is hard-muted
}

-(void)didHardMuteAudio:(NSArray *)Data{
	// You hard-muted the user's audio
}

[enxRoom hardUnmuteUserAudio:”clientID”];	//To hard un-mute user's audio

-(void)didReceivedHardUnmutedAudio:(NSArray *)Data{
	// Your audio is hard-unmuted

-(void)didHardUnMuteUserAudio:(NSArray *)Data{
	// You hard-unmuted user's audio
}

// Video Hard-Mute/Hard-Unmute will be used in the same way as Audio.

← Record Session

Index

Lock / Unlock Room →