Setting up and Configuring Mediasoup-client in Your Project

To install and configure Mediasoup-client in your project, follow these steps:

Install Node.js

Firstly, you need to install Node.js on your computer. Node.js is a server-side JavaScript runtime environment. Visit the official Node.js website ( and download the appropriate version for your operating system. Once the installation is complete, you can check the installed Node.js version by opening a terminal and running the following command:

node -v


Initialize the project and install Mediasoup-client

Create a new directory for your project and open a terminal in that directory. Run the following command to initialize a new Node.js project and create a package.json file:

npm init -y

Next, install Mediasoup-client in your project by running the following command:


npm install mediasoup-client


Import and configure Mediasoup-client

In your project's source code file, add the following line to import Mediasoup-client

const mediasoupClient = require('mediasoup-client');

To configure Mediasoup-client, you need to create a Device object. This object represents the client device and will be used to create and manage media connections with the Mediasoup server. You can create a Device object using the following syntax:

const device = new mediasoupClient.Device();

Next, you need to fetch the "Router RTP Capabilities" information from the Mediasoup server. The Router RTP Capabilities contains technical parameters such as supported codecs, server support, and related media management parameters. You can retrieve this information through an HTTP API or by directly communicating with the Mediasoup server.

After obtaining the Router RTP Capabilities, use the device.load() method to load this information into the Device object.

For example:

const routerRtpCapabilities = await fetchRouterRtpCapabilities(); // Function to fetch Router RTP Capabilities from the Mediasoup server

await device.load({ routerRtpCapabilities });


Create and use Transport

To send and receive media streams, you need to create and use a Transport object. Each Transport object represents a unique media connection with the Mediasoup server. You can create a Transport object using the device.createSendTransport() or device.createRecvTransport() methods.

For example:

const transport = await device.createSendTransport({
  // Transport configuration

When creating a Transport, you can provide configuration parameters such as the server URL and connection port. Additionally, you can listen to events like 'connect' or 'produce' on the Transport object to handle related media interactions.


Create and use Producer and Consumer

To send and receive media streams, you need to create and use Producer and Consumer objects. A Producer represents a media source sent from the client to the server, while a Consumer represents a media source received from the server to the client. You can create a Producer using the transport.produce() method, and create a Consumer using the transport.consume() method.

For example:

// Create Producer
const producer = await transport.produce({
  kind: 'video',
  // Producer configuration

// Create Consumer
const consumer = await transport.consume({
  // Consumer configuration

// Use Producer and Consumer to send and receive media streams
// ...

You can use the available methods and events on the Producer and Consumer objects to control media transmission, such as sending data, toggling media streams on/off, or handling related media events.


Release resources

When you have finished using Mediasoup-client, make sure to release resources to avoid memory leaks and system resource issues. Close the Transport and unload the Device by using the transport.close() and device.unload() methods.



These are the basic steps to install, configure, and use Mediasoup-client in your project. Refer to the Mediasoup-client documentation and additional detailed examples to learn more about its powerful features and capabilities.