Aucune description

afrokick 53b23c19bc Bump version to 1.3.0		il y a 5 ans
.github	220197fcda Create FUNDING.yml	il y a 5 ans
dist	72e7c176c8 don't close connection when iceConnectionState changed to disconnected	il y a 5 ans
docs	d1611d8f52 Fix minor spelling error in API docs	il y a 5 ans
lib	b19135cf59 remove unused file	il y a 5 ans
test	237cf737b4 fix tests	il y a 5 ans
.gitignore	83f2638886 add extra fields to package.json	il y a 5 ans
LICENSE	fc7c88d3e3 Update LICENSE	il y a 10 ans
README.md	db40904ec5 update doc	il y a 5 ans
changelog.md	e51282e6e8 change changelog	il y a 5 ans
index.d.ts	ab851f5354 Fix misplace method descriptions in docstring	il y a 5 ans
package-lock.json	53b23c19bc Bump version to 1.3.0	il y a 5 ans
package.json	53b23c19bc Bump version to 1.3.0	il y a 5 ans
tsconfig.json	a4791aa63a upgrade packages versions	il y a 5 ans
webrtc-adapter.d.ts	dd1f88d84a refactoring	il y a 5 ans

PeerJS: Simple peer-to-peer with WebRTC

https://t.me/joinchat/ENhPuhTvhm8WlIxTjQf7Og

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.

Setup

Include the library

with npm:

    `npm install peerjs`
and the usage:

  import Peer from 'peerjs';

Create a Peer

const peer = new Peer('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 = peer.connect('another-peers-id');
conn.on('open', () => {
  conn.send('hi!');
});

Receive

peer.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 = peer.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

peer.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

FirefoxChromeSafari

last 4 versions last 4 versions 12.1+

Safari

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 PeerJS 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.