Nav apraksta

Jairooo 3dbc8a16a1 Merge pull request #451 from i0n/master 6 gadi atpakaļ
dist b1d9252966 Revert for PL 7 gadi atpakaļ
docs 03a5b02da6 Mention the correct default port. 10 gadi atpakaļ
examples 3ff8c4f897 Merge pull request #421 from mayoljonathan/master 7 gadi atpakaļ
lib 2b1a32479d changes RTCPeerConnection iceServers url property to urls 6 gadi atpakaļ
test 00e59f60be Make exports browserify compatible 11 gadi atpakaļ
.gitignore 81f3429c7c Add dist back 10 gadi atpakaļ
.npmignore 00e59f60be Make exports browserify compatible 11 gadi atpakaļ
Gruntfile.js 37016f06aa Better to avoid 'compress' option at all to keep it behave as by default 9 gadi atpakaļ
LICENSE fc7c88d3e3 Update LICENSE 10 gadi atpakaļ
Makefile 00e59f60be Make exports browserify compatible 11 gadi atpakaļ
README.md 7734918776 Update README.md 7 gadi atpakaļ
changelog.md aa281474cf 0.3.14 10 gadi atpakaļ
index.d.ts 8b53ea2cbd Upgrade type definitions for TypeScript 3 6 gadi atpakaļ
package-lock.json b1d9252966 Revert for PL 7 gadi atpakaļ
package.json 8b53ea2cbd Upgrade type definitions for TypeScript 3 6 gadi atpakaļ

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

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.