mediasoup-cluster

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #go #android #linux #awesome #cli #kubernetes #awesome-list #pytorch #ios #open-source

mediasoup-cluster

(★ 11)

The mediasoup cluster can be expanded in horizontally and vertically, serving unlimited clients

mediasoup-cluster Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mediasoup cluster

Cluster uses PostgreSQL server to save data of slave servers

```
 +----------------+
 +-----------------+ webrtc | slave server |
 | producer client |------------------------------->| for producer |
 +-----------------+ +----------------+
 | ^ |
 | +---------------+ | |
 +--------------->| |------------+ | mediasoup
 http | master server | http | pipe
 +--------------->| |------------+ | transport
 | +---------------+ | |
 | v v
 | +----------------+
 +-----------------+ | slave server |
 | consumer client |<-------------------------------| for consumer |
 +-----------------+ webrtc +----------------+
```

## Quickstart

Build code (must use node **v18+**)

```
npm install
npm run build
```

Copy env.dev file to .env

```
cp .env.dev .env
```

Update config in .env file. Detail in [example](https://github.com/woody146/mediasoup-cluster/issues/1#issuecomment-1689558894)

```js
// your PostgreSQL server info
DATABASE_URL = "postgresql://postgres:123456@localhost:5432/mediasoup"
...
// your ip in internet network
// https://mediasoup.org/documentation/v3/mediasoup/api/#TransportListenIp
MEDIASOUP_WEBRTC_TRANSPORT_LISTEN_IPS = '[
   {
      "ip": "192.168.6.143",
      "announcedIp": null
   }
]'
```

Create a master server

```
npm run start:master
```

Create a slave server to produce

```
npm run start:slave:producer
```

Create a slave server to consume

```
npm run start:slave:consumer
```

Run demo app

```
cd examples/rooms/
npm install
npm run dev
```

Then, navigate to https://localhost:4430

## Documentation

#### Master server API

<table>
 <tbody>
 <tr>
 <th >Method</th>
 <th >Path</th>
 <th >Request</th>
 <th >Response</th>
 </tr>
 <tr>
 <th colspan="4" align="center">For producer client</th>
 </tr>
 <tr>
 <td>POST</td>
 <td>/rooms create room</td>
 <td></td>
 <td>
 <ul>
 <li>id: room id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities">rtpCapabilities</a></li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/rooms/:roomId/producer_transports create producer transport</td>
 <td>
 <ul>
 <li>userId: string</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: transport id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters">dtlsParameters</a</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceCandidate">iceCandidates</a<</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters">iceParameters</a<</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/producer_transports/:transportId/connect make transport connect</td>
 <td>
 <ul>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters">dtlsParameters</a</li>
 </ul>
 </td>
 <td></td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/producer_transports/:transportId/produce make transport produce</td>
 <td>
 <ul>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/rtp-parameters-and-capabilities/#MediaKind">kind</a</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/rtp-parameters-and-capabilities/#RtpParameters">rtpParameters</a</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: producer id</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/producers/:producerId/pause pause producer</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/producers/:producerId/resume resume producer</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>DELETE</td>
 <td>/rooms/:roomId delete the room if no one is in the room</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <th colspan="4" align="center">For consumer client</th>
 </tr>
 <tr>
 <td>GET</td>
 <td>/rooms/:roomId/producer_transports get producer transport list</td>
 <td>
 </td>
 <td>
 <ul>
 <li>items: array of objects</li>
 <ul>
 <li>id: transport id</li>
 <li>userId: user id</li>
 <li>producers: { id: string; kind: string }[]</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/rooms/:roomId/consumer_routers get or create router in this room</td>
 <td>
 <ul>
 <li>userId: string</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: router id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities">rtpCapabilities</a></li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/rooms/:roomId/consumer_transports create consumer transport</td>
 <td>
 <ul>
 <li>userId: string</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: transport id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters">dtlsParameters</a</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceCandidate">iceCandidates</a<</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters">iceParameters</a<</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/router/:routerId/consumer_transports create consumer transport</td>
 <td>
 <ul>
 <li>userId: string</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: transport id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters">dtlsParameters</a</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceCandidate">iceCandidates</a<</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters">iceParameters</a<</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/consumer_transports/:transportId/connect make transport connect</td>
 <td>
 <ul>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters">dtlsParameters</a</li>
 </ul>
 </td>
 <td></td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/consumer_transports/:transportId/consume make transport consume</td>
 <td>
 <ul>
 <li>producerId: string</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities">rtpCapabilities</a></li>
 </ul>
 </td>
 <td>
 <ul>
 <li>id: consumer id</li>
 </ul>
 </td>
 </tr>
 <tr>
 <td>POST</td>
 <td>/consumers/:consumerId/resume make consumer resume after connected</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <th colspan="4" align="center">Utils</th>
 </tr>
 <tr>
 <td>POST</td>
 <td>/user/:userId/logout make user logout</td>
 <td>
 <ul>
 <li>roomId?: string</li>
 </ul>
 </td>
 <td></td>
 </tr>
 <tr>
 <td>DELETE</td>
 <td>/transports/:transportId close producer or consumer transport</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>GET</td>
 <td>/rooms get room list in system</td>
 <td>
 <ul>
 <li>page?: number</li>
 <li>pageSize?: number</li>
 <li>orderBy?: string</li>
 </ul>
 </td>
 <td>
 <ul>
 <li>items: room objects</li>
 <ul>
 <li>id: string</li>
 <li>createDate: Date</li>
 </ul>
 <li>pagination</li>
 <ul>
 <li>page: number</li>
 <li>pageSize: number</li>
 <li>total: number</li>
 </ul>
 </ul>
 </td>
 </tr>
 <tr>
 <td>GET</td>
 <td>/rooms/:roomId get room detail</td>
 <td></td>
 <td>
 <ul>
 <li>id: room id</li>
 <li><a href="https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities">rtpCapabilities</a></li>
 </ul>
 </td>
 </tr>
 </tbody>
</table>

## License

mediasoup-cluster is [MIT Licensed](https://github.com/woody146/mediasoup-cluster/blob/master/LICENSE).

mediasoup-cluster

mediasoup-cluster Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

mediasoup-cluster

mediasoup-cluster Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README