mediasoup
Advanced tools
Readme
Powerful WebRTC SFU (Selective Forwarding Unit) for Node.
Not entirely ready yet (but will be soon). Check the milestones.
$ npm install mediasoup --save
NOTE: Currently mediasoup just works in POSIX systems (Linux, OSX, etc). In the future it will also run in Windows.
NOTE: Not updated.
var mediasoup = require('mediasoup');
// Create a mediasoup server.
var server = mediasoup.Server();
// Create a conference room.
var room = server.Room();
// Our custom signaling server.
var signalingServer = [...];
signalingServer.on('invite', (request) =>
{
// Add a participant into the room.
var peer = room.Peer(request.username);
// Our signaling response.
var response =
{
candidates: []
};
// After inspecting `requests.transports` we need to create a single
// transport for sending/receiving both audio and video.
peer.createTransport({ udp: true, tcp: true })
.then((transport) =>
{
// Log DTLS state changes.
transport.on('dtlsstatechange', (data) =>
{
console.log('transport "dtlsstatechange" event [data.dtlsState:%s]', data.dtlsState);
});
// Append our local ICE candidates into the response.
transport.iceLocalCandidates.forEach((candidate) =>
{
response.candidates.push(candidate);
});
// Set remote DTLS parameters.
return transport.setRemoteDtlsParameters(
{
role : request.dtlsRole,
fingerprint :
{
algorithm : request.remoteFingerprint.type,
value : request.remoteFingerprint.hash
}
})
.then(() =>
{
// Set our DTLS parameters into the response.
response.dtlsRole = transport.dtlsLocalParameters.role;
response.fingerprint =
{
type : 'sha-512',
hash : transport.dtlsLocalParameters.fingerprints['sha-512']
};
// And send the response.
signalingServer.send(response);
});
});
});
Until the API is documented, the output of the included test units may help a bit understanding how the API will look like:
ibc in ~/src/mediasoup $ gulp test
Using gulpfile ~/src/mediasoup/gulpfile.js
Starting 'test'...
test/test_mediasoup.js
mediasoup.Server() with no options must succeed
✓ server must close cleanly
mediasoup.Server() with valid options must succeed
✓ server must close cleanly
mediasoup.Server() with wrong options must fail
✓ server must close with error
mediasoup.Server() with non existing `rtcListenIPv4` IP must fail
✓ server must close with error
mediasoup.Server() with too narrow RTC ports range must fail
✓ server must close with error
test/test_Server.js
server.updateSettings() with no options must succeed
✓ server.updateSettings() succeeded
server.updateSettings() with valid options must succeed
✓ server.updateSettings() succeeded
server.updateSettings() with invalid options must fail
✓ server.updateSettings() failed: Error: invalid value 'chicken' for logLevel
server.updateSettings() in a closed server must fail
✓ server.updateSettings() failed: InvalidStateError: Server closed
✓ server.updateSettings() must reject with InvalidStateError
server.Room() must succeed
✓ room must close cleanly
server.Room() in a closed server must fail
✓ server.Room() must throw InvalidStateError
server.dump() must succeed
✓ server.dump() succeeded
✓ server.dump() must retrieve two workers
test/test_Room.js
room.Peer() with `peerName` must succeed
✓ peer must close cleanly
room.Peer() without `peerName` must fail
✓ room.Peer()) must throw TypeError
room.Peer() with same `peerName` must fail
✓ room.Peer() must throw
room.Peer() with same `peerName` must succeed if previous peer was closed before
✓ room.getPeer() must retrieve the first "alice"
✓ room.peers must retrieve one peer
✓ room.getPeer() must retrieve nothing
✓ room.peers must retrieve zero peers
✓ room.getPeer() must retrieve the new "alice"
✓ room.peers must retrieve one peer
✓ peer must close cleanly
room.dump() must succeed
✓ room.dump() succeeded
✓ room.dump() must retrieve two peers
test/test_Peer.js
peer.createTransport() with no options must succeed
✓ peer.name must be "alice"
✓ peer.createTransport() succeeded
✓ peer.dump() succeeded
✓ peer.dump() must retrieve one transport
peer.createTransport() with no `udp` nor `tcp` must fail
✓ peer.createTransport() failed: Error: could not open any IP:port
peer.RtpReceiver() with valid `transport` must succeed
✓ peer.createTransport() succeeded
✓ rtpReceiver.transport must retrieve the given `transport`
✓ peer.dump() succeeded
✓ peer.dump() must retrieve one rtpReceiver
✓ rtpReceiver must close cleanly
peer.RtpReceiver() with a closed `transport` must fail
✓ peer.createTransport() succeeded
✓ peer.RtpReceiver() must throw InvalidStateError
test/test_Transport.js
transport.setRemoteDtlsParameters() with "server" `role` must succeed
✓ peer.createTransport() succeeded
✓ default local DTLS `role` must be "auto"
✓ transport.setRemoteDtlsParameters() succeeded
✓ new local DTLS `role` must be "client"
✓ transport.dump() succeeded
✓ local DTLS `role` must be "client"
transport.setRemoteDtlsParameters() with "auto" `role` must succeed
✓ peer.createTransport() succeeded
✓ transport.setRemoteDtlsParameters() succeeded
✓ new local DTLS `role` must be "client"
✓ transport.dump() succeeded
✓ local DTLS `role` must be "client"
transport.setRemoteDtlsParameters() with no `role` must succeed
✓ peer.createTransport() succeeded
✓ transport.setRemoteDtlsParameters() succeeded
✓ new local DTLS `role` must be "client"
✓ transport.dump() succeeded
✓ local DTLS `role` must be "client"
transport.setRemoteDtlsParameters() with invalid `role` must fail
✓ peer.createTransport() succeeded
✓ transport.setRemoteDtlsParameters() failed: Error: invalid `data.role`
✓ local DTLS `role` must be "auto"
transport.setRemoteDtlsParameters() without `fingerprint` must fail
✓ peer.createTransport() succeeded
✓ transport.setRemoteDtlsParameters() failed: Error: missing `data.fingerprint`
✓ local DTLS `role` must be "auto"
transport.close() must succeed
✓ peer.createTransport() succeeded
✓ transport must close cleanly
✓ `transport.iceState` must be "closed"
✓ `transport.dtlsState` must be "closed"
✓ peer.dump() succeeded
✓ peer.dump() must retrieve zero transports
test/test_RtpReceiver.js
rtpReceiver.receive() with valid `rtpParameters` must succeed
✓ rtpReceiver.transport must retrieve the given `transport`
✓ rtpReceiver.receive() succeeded
✓ transport.dump() succeeded
✓ transport.dump() must provide the given ssrc values
✓ transport.dump() must provide the given payload types
✓ rtpReceiver.dump() succeeded
✓ rtpReceiver.dump() must provide the expected `rtpParameters`
rtpReceiver.receive() with no `rtpParameters` must fail
✓ rtpReceiver.receive() failed: Error: missing `kind`
rtpReceiver.close() must succeed
✓ rtpReceiver must close cleanly
✓ peer.dump() succeeded
✓ peer.dump() must retrieve zero rtpReceivers
test/test_extra.js
extra.fingerprintFromSDP()
✓ should be equal
✓ should be equal
extra.fingerprintToSDP()
✓ should be equal
✓ should be equal
test/test_scene_1.js
alice, bob and carol create RtpReceivers and expect RtpSenders
✓ room created
✓ alice created
✓ bob created
✓ transport created for alice
✓ transport created for bob
✓ rtpReceiver.receive() succeeded for alice
✓ rtpReceiver.receive() succeeded for alice
✓ alice "newrtpsender" event fired
✓ `rtpSender.associatedPeer` must be bob
✓ rtpReceiver.receive() succeeded for bob
✓ rtpSender retrieved via bob.rtpSenders
✓ `receiverPeer` must be alice
✓ rtpSender retrieved via bob.rtpSenders
✓ `receiverPeer` must be alice
✓ rtpSender.setTransport() succeeded
✓ rtpSender.transport must retrieve the given `transport`
✓ rtpSender.setTransport() succeeded
✓ rtpSender.transport must retrieve the given `transport`
✓ rtpSender.setTransport() succeeded
✓ rtpSender.transport must retrieve the given `transport`
✓ alice.rtpSenders must retrieve 1
✓ bob.rtpSenders must retrieve 2
✓ first RtpSender parameters of alice must match video parameters of bob
✓ first RtpSender parameters of bob must match audio parameters of alice
✓ second RtpSender parameters of bob must match video parameters of alice
✓ room.dump() succeeded
✓ `data.mapRtpReceiverRtpSenders` match the expected values
close aliceAudioReceiver
✓ aliceAudioReceiver closed
✓ bobAudioSender closed
✓ room.dump() succeeded
✓ `data.mapRtpReceiverRtpSenders` match the expected values
close bob
✓ bobVideoReceiver closed
✓ bobVideoSender closed
✓ bob closed
✓ aliceVideoSender closed
✓ alice.rtpReceivers must retrieve 1
✓ bob.rtpReceivers must retrieve 0
✓ alice.rtpSenders must retrieve 0
✓ bob.rtpSenders must retrieve 0
✓ room.dump() succeeded
✓ `data.mapRtpReceiverRtpSenders` match the expected values
✓ transport created for carol
✓ rtpReceiver.receive() succeeded for carol
✓ rtpReceiver.receive() succeeded for carol
✓ room.dump() succeeded
✓ `data.mapRtpReceiverRtpSenders` match the expected values
127 passing (7s)
Iñaki Baz Castillo (@ibc at Github)
FAQs
Cutting Edge WebRTC Video Conferencing
The npm package mediasoup receives a total of 7,856 weekly downloads. As such, mediasoup popularity was classified as popular.
We found that mediasoup demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).