setOutputVolume

View as Markdown

setOutputVolume

  • setOutputVolume(params): Promise<void>

Sets the output volume level (e.g., for the speaker). You can use this method to set the output 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 to affect. If omitted, affects 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_output_volume: to set the speaker volume for yourself.
  • room.member.set_output_volume: to set the speaker 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 output volume:

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

Setting the output volume of another participant:

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