暫無描述

Alex Sosnovskiy f7e8b50f87 Merge pull request #910 from jsfelix/fix/add-token-type-definition		3 年之前
.github	220197fcda Create FUNDING.yml	5 年之前
dist	d1d22436f4 update dev deps	4 年之前
docs	04866197ee Merge pull request #710 from jasonbarry/docs-util-browser	4 年之前
lib	e6a42beb89 Merge pull request #1 from HarshCasper/deepsource-fix-93544174	4 年之前
test	99906633f1 bugfix #800 bugfix #803 - latest webrtc-adapter	4 年之前
.deepsource.toml	d02b4802f0 Added .deepsource.toml	4 年之前
.gitignore	83f2638886 add extra fields to package.json	5 年之前
LICENSE	fc7c88d3e3 Update LICENSE	10 年之前
README.md	6f651c3a73 Update README.md	4 年之前
changelog.md	cfc37c7988 update changelog	4 年之前
index.d.ts	e7675e1474 fix: add token to PeerJSOption type definition	3 年之前
package-lock.json	829afda314 run `npm audit fix`	3 年之前
package.json	901c46b86a Bump version to 1.3.2	4 年之前
tsconfig.json	a4791aa63a upgrade packages versions	5 年之前
webrtc-adapter.d.ts	dd1f88d84a refactoring	5 年之前

PeerJS: Simple peer-to-peer with WebRTC

https://t.me/joinchat/VWI0UBxnG7f7_DV7

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.

Live Example

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

Setup

Include the library

with npm:

    `npm install peerjs`

with yarn:

    `yarn add peerjs`

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