peerjs README

The project's README from github.com/peers/peerjs. As one markdown file: README.md.

PeerJS: Simple peer-to-peer with WebRTC

Backers on Open Collective Sponsors on Open Collective Discord

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.

Special Announcement:

We now have a Discord Channel
There we plan to discuss roadmaps, feature requests, and more
Join us today

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

Browser support

Firefox
Firefox		 Chrome
Chrome		 Safari
Edge		 Safari
Safari
80+ 83+ 83+ 15+

We test PeerJS against these versions of Chrome, Edge, Firefox, and Safari with BrowserStack to ensure compatibility. It may work in other and older browsers, but we don't officially support them. Changes to browser support will be a breaking change going forward.

[!NOTE] Firefox 102+ is required for CBOR / MessagePack support.

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.

Documentation / API Reference

PeerServer

Discuss PeerJS on our Telegram Channel

Changelog

Contributors

This project exists thanks to all the people who 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.

peerjs (peers/peerjs)

Searching Database…

13.5K ·GitHub
Peerjs
Что это такое?PeerJS — это клиентская библиотека для JavaScript/TypeScript, которая оборачивает WebRTC в простой и гибкий API для одноранговой связи (peer-to-peer), поддерживая как каналы данных, так и потоковое аудио и видео.
PeerJS — это библиотека, которую я подключаю в своё веб-приложение, или сервис, который нужно разворачивать?Это клиентская библиотека, которую вы подключаете в веб-приложение (через npm или yarn) — вся одноранговая работа происходит прямо в браузере через WebRTC API.
Как добавить её в проект?Установите через npm ('npm install peerjs') или yarn ('yarn add peerjs'), затем создайте в коде объект Peer, чтобы начать устанавливать соединения.
Нужен ли свой сервер, чтобы пиры могли находить друг друга?Да — установка соединения идёт через PeerServer, отдельный вспомогательный компонент; свой экземпляр такого сервера запускает и живой пример из README. После этого данные и медиа передаются напрямую между пирами.
В каких браузерах это реально заработает?Официально поддерживаются и тестируются через BrowserStack Firefox 80+, Chrome 83+, Edge 83+ и Safari 15+. Другие или более старые браузеры могут работать, но официально не поддерживаются.
А звонки с аудио и видео возможны, или только передача данных?И то, и другое. Поддерживаются каналы данных для сообщений и медиапотоки, причём для медиасоединений предусмотрены отдельные шаги call и answer.
Как выглядит минимальное соединение в коде?Вы создаёте Peer; для соединений по данным затем вызываете connect и приём, а для медиазвонков — call и answer. Именно вокруг этих шагов организован README.
Поддерживается ли структурированный формат данных вроде CBOR или MessagePack?Да — поддержка CBOR и MessagePack встроена, но эта часть требует Firefox 102 или новее.
Есть ли подводные камни при сборке через Webpack?В консоли может появиться сообщение 'Critical dependency: the request of a dependency is an expression'. По словам авторов из FAQ, оно некритичное, связано с Parcel и исчезнет, когда проект перейдёт на Parcel V2.
What are similar projects?samples, WebRTC-Experiment, Piik, webrtc, ffmpeg.wasm, tincan-cli, trystero, react-player
Which topics is it in?communication, webrtc, p2p, real-time, audio, video, browser, web-development, npm, frontend, library, typescript
Creator
peers
Size
10.8 MB
Stars
13.5K
Updated
CommitJul 18Releasev1.5.5Jun 07
Age
13y
Commits · 90 Days