WebRTC wrapper with built-in signaling for React and Vue.
These are the planned updates of the project.
- Choose device option
- File sharing example
1. Install the package
2. Import, configure, create an instance
3. Wire up signaling on client-side
4. Setup signaling on server-side
5. Using mediastream, datachannel
npm install neat-rtc
import NeatRTC from 'neat-rtc';
const config = {
devMode: true,
videoIdLocal: 'localVideo',
videoIdRemote: 'remoteVideo',
connected: connected,
mediaStreamConnected: mediaStreamConnected,
mediaStreamRemoved: mediaStreamRemoved,
mediaStreamRemoteRemoved: mediaStreamRemoteRemoved,
datachannels: [
{
name: 'text',
callbacks: {
open: datachannelOpen,
message: datachannelMessage,
error: datachannelError,
close: datachannelClose
}
}
]
};
Important: you have to set up all of the callback functions above.
RTCPeerConnection configuration (optional)
Add the following properties to the above config
object.
connectionConfig
: set the STUN/TURN servers and other connection options, for more information check the RTCConfiguration dictionary.
Default value:
{
iceServers: [
{
url: 'stun:stun.l.google.com:19302'
}
]
}
optionalConfig
: set the optional connection configurations. Default value:
{
optional: [
{
DtlsSrtpKeyAgreement: true
},
{
RtpDataChannels: false
}
]
}
rtc = new NeatRTC(config, sendSignalingMessage);
Start signaling when two client connects to the same room, using join
namespace.
join(message => {
const { clientCount } = message;
if (clientCount === 2) {
rtc.connect();
};
})
Use your Socket.IO send function, messages to signaling
namespace.
sendSignalingMessage = (message) => {
send('signaling', message);
}
Use your Socket.IO receive function, messages from signaling
namespace.
signaling(message => {
rtc.handleSignaling(message);
})
Joining connected clients to a room, using join
namespace.
const join = (room) => {
// Count clients in room
const clientCount = (typeof io.sockets.adapter.rooms[room] !== 'undefined') ? io.sockets.adapter.rooms[room].length : 0;
// Check if client can join to the room
if (clientCount < 2) {
socket.join(room);
socket.emit('join', { clientCount: clientCount+1 });
console.log('Joined to room!');
} else {
console.log('Room is full!');
};
}
Messaging between clients during signaling, using signaling
namespace.
socket.on('signaling', message => {
socket.to(room).emit('signaling', message);
})
Note: you need to join the clients to the same room for signaling. You can find an example to this at the ./examples/server/
folder.
Tip: alternatively you can use your custom method to send/receive signaling messages between the clients.
Basic
rtc.media('start');
Better quality (hd720, hd1080)
rtc.media('start', { resolution: 'hd720' });
rtc.media('start', { resolution: 'hd1080' });
Voice only (without video)
rtc.media('start', { voice: true });
Local
rtc.media('stop');
Remote (stop incoming stream)
rtc.media('stopRemote');
The message can be a string or an object.
rtc.send('text', { content: 'Datachannel message' });
Every datachannel message will arrive to the callback function you set, in this case it's the datachannelMessage
function.
datachannelMessage = (channel, message) => {
console.log(channel, message);
}
Function | Parameters | Description |
---|---|---|
constructor | object config,function sendCb |
Initialize the module. config: { bool devModestring videoIdLocalstring videoIdRemotefunction mediaStreamConnectedfunction mediaStreamRemovedfunction mediaStreamRemoteRemovedobject datachannels} sendCb: Callback for message sending through socket.io. Used in the signaling process. |
connect | - | Start a connection to the other peer. |
disconnect | - | End the connection. |
handleSignaling | object message |
Handle messaging during the signaling. |
checkConnection | string channel |
Check if the connection is alive. |
media | string type,object options |
Control the camera/microphone. type: start / stop / stopRemote options: { string resolution: hd720 / hd1080 bool voice} |
send | string channelobject message |
Send a message on a datachannel. |
Included working examples for React and Vue with a Node.js (Express, Socket.IO) server.
You have to run the client (React or Vue) and the server separately.
Start with running these in the root folder ./
npm install
npm run build
To test the connection, open two browser tabs, they will connect automatically and you can use the built-in functions to try out mediastream and datachannel.
Navigate to the ./examples/client/react/
folder and run
npm install
npm start
Module imported in: ./examples/client/react/src/App.js
Navigate to the ./examples/client/vue/
folder and run
npm install
npm run dev
Module imported in: ./examples/client/vue/src/components/Home.js
Navigate to the ./examples/server/
folder and run
npm install
npm start
The MIT License (MIT)
Copyright (c) 2019 Tamas Szoke
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.