setInputVolume

setInputVolume(params): Promise<void>

Sets the input volume level (e.g. for the microphone). You can use this method to set the input volume for either yourself or another participant in the room.

Parameters

params

object

Object containing the parameters of the method.

memberId

string

Id of the member for which to set input volume. If omitted, sets the volume of the default device in the local client.

volume

number

Desired volume. Values range from -50 to 50, with a default of 0.

Returns

Promise<void>

Permissions

room.self.set_input_volume: to set the volume for a local device.
room.member.set_input_volume: to set the volume for a remote member.

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

Examples

Setting your own microphone volume:

1 await roomSession.setInputVolume({ volume: -10 });

Setting the microphone volume of another participant:

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

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