Video

RoomSessionMember

View as Markdown

Represents a member of a room session. You receive instances of this type by listening to room events, for example on a RoomSession object.

The state of RoomSessionMember objects, for example member.visible, is immutable. When you receive instances of RoomSessionMember from event listeners, the state of the member always refers to that specific point in time and remains fixed for the whole lifetime of the object.

Example

Getting a RoomSessionMember instance when a user joins a RoomSession:

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      onMemberJoined: (member) => {
14        console.log("RoomSessionMember:", member);
15      },
16    });
17  }
18});

Properties

id
stringRequired

Unique id of this member.

roomId
stringRequired

Id of the room associated to this member.

roomSessionId
stringRequired

Id of the room session associated to this member.

name
stringRequired

Name of this member.

type
VideoMemberTypeRequired

Type of this video member. Can be 'member', 'screen', or 'device'.

parentId
string

Id of the parent video member, if it exists.

requestedPosition
VideoPositionRequired

Position requested for this member in the layout. This may differ from currentPosition if the requested position is not currently available.

currentPosition
VideoPosition

Current position of this member in the layout.

meta
Record<string, unknown>

Metadata associated to this member.

audioMuted
booleanRequired

Whether the outbound audio is muted (e.g., from the microphone).

videoMuted
booleanRequired

Whether the outbound video is muted.

deaf
booleanRequired

Whether the inbound audio is muted.

visible
booleanRequired

Whether the member is visible.

inputVolume
numberDefaults to 0Required

Input volume (e.g., of the microphone). Values range from -50 to 50.

outputVolume
numberDefaults to 0Required

Output volume (e.g., of the speaker). Values range from -50 to 50.

inputSensitivity
numberDefaults to 30Required

Input level at which the participant is identified as currently speaking. The scale goes from 0 (lowest sensitivity, essentially muted) to 100 (highest sensitivity).

handraised
booleanRequired

Whether the member’s hand is raised.

talking
boolean

Whether the member is currently talking.

Methods

audioMute

▸ audioMute(): Promise<void>

Mutes the outbound audio for this member (e.g., the one coming from a microphone). The other participants will not hear audio from the muted participant anymore.

Returns

Promise<void>

Example

In this example, we mute the audio of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Mute the audio of the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        await member.audioMute();
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name);
19      }
20    });
21  }
22});

audioUnmute

▸ audioUnmute(): Promise<void>

Unmutes the outbound audio for this member (e.g., the one coming from a microphone) if it had been previously muted.

Returns

Promise<void>

Example

In this example, we mute the audio of the member when they join the room and unmute it after 5 seconds. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Mute the audio of the RoomSession member when they join the room and unmute it after 5 seconds
14      onMemberJoined: async (member) => {
15        await member.audioMute();
16        setTimeout(async () => {
17          await member.audioUnmute();
18        }, 5000);
19      },
20      onMemberUpdated: async (member) => {
21        console.log("Member Updated:", member.name);
22      }
23    });
24  }
25});

remove

▸ remove(): Promise<void>

Removes this member from the room.

Returns

Promise<void>

Example

In this example, we remove the member from the room when they join the room after 5 seconds. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Remove the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        setTimeout(async () => {
16          await member.remove();
17        }, 5000);
18      },
19      onMemberUpdated: async (member) => {
20        console.log("Member Updated:", member.name);
21      }
22    });
23  }
24});

setDeaf

▸ setDeaf(value): Promise<void>

Mutes or unmutes the inbound audio for the member (e.g., the one played through this member’s speakers). When the inbound audio is muted, the affected participant will not hear audio from the other participants anymore.

Parameters

value
booleanRequired

Whether to mute the audio.

Returns

Promise<void>

Example

In this example, we mute the audio of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Mute the audio of the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        await member.setDeaf(true);
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name);
19      }
20    });
21  }
22});

setInputSensitivity

▸ setInputSensitivity(params): Promise<void>

Sets the input level at which the participant is identified as currently speaking.

Parameters

params
objectRequired

Object containing the parameters of the method.

value
numberDefaults to 30Required

Desired sensitivity from 0 (lowest sensitivity, essentially muted) to 100 (highest sensitivity).

Returns

Promise<void>

Example

In this example, we set the input sensitivity of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Set the input sensitivity of the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        await member.setInputSensitivity({ value: 80 });
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name);
19      }
20    });
21  }
22});

setInputVolume

▸ setInputVolume(params): Promise<void>

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

Parameters

params
objectRequired

Object containing the parameters of the method.

volume
numberDefaults to 0Required

Desired volume. Values range from -50 to 50.

Returns

Promise<void>

Example

In this example, we set the input volume of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Set the input volume of the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        await member.setInputVolume({ volume: -10 });
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name);
19      }
20    });
21  }
22});

setOutputVolume

▸ setOutputVolume(params): Promise<void>

Sets the output volume for the member (e.g., the speaker output level).

Parameters

params
objectRequired

Object containing the parameters of the method.

volume
numberDefaults to 0Required

Desired volume. Values range from -50 to 50.

Returns

Promise<void>

Example

In this example, we set the output volume of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      // Set the output volume of the RoomSession member when they join the room
14      onMemberJoined: async (member) => {
15        await member.setOutputVolume({ volume: -10 });
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name);
19      }
20    });
21  }
22});

videoMute

▸ videoMute(): Promise<void>

Mutes the outbound video for this member (e.g., the one coming from a webcam). Participants will see a mute image instead of the video stream.

Returns

Promise<void>

Example

In this example, we mute the video of the member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  
12  onRoomStarted: async (roomsession) => {
13    roomsession.listen({
14      // Mute the video of the RoomSession member when they join the room
15      onMemberJoined: async (member) => {
16        await member.videoMute();
17      },
18      onMemberUpdated: async (member) => {
19        console.log("Member Updated:", member.name);
20      }
21    });
22  }
23});

videoUnmute

▸ videoUnmute(): Promise<void>

Unmutes the outbound video for this member (e.g., the one coming from a webcam) if it had been previously muted. Participants will start seeing the video stream again.

Returns

Promise<void>

Example

In this example, we mute the video of the member when they join the room and unmute it after 5 seconds. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Listen for a room to start
10await videoClient.listen({
11
12  onRoomStarted: async (roomsession) => {
13    // Listen for a member to join the room
14    roomsession.listen({
15      onMemberJoined: async (member) => {
16        // Mute the video of the RoomSession member when they join the room
17        await member.videoMute();
18        // Unmute the video of the RoomSession member after 5 seconds
19        setTimeout(async () => {
20          await member.videoUnmute();
21        }, 5000);
22      },
23      onMemberUpdated: async (member) => {
24        console.log("Member Updated:", member.name);
25      }
26    });
27  }
28});

setRaisedHand

▸ setRaisedHand(params): Promise<void>

Sets the raised hand status for this member.

Parameters

params
objectRequired

Object containing the parameters of the method.

raised
booleanDefaults to true

Whether to raise or lower the hand. If omitted, the hand status is toggled to the opposite of the current status.

Returns

Promise<void>

Example

In this example, we raise the hand of a member when they join the room. This example assumes that you already have a RoomSession active and members are joining the room.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Intialize the SignalWire Client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
5
6// Access the video client from the SignalWire client
7const videoClient = client.video;
8
9// Setup listerner for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomsession) => {
12    roomsession.listen({
13      onMemberJoined: async (member) => {
14        // Raise the hand of the member
15        await member.setRaisedHand({ raised: true });
16      },
17      onMemberUpdated: async (member) => {
18        console.log("Member Updated:", member.name, "Hand Raised:", member.handraised);
19      }
20    });
21  }
22});