audioMute

audioMute(params?): Promise<void>

Puts the microphone on mute. The other participants will not hear audio from the muted participant anymore. You can use this method to mute either yourself or another participant in the room.

Parameters

params

object

Object containing the parameters of the method.

memberId

string

Id of the member to mute. If omitted, mutes the default device in the local client.

Returns

Promise<void>

Permissions

room.self.audio_mute: to mute a local device.
room.member.audio_mute: to mute a remote member.

You need to specify the permissions when creating the Video Room Token on the server side.

Examples

Muting your own microphone:

1 await roomSession.audioMute();

Muting the microphone of another participant:

1 const id = "de550c0c-3fac-4efd-b06f-b5b8614b8966"; // you can get this from getMembers()
2 await roomSession.audioMute({ memberId: id });