setInputVolume

setInputVolume(params): Promise<void>

Sets the input volume for a given member (e.g., the microphone input level).

Parameters

params

objectRequired

Object containing the parameters of the method.

memberId

string

ID of the member to affect.

volume

numberDefaults to 0Required

Desired volume. Values range from -50 to 50.

Returns

Promise<void>

Example

In this example, we wait for a second member to join the room and then set the input volume for that member to -50. This example assumes that there is a RoomSession already active and that members are joining the room.

1 import { SignalWire } from "@signalwire/realtime-api";
2 
3 const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4 
5 const videoClient = client.video;
6 
7 // Setup listener for when a room starts
8 await videoClient.listen({
9   onRoomStarted: (roomsession) => {
10     console.log("Room started", roomsession.displayName);
11 
12     // Setup listener for when a room is updated
13     roomsession.listen({
14       onMemberJoined: (member) => {
15         console.log("Member joined", member.name);
16 
17         // Update the input sensitivity for the member
18         roomsession.setInputVolume({
19           volume: -50,
20           memberId: member.id,
21         });
22       },
23       onMemberUpdated: (member) => {
24         console.log(`Updated input volume for ${member.name, member.inputVolume}`);
25       },
26     })
27   }
28 });