Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The main repo has been moved! star the main branch, not cavedweller's fork!

branch: master

This branch is 0 commits ahead and 0 commits behind master

Merge pull request #1 from ProCynic/patch-1

Update package.json
latest commit c041408b8d
Ben Brittain authored October 06, 2012
Octocat-spinner-32 example update console.logs August 04, 2012
Octocat-spinner-32 lib removed whitespace August 04, 2012
Octocat-spinner-32 .gitignore add gitignore July 24, 2012
Octocat-spinner-32 changed install to mirror dependencies August 04, 2012
Octocat-spinner-32 index.js Restructure the directories August 02, 2012
Octocat-spinner-32 package.json Update package.json October 04, 2012


An abstraction layer for webRTC. Aim is to simplify the HTML5 web standard webRTC in a similar manner to w/ websockets. This project is still in an infintile stage, please send feature requests (or pulls!) to us as well as bug reports.

What is webRTC?

webRTC is a new webstandard being developed for peer-to-peer communication on the web. This means that browsers will be able to send information, without sending information through the server. Server side this will reduce load dramatically.

Currently the webRTC standard is very focused on the video & audio aspects of the project. In the future (hopefully near future!) they will begin implementing the data channel, which will allow arbitrary data to be sent peer-to-peer. For now the webRTC team is focused on stabalizing and optimizing the video and audio channels.

Unfortunately, a server (or two) will still be required for two reasons, The media for the page must be initially supplied, and the server, in conjunction with a STUN server (abstracted away by the library), is required to synchronize the connections.

Browser Support

webRTC is supported in very few browsers. We recommend either chrome from either the dev channel or the canary release. After installation, go to About://flags. Enable

Enable Media Source API on <video> elements. (this may be unnecessary)
Enable MediaStream (this may be unnecessary)
Enable PeerConnection


This is a multi-person chat room demo written using our library. Example Site & Repository (browser support section still applies!)


 npm install 

for absurdly detailed instruction on setting up the demo, go to the demo repo.

Example code


<video id="local" autoplay></video>
<script src="/"></script>
<script src="/"></script>
  rtc.on('ready', function() {
    // all streams are loaded


var io = require('').listen(8000);
// this is a simple wrapper around, so you can define your own events
// like so:
io.sockets.on('connection', function(socket) {
  socket.on('chat', function(nick, message) {
    socket.broadcast.emit('chat', nick, message);

Stumped? on freenode

We've done house calls in the past (also known as walking down the hall)... we'll totally do it again if you fly us out!


@dennismatensson @cavedweller @sarenji

Something went wrong with that request. Please try again.