unichatjs v1.0.0

UniChatJS: Simple unichat-to-unichat with WebRTC

UniChatJS provides a complete, configurable, and easy-to-use unichat-to-unichat API built on top of WebRTC, supporting both data channels and media streams.

Live Example

Here's an example application that uses both media and data connections: https://glitch.com/~unichatjs-video. The example also uses its own UnichatServer.

Setup

Include the library

with npm: npm install unichatjs

with yarn: yarn add unichatjs

// The usage -
import Unichat from 'unichatjs';

Create a Unichat

const unichat = new Unichat('pick-an-id'); 
// You can pick your own id or omit the id if you want to get a random one from the server.

Data connections

Connect

const conn = unichat.connect('another-peers-id');
conn.on('open', () => {
  conn.send('hi!');
});

Receive

unichat.on('connection', (conn) => {
  conn.on('data', (data) => {
    // Will print 'hi!'
    console.log(data);
  });
  conn.on('open', () => {
    conn.send('hello!');
  });
});

Media calls

Call

navigator.mediaDevices.getUserMedia({video: true, audio: true}, (stream) => {
  const call = unichat.call('another-peers-id', stream);
  call.on('stream', (remoteStream) => {
    // Show stream in some <video> element.
  });
}, (err) => {
  console.error('Failed to get local stream', err);
});

Answer

unichat.on('call', (call) => {
  navigator.mediaDevices.getUserMedia({video: true, audio: true}, (stream) => {
    call.answer(stream); // Answer the call with an A/V stream.
    call.on('stream', (remoteStream) => {
      // Show stream in some <video> element.
    });
  }, (err) => {
    console.error('Failed to get local stream', err);
  });
});

Running tests

npm test

Browsers support

Safari

1. Safari supports only string data when sending via DataConnection. Use JSON serialization type if you want to communicate with Safari. By default, DataConnection uses Binary serialization type.

FAQ

Q. I have a message Critical dependency: the request of a dependency is an expression in browser's console

A. The message occurs when you use UniChatJS with Webpack. It is not critical! It relates to Parcel https://github.com/parcel-bundler/parcel/issues/2883 We'll resolve it when updated to Parcel V2.

Links

UnichatServer

License

UniChatJS is licensed under the MIT License.