Expand description
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 Producer
s 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
Router
.Router
.Router
instance in a mediasoup-worker thread.Router
instances collocated on the same host or on
separate hosts.Transport
instances created on it.Producer
,
Consumer
, DataProducer
and
DataConsumer
instances created on it.WebRtcTransport
s.Router
instances.Worker
instances.