An abstraction layer for webRTC. Aim is to simplify the HTML5 web standard webRTC in a similar manner to socket.io w/ websockets.
Pull request Compare This branch is 76 commits behind webRTC-io:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
.gitignore
README.md
index.js
package.json

README.md

webRTC.io

An abstraction layer for webRTC. Aim is to simplify the HTML5 web standard webRTC in a similar manner to socket.io 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 webRTC.io library), is required to synchronize the connections.

Demo

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

Installation

$ npm install socket.io
$ npm install webrtc.io

(from here you can clone the demo repo and use the demo, use the example code, or write your own webRTC app!)

Browser Support

webRTC is supported in very few browsers. We recommend either chrome frome 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

Example code

Client

<video id="local" autoplay></video>
<script src="/socket.io/socket.io.js"></script>
<script src="/webrtc.io/webrtc.io.js"></script>
<script>
  rtc.createStream('local');
  rtc.connect('http://yourserveraddress');
  rtc.on('ready', function() {
    // all streams are loaded
  });
</script>

Server

var io = require('webrtc.io').listen(8000);
// this is a simple wrapper around socket.io, 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?

#webrtc.io on freenode