addMicrophone

addMicrophone(opts): Promise<RoomSessionDevice> - See RoomSessionDevice documentation for more details.

Adds a microphone device to the room. Using this method, a user can stream multiple audio sources at the same time.

Parameters

opts

MediaTrackConstraints & { autoJoin?: boolean }

Specify the constraints for the device. In addition, you can add the autoJoin key to specify whether the device should immediately join the room or joining will be performed manually later.

Returns

Promise<RoomSessionDevice> - See RoomSessionDevice documentation for more details.

Permissions

room.self.additional_source

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

Examples

Adding any of the microphone devices to the room (duplicate streams are possible):

1 await roomSession.addMicrophone();

Adding a specific microphone:

1 await roomSession.addMicrophone({
2   deviceId: "PIn/IIDDgBUHzJkhRncv1m85hX1gC67xYIgJvvThB3Q=",
3 });

Adding a microphone with specific constraints, joining it manually:

1 const roomDev = await roomSession.addMicrophone({
2   autoJoin: false,
3   noiseSuppression: true,
4 });
5 await roomDev.join();