Crate mediasoup

Rust port of mediasoup TypeScript library!

For general information go to readme in repository.

For TypeScript users

If you were using mediasoup in TypeScript before, most of the API should be familiar to you. However, this is not one-to-one port, API was adjusted to more idiomatic Rust style leveraging powerful type system and ownership system to make API more robust and more misuse-resistant.

So you will find specific types in most places where plain strings were used, instead of close() you will see Drop implementation for major entities that will close everything gracefully when it goes out of scope.

Before you start

This is very low-level library. Which means it doesn’t come with a ready to use signaling mechanism or easy to customize app scaffold (see design goals).

It is recommended to visit mediasoup website and read design overview first.

There are some requirements for building underlying C++ mediasoup-worker, please find them in installation instructions

Examples

There are some examples in examples and examples-frontend directories (for server- and client-side respectively), you may want to look at those to get a general idea of what API looks like and what needs to be done in what order (check WebSocket messages in browser DevTools for better understanding of what is happening under the hood).

How to start

With that in mind, you want start with creating WorkerManager instance and then 1 or more workers. Workers a responsible for low-level job of sending media and data back and forth. Each worker is backed by single-core C++ worker thread. On each worker you create one or more routers that enable injection, selection and forwarding of media and data through transport instances. There are a few different transports available, but most likely you’ll want to use WebRtcTransport most often. With transport created you can start creating Producers to send data to Router and Consumer instances to extract data from Router.

Some of the more advanced cases involve multiple routers and even workers that can user more than one core on the machine or even scale beyond single host. Check scalability page of the official documentation.

Please check integration and unit tests for usage examples, they cover all major functionality and are a good place to start until we have demo apps built in Rust).

Modules

audio_level_observer	An audio level observer monitors the volume of the selected audio producers.
consumer	A consumer represents an audio or video source being forwarded from a mediasoup router to an endpoint. It’s created on top of a transport that defines how the media packets are carried.
data_consumer	A data consumer represents an endpoint capable of receiving data messages from a mediasoup Router.
data_producer	A data producer represents an endpoint capable of injecting data messages into a mediasoup Router.
data_structures	Miscellaneous data structures.
direct_transport	A direct transport represents a direct connection between the mediasoup Rust process and a Router instance in a mediasoup-worker thread.
pipe_transport	A pipe transport represents a network path through which RTP, RTCP (optionally secured with SRTP) and SCTP (DataChannel) is transmitted. Pipe transports are intended to intercommunicate two Router instances collocated on the same host or on separate hosts.
plain_transport	A plain transport represents a network path through which RTP, RTCP (optionally secured with SRTP) and SCTP (DataChannel) is transmitted.
producer	A producer represents an audio or video source being injected into a mediasoup router. It’s created on top of a transport that defines how the media packets are carried.
router	A router enables injection, selection and forwarding of media streams through Transport instances created on it.
rtp_observer	An RTP observer inspects the media received by a set of selected producers.
rtp_parameters	Collection of RTP-related data structures that are used to specify codec parameters and capabilities of various endpoints.
scalability_modes	Scalability mode.
sctp_parameters	Collection of SCTP-related data structures that are used to specify SCTP association parameters.
srtp_parameters	Collection of SRTP-related data structures that are used to specify SRTP encryption/decryption parameters.
supported_rtp_capabilities	RTP capabilities supported by mediasoup.
transport	A transport connects an endpoint with a mediasoup router and enables transmission of media in both directions by means of Producer, Consumer, DataProducer and DataConsumer instances created on it.
webrtc_transport	A WebRTC transport represents a network path negotiated by both, a WebRTC endpoint and mediasoup, via ICE and DTLS procedures. A WebRTC transport may be used to receive media, to send media or to both receive and send. There is no limitation in mediasoup. However, due to their design, mediasoup-client and libmediasoupclient require separate WebRTC transports for sending and receiving.
worker	A worker represents a mediasoup C++ thread that runs on a single CPU core and handles Router instances.
worker_manager	Container that creates Worker instances.