skyway-peerjs

0.4.0 • Public • Published

PeerJS: Simple peer-to-peer with WebRTC

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

Notice

This branch is a customized version of PeerJS for NTT Communications's WebRTC platform SkyWay.

Setup

Include the library

<script src="https://skyway.io/dist/0.3/peer.js"></script>

Include with NPM

npm install skyway-peerjs

Create a Peer
Get a free API key. Your id only needs to be unique to the namespace of your API key.

var peer = new Peer('pick-an-id', {key: 'myapikey'}); 
// You can pick your own id or omit the id if you want to get a random one from the server.

Data connections

Connect

var conn = peer.connect('another-peers-id');
conn.on('open', function(){
  conn.send('hi!');
});

Receive

peer.on('connection', function(conn) {
  conn.on('data', function(data){
    // Will print 'hi!'
    console.log(data);
  });
});

Media calls

Call

navigator.getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
navigator.getUserMedia({video: true, audio: true}, function(stream) {
  var call = peer.call('another-peers-id', stream);
  call.on('stream', function(remoteStream) {
    // Show stream in some <video> element.
  });
}, function(err) {
  console.log('Failed to get local stream' ,err);
});
 

Answer

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

SkyWay Links

Documentation / API Reference

Changelog

free API key

Discuss SkyWay on our Google Group

PeerJS links

WebRTC Browser compatibility status

PeerServer

Discuss PeerJS on our Google Group

Readme

Keywords

none

Package Sidebar

Install

npm i skyway-peerjs

Homepage

skyway.io/en

Weekly Downloads

3

Version

0.4.0

License

MIT

Last publish

Collaborators

  • alanmshelly
  • nttcom-skyway
  • komasshu
  • yusuke84