https://github.com/grabss/peerjs
https://github.com/grabss/peerjs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/grabss/peerjs
- Owner: grabss
- License: mit
- Created: 2020-09-03T04:02:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T08:21:41.000Z (about 5 years ago)
- Last Synced: 2023-12-14T02:30:56.365Z (over 2 years ago)
- Language: TypeScript
- Size: 7.74 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PeerJS: Simple peer-to-peer with WebRTC #
### https://t.me/joinchat/VWI0UBxnG7f7_DV7
[](#backers)
[](#sponsors)
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](https://github.com/peers/peerjs-server).
## Setup
**Include the library**
with npm:
`npm install peerjs`
with yarn:
`yarn add peerjs`
```js
// The usage -
import Peer from 'peerjs';
```
**Create a Peer**
```javascript
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**
```javascript
const conn = peer.connect('another-peers-id');
conn.on('open', () => {
conn.send('hi!');
});
```
**Receive**
```javascript
peer.on('connection', (conn) => {
conn.on('data', (data) => {
// Will print 'hi!'
console.log(data);
});
conn.on('open', () => {
conn.send('hello!');
});
});
```
## Media calls
**Call**
```javascript
navigator.mediaDevices.getUserMedia({video: true, audio: true}, (stream) => {
const call = peer.call('another-peers-id', stream);
call.on('stream', (remoteStream) => {
// Show stream in some element.
});
}, (err) => {
console.error('Failed to get local stream', err);
});
```
**Answer**
```javascript
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 element.
});
}, (err) => {
console.error('Failed to get local stream', err);
});
});
```
## Running tests
```bash
npm test
```
## Browsers support
| [
](http://godban.github.io/browsers-support-badges/)Firefox | [
](http://godban.github.io/browsers-support-badges/)Chrome | [
](http://godban.github.io/browsers-support-badges/)Safari |
| --------- | --------- | --------- |
| last 4 versions| last 4 versions| 12.1+
## Safari
1. 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.
## Links
### [Documentation / API Reference](https://peerjs.com/docs.html)
### [PeerServer](https://github.com/peers/peerjs-server)
### [Discuss PeerJS on our Telegram Channel](https://t.me/joinchat/ENhPuhTvhm8WlIxTjQf7Og)
### [Changelog](https://github.com/peers/peerjs/blob/master/changelog.md)
## Contributors
This project exists thanks to all the people who contribute.
## Backers
Thank you to all our backers! [[Become a backer](https://opencollective.com/peer#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/peer#sponsor)]
## License
PeerJS is licensed under the [MIT License](https://tldrlegal.com/l/mit).