Remote Mute

You can use hmsSdk.changeTrackState to make a remote mute/unmute request.

To mute a track:

Get the audio or video track of the peer whom you want to mute and pass it as the first parameter to hmsSdk.changeTrackState.

The second parameter is a boolean for muting. If true, the track will be muted. If false the track will be requested to un-mute.

Finally you can pass a completion handler to check whether changeTrackState succeeded or failed as the third parameter.

Handling a mute callback

Muting is automatically applied to the receiver tracks. No action is required.

Handling an un-mute callback

Unmute callbacks are received in the target peer's on(changeTrackStateRequest:) callback of HMSUpdateListener.

The target peer will receive an object of HMSChangeTrackStateRequest.

Here's its structure.

class HMSChangeTrackStateRequest {
    public let track: HMSTrack
    public let mute: Bool
    public let requestedBy: HMSPeer
}

With the information here, show a dialog to the user to ask if they want to accept the change and then apply the settings locally. The same as in a regular user Mute/Unmute.

You can call toggleAudio and toggleVideo to mute/unmute remote participant. Please note that you can't let just anyone mute others. First you need to create a role with the permissions to mute other participants and unmute other participants. Please note that they are two separate permissions, one for muting others and one to be able to unmute others. Also, while mute request will succeed directly, an unmute request will be send to remote peer. You can check if you have received an unmute request by checking changeTrackStateRequests property on Room Model instance.

Example: Teacher wants to mute a student named 'Pawan''s audio (which is currently unmuted)

guard let studentPeerModel = (roomModel.peerModels.first{$0.name == "Pawan"}) else { return }
try await studentPeerModel.toggleAudio()

Example: Teacher wants to request student named 'Pawan' to unmute their video (which is currently muted)

// Teacher's side - Toggle student peer model's video
guard let studentPeerModel = (roomModel.peerModels.first{$0.name == "Pawan"}) else { return }
try await studentPeerModel.toggleVideo()

...

// Student's side - Observe changeTrackStateRequests and unmute requested tracks

VStack {
  ...
}
.onChange(of: roomModel.changeTrackStateRequests) { changeTrackStateRequests in
                
    changeTrackStateRequests.forEach { request in
        if let trackModel = roomModel.localPeerModel?.trackModels.first(where: {$0.track == request.track}) {
            if trackModel.isMute {
                Task {
                    try await trackModel.toggleMute()
                }
            }
        }
    }
    
    roomModel.changeTrackStateRequests.removeAll()
}