videoMute

View as Markdown

videoMute

  • videoMute(params?): Promise<void>

Puts the video on mute. Participants will see a mute image instead of the video stream. 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.video_mute: to unmute a local device.
  • room.member.video_mute: to unmute a remote member.

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

Examples

Muting your own video:

1await roomSession.videoMute();

Muting the video of another participant:

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