Sin descripción

Jairo Caro-Accino Viciana b88da6a195 Merge pull request #434 from opencollective/opencollective hace 7 años
dist 73d9173c3e Publish to NPM hace 7 años
docs 03a5b02da6 Mention the correct default port. hace 10 años
examples 3ff8c4f897 Merge pull request #421 from mayoljonathan/master hace 7 años
lib 73d9173c3e Publish to NPM hace 7 años
test 00e59f60be Make exports browserify compatible hace 11 años
.gitignore 81f3429c7c Add dist back hace 11 años
.npmignore 00e59f60be Make exports browserify compatible hace 11 años
Gruntfile.js 37016f06aa Better to avoid 'compress' option at all to keep it behave as by default hace 10 años
LICENSE fc7c88d3e3 Update LICENSE hace 10 años
Makefile 00e59f60be Make exports browserify compatible hace 11 años
README.md 7660ff1873 Added backers and sponsors on the README hace 7 años
changelog.md aa281474cf 0.3.14 hace 11 años
index.d.ts 8ee1e46b29 Add module-based TypeScript declarations hace 8 años
package.json fba37da377 Added call to donate after npm install (optional) hace 7 años

README.md

PeerJS: Simple peer-to-peer with WebRTC

Backers on Open Collective Sponsors on Open Collective

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.

http://peerjs.com

Setup

Include the library

from the cdn:

<script src="https://cdnjs.cloudflare.com/ajax/libs/peerjs/0.3.14/peer.js"></script>

with modules: npm install peerjs or yarn add peerjs

and the usage:
  import Peer from '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);
  });
});

Links

Documentation / API Reference

WebRTC Browser compatibility status

PeerServer

Discuss PeerJS on our Google Group

Changelog

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

PeerJS is licensed under the MIT License.