Gathering detailed insights and metrics for @vandeurenglenn/simple-peer
Gathering detailed insights and metrics for @vandeurenglenn/simple-peer
📡 Simple WebRTC video, voice, and data channels
11.0.3
MIT
JavaScript
81.85 kB
Installations
npm install @vandeurenglenn/simple-peerDeveloper Guide
BETA
Typescript
No
Module System
ESM
Node Version
20.8.0
NPM Version
10.1.0
Releases
Unable to fetch releases
Languages
3
JavaScript
TypeScript
HTML
JavaScript (51.33%)
TypeScript (43.2%)
HTML (5.48%)
Developer
vandeurenglenn
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
1,112 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Dec 26, 2023
Maintainers
1
Package Meta Information
Latest Version
11.0.3
Package Id
@vandeurenglenn/simple-peer@11.0.3
Unpacked Size
81.85 kB
Size
20.33 kB
File Count
9
NPM Version
10.1.0
Node Version
20.8.0
Published on
Dec 27, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
simple-peer 
Simple WebRTC video, voice, and data channels
why not just use simple-peer?
- no need to use stream api, uses builtin randomUUID etc -> like 80kb lighter
- all browser/ node compatible (for real) no browserify needed
- builtin chunker (messages are best send in chunks when their sizes are bigger then 16kb)
features
-
concise, node.js style API for WebRTC
-
works in node and the browser!
-
supports video/voice streams
-
supports data channel
- text and binary data
- node.js duplex stream interface
-
supports advanced options like:
- enable/disable trickle ICE candidates
- manually set config options
- transceivers and renegotiation
install
npm install simple-peer
This package works in the browser with browserify. If
you do not use a bundler, you can use the simplepeer.min.js standalone script
directly in a <script> tag. This exports a SimplePeer constructor on
window. Wherever you see Peer in the examples below, substitute that with
SimplePeer.
usage
Let's create an html page that lets you manually connect two peers:
1<html> 2 <body> 3 <style> 4 #outgoing { 5 width: 600px; 6 word-wrap: break-word; 7 white-space: normal; 8 } 9 </style> 10 <form> 11 <textarea id="incoming"></textarea> 12 <button type="submit">submit</button> 13 </form> 14 <pre id="outgoing"></pre> 15 <script src="simplepeer.min.js"></script> 16 <script> 17 const p = new SimplePeer({ 18 initiator: location.hash === '#1', 19 trickle: false 20 }) 21 22 p.on('error', (err) => console.log('error', err)) 23 24 p.on('signal', (data) => { 25 console.log('SIGNAL', JSON.stringify(data)) 26 document.querySelector('#outgoing').textContent = JSON.stringify(data) 27 }) 28 29 document.querySelector('form').addEventListener('submit', (ev) => { 30 ev.preventDefault() 31 p.signal(JSON.parse(document.querySelector('#incoming').value)) 32 }) 33 34 p.on('connect', () => { 35 console.log('CONNECT') 36 p.send('whatever' + Math.random()) 37 }) 38 39 p.on('data', (data) => { 40 console.log('data: ' + data) 41 }) 42 </script> 43 </body> 44</html>
Visit index.html#1 from one browser (the initiator) and index.html from another
browser (the receiver).
An "offer" will be generated by the initiator. Paste this into the receiver's form and hit submit. The receiver generates an "answer". Paste this into the initiator's form and hit submit.
Now you have a direct P2P connection between two browsers!
A simpler example
This example create two peers in the same web page.
In a real-world application, you would never do this. The sender and receiver Peer
instances would exist in separate browsers. A "signaling server" (usually implemented with
websockets) would be used to exchange signaling data between the two browsers until a
peer-to-peer connection is established.
data channels
1var Peer = require('simple-peer') 2 3var peer1 = new Peer({ initiator: true }) 4var peer2 = new Peer() 5 6peer1.on('signal', (data) => { 7 // when peer1 has signaling data, give it to peer2 somehow 8 peer2.signal(data) 9}) 10 11peer2.on('signal', (data) => { 12 // when peer2 has signaling data, give it to peer1 somehow 13 peer1.signal(data) 14}) 15 16peer1.on('connect', () => { 17 // wait for 'connect' event before using the data channel 18 peer1.send('hey peer2, how is it going?') 19}) 20 21peer2.on('data', (data) => { 22 // got a data channel message 23 console.log('got a message from peer1: ' + data) 24})
video/voice
Video/voice is also super simple! In this example, peer1 sends video to peer2.
1var Peer = require('simple-peer') 2 3// get video/voice stream 4navigator.mediaDevices 5 .getUserMedia({ 6 video: true, 7 audio: true 8 }) 9 .then(gotMedia) 10 .catch(() => {}) 11 12function gotMedia(stream) { 13 var peer1 = new Peer({ initiator: true, stream: stream }) 14 var peer2 = new Peer() 15 16 peer1.on('signal', (data) => { 17 peer2.signal(data) 18 }) 19 20 peer2.on('signal', (data) => { 21 peer1.signal(data) 22 }) 23 24 peer2.on('stream', (stream) => { 25 // got remote video stream, now let's show it in a video tag 26 var video = document.querySelector('video') 27 28 if ('srcObject' in video) { 29 video.srcObject = stream 30 } else { 31 video.src = window.URL.createObjectURL(stream) // for older browsers 32 } 33 34 video.play() 35 }) 36}
For two-way video, simply pass a stream option into both Peer constructors. Simple!
Please notice that getUserMedia only works in pages loaded via https.
dynamic video/voice
It is also possible to establish a data-only connection at first, and later add a video/voice stream, if desired.
1var Peer = require('simple-peer') // create peer without waiting for media 2 3var peer1 = new Peer({ initiator: true }) // you don't need streams here 4var peer2 = new Peer() 5 6peer1.on('signal', (data) => { 7 peer2.signal(data) 8}) 9 10peer2.on('signal', (data) => { 11 peer1.signal(data) 12}) 13 14peer2.on('stream', (stream) => { 15 // got remote video stream, now let's show it in a video tag 16 var video = document.querySelector('video') 17 18 if ('srcObject' in video) { 19 video.srcObject = stream 20 } else { 21 video.src = window.URL.createObjectURL(stream) // for older browsers 22 } 23 24 video.play() 25}) 26 27function addMedia(stream) { 28 peer1.addStream(stream) // <- add streams to peer dynamically 29} 30 31// then, anytime later... 32navigator.mediaDevices 33 .getUserMedia({ 34 video: true, 35 audio: true 36 }) 37 .then(addMedia) 38 .catch(() => {})
in node
To use this library in node, pass in opts.wrtc as a parameter (see the constructor options):
1var Peer = require('simple-peer') 2var wrtc = require('wrtc') 3 4var peer1 = new Peer({ initiator: true, wrtc: wrtc }) 5var peer2 = new Peer({ wrtc: wrtc })
api
peer = new Peer([opts])
Create a new WebRTC peer connection.
A "data channel" for text/binary communication is always established, because it's cheap and often useful. For video/voice communication, pass the stream option.
If opts is specified, then the default options (shown below) will be overridden.
{
initiator: false,
channelConfig: {},
channelName: '<random string>',
config: { iceServers: [{ urls: 'stun:stun.l.google.com:19302' }, { urls: 'stun:global.stun.twilio.com:3478?transport=udp' }] },
offerOptions: {},
answerOptions: {},
sdpTransform: function (sdp) { return sdp },
stream: false,
streams: [],
trickle: true,
allowHalfTrickle: false,
wrtc: {}, // RTCPeerConnection/RTCSessionDescription/RTCIceCandidate
objectMode: false
}
The options do the following:
-
initiator- set totrueif this is the initiating peer -
channelConfig- custom webrtc data channel configuration (used bycreateDataChannel) -
channelName- custom webrtc data channel name -
config- custom webrtc configuration (used byRTCPeerConnectionconstructor) -
offerOptions- custom offer options (used bycreateOffermethod) -
answerOptions- custom answer options (used bycreateAnswermethod) -
sdpTransform- function to transform the generated SDP signaling data (for advanced users) -
stream- if video/voice is desired, pass stream returned fromgetUserMedia -
streams- an array of MediaStreams returned fromgetUserMedia -
trickle- set tofalseto disable trickle ICE and get a single 'signal' event (slower) -
wrtc- custom webrtc implementation, mainly useful in node to specify in the wrtc package. Contains an object with the properties: -
objectMode- set totrueto create the stream in Object Mode. In this mode, incoming string data is not automatically converted toBufferobjects.
peer.signal(data)
Call this method whenever the remote peer emits a peer.on('signal') event.
The data will encapsulate a webrtc offer, answer, or ice candidate. These messages help
the peers to eventually establish a direct connection to each other. The contents of these
strings are an implementation detail that can be ignored by the user of this module;
simply pass the data from 'signal' events to the remote peer and call peer.signal(data)
to get connected.
peer.send(data)
Send text/binary data to the remote peer. data can be any of several types: String,
Buffer (see buffer), ArrayBufferView (Uint8Array,
etc.), ArrayBuffer, or Blob (in browsers that support it).
Note: If this method is called before the peer.on('connect') event has fired, then an exception will be thrown. Use peer.write(data) (which is inherited from the node.js duplex stream interface) if you want this data to be buffered instead.
peer.addStream(stream)
Add a MediaStream to the connection.
peer.removeStream(stream)
Remove a MediaStream from the connection.
peer.addTrack(track, stream)
Add a MediaStreamTrack to the connection. Must also pass the MediaStream you want to attach it to.
peer.removeTrack(track, stream)
Remove a MediaStreamTrack from the connection. Must also pass the MediaStream that it was attached to.
peer.replaceTrack(oldTrack, newTrack, stream)
Replace a MediaStreamTrack with another track. Must also pass the MediaStream that the old track was attached to.
peer.addTransceiver(kind, init)
Add a RTCRtpTransceiver to the connection. Can be used to add transceivers before adding tracks. Automatically called as neccesary by addTrack.
peer.destroy([err])
Destroy and cleanup this peer connection.
If the optional err parameter is passed, then it will be emitted as an 'error'
event on the stream.
Peer.WEBRTC_SUPPORT
Detect native WebRTC support in the javascript environment.
1var Peer = require('simple-peer') 2 3if (Peer.WEBRTC_SUPPORT) { 4 // webrtc support! 5} else { 6 // fallback 7}
duplex stream
Peer objects are instances of stream.Duplex. They behave very similarly to a
net.Socket from the node core net module. The duplex stream reads/writes to the data
channel.
1var peer = new Peer(opts) 2// ... signaling ... 3peer.write(new Buffer('hey')) 4peer.on('data', function (chunk) { 5 console.log('got a chunk', chunk) 6})
events
Peer objects are instance of EventEmitter. Take a look at the nodejs events documentation for more information.
Example of removing all registered close-event listeners:
1peer.removeAllListeners('close')
peer.on('signal', data => {})
Fired when the peer wants to send signaling data to the remote peer.
It is the responsibility of the application developer (that's you!) to get this data to
the other peer. This usually entails using a websocket signaling server. This data is an
Object, so remember to call JSON.stringify(data) to serialize it first. Then, simply
call peer.signal(data) on the remote peer.
(Be sure to listen to this event immediately to avoid missing it. For initiator: true
peers, it fires right away. For initatior: false peers, it fires when the remote
offer is received.)
peer.on('connect', () => {})
Fired when the peer connection and data channel are ready to use.
peer.on('data', data => {})
Received a message from the remote peer (via the data channel).
data will be either a String or a Buffer/Uint8Array (see buffer).
peer.on('stream', stream => {})
Received a remote video stream, which can be displayed in a video tag:
1peer.on('stream', (stream) => { 2 var video = document.querySelector('video') 3 if ('srcObject' in video) { 4 video.srcObject = stream 5 } else { 6 video.src = window.URL.createObjectURL(stream) 7 } 8 video.play() 9})
peer.on('track', (track, stream) => {})
Received a remote audio/video track. Streams may contain multiple tracks.
peer.on('close', () => {})
Called when the peer connection has closed.
peer.on('error', (err) => {})
Fired when a fatal error occurs. Usually, this means bad signaling data was received from the remote peer.
err is an Error object.
error codes
Errors returned by the error event have an err.code property that will indicate the origin of the failure.
Possible error codes:
ERR_WEBRTC_SUPPORTERR_CREATE_OFFERERR_CREATE_ANSWERERR_SET_LOCAL_DESCRIPTIONERR_SET_REMOTE_DESCRIPTIONERR_ADD_ICE_CANDIDATEERR_ICE_CONNECTION_FAILUREERR_SIGNALINGERR_DATA_CHANNELERR_CONNECTION_FAILURE
connecting more than 2 peers?
The simplest way to do that is to create a full-mesh topology. That means that every peer opens a connection to every other peer. To illustrate:
To broadcast a message, just iterate over all the peers and call peer.send.
So, say you have 3 peers. Then, when a peer wants to send some data it must send it 2 times, once to each of the other peers. So you're going to want to be a bit careful about the size of the data you send.
Full mesh topologies don't scale well when the number of peers is very large. The total
number of edges in the network will be 
where n is the number of peers.
For clarity, here is the code to connect 3 peers together:
Peer 1
1// These are peer1's connections to peer2 and peer3 2var peer2 = new Peer({ initiator: true }) 3var peer3 = new Peer({ initiator: true }) 4 5peer2.on('signal', (data) => { 6 // send this signaling data to peer2 somehow 7}) 8 9peer2.on('connect', () => { 10 peer2.send('hi peer2, this is peer1') 11}) 12 13peer2.on('data', (data) => { 14 console.log('got a message from peer2: ' + data) 15}) 16 17peer3.on('signal', (data) => { 18 // send this signaling data to peer3 somehow 19}) 20 21peer3.on('connect', () => { 22 peer3.send('hi peer3, this is peer1') 23}) 24 25peer3.on('data', (data) => { 26 console.log('got a message from peer3: ' + data) 27})
Peer 2
1// These are peer2's connections to peer1 and peer3 2var peer1 = new Peer() 3var peer3 = new Peer({ initiator: true }) 4 5peer1.on('signal', (data) => { 6 // send this signaling data to peer1 somehow 7}) 8 9peer1.on('connect', () => { 10 peer1.send('hi peer1, this is peer2') 11}) 12 13peer1.on('data', (data) => { 14 console.log('got a message from peer1: ' + data) 15}) 16 17peer3.on('signal', (data) => { 18 // send this signaling data to peer3 somehow 19}) 20 21peer3.on('connect', () => { 22 peer3.send('hi peer3, this is peer2') 23}) 24 25peer3.on('data', (data) => { 26 console.log('got a message from peer3: ' + data) 27})
Peer 3
1// These are peer3's connections to peer1 and peer2 2var peer1 = new Peer() 3var peer2 = new Peer() 4 5peer1.on('signal', (data) => { 6 // send this signaling data to peer1 somehow 7}) 8 9peer1.on('connect', () => { 10 peer1.send('hi peer1, this is peer3') 11}) 12 13peer1.on('data', (data) => { 14 console.log('got a message from peer1: ' + data) 15}) 16 17peer2.on('signal', (data) => { 18 // send this signaling data to peer2 somehow 19}) 20 21peer2.on('connect', () => { 22 peer2.send('hi peer2, this is peer3') 23}) 24 25peer2.on('data', (data) => { 26 console.log('got a message from peer2: ' + data) 27})
memory usage
If you call peer.send(buf), simple-peer is not keeping a reference to buf
and sending the buffer at some later point in time. We immediately call
channel.send() on the data channel. So it should be fine to mutate the buffer
right afterward.
However, beware that peer.write(buf) (a writable stream method) does not have
the same contract. It will potentially buffer the data and call
channel.send() at a future point in time, so definitely don't assume it's
safe to mutate the buffer.
connection does not work on some networks?
If a direct connection fails, in particular, because of NAT traversal and/or firewalls, WebRTC ICE uses an intermediary (relay) TURN server. In other words, ICE will first use STUN with UDP to directly connect peers and, if that fails, will fall back to a TURN relay server.
In order to use a TURN server, you must specify the config option to the Peer
constructor. See the API docs above.
license
MIT. Copyright (c) Feross Aboukhadijeh.
MIT. Copyright (c) 2023 Vandeuren Glenn.
No vulnerabilities found.
No security vulnerabilities found.