erizo-api

Node.js module wrapper for Erizo MCU

npm install erizo-api
9 downloads in the last month

ErizoAPI, a Node.js addon wrapper for erizo, the MCU Library for WebRTC

Erizo is a project that aims to implement a library able to communicate with WebRTC (http://www.webrtc.org) browser clients in order to provide advanced communication services. With ErizoAPI you can use easily erizo in your Node.js projects.

Requirements

You must have built erizo in your computer in order to use erizoAPI.
You can find erizo code at http://github.com/ging/erizo

Building Instructions

1- Export the paths to get the source code and the library of erizo:

- Main path to erizo
  export ERIZO_HOME=path/to/erizo
- Path to liberizo.so
  export LD\_LIBRARY\_PATH=path/to/erizo/build/erizo

2- Execute build.sh

Usage

With erizo you can publish and subscribe to WebRTC streams.
First get the erizoAPI module.

    var erizo = require('./path/to/erizoAPI/build/Release/addon');

OneToManyProcessor is the muxer that gets the published stream and sends it to the subscribers. With more than one OneToManyProcessor you can make multiconference services.

    var muxer = new erizo.OneToManyProcessor();        

Also you need a WebRtcConnection for each participant (publisher or subscriber).

    var wrtc = new erizo.WebRtcConnection();

Start the ICE negotiation and check periodically its state (the negotiation is asynchronous). When candidates are gathered (state > 0) set the client SDP.

    wrtc.init();

    var intervarId = setInterval(function() {

        var state = wrtc.getCurrentState();

        if(state > 0) {

            wrtc.setRemoteSdp(remoteSdp);

            var localSdp = wrtc.getLocalSdp();

            //Return localSdp to the client

            clearInterval(intervarId);
        }

    }, 100);

Finally return the local SDP to the client and the connection is stablished.

Note that the way to interchange the SDPs between the client and erizo is out of the scope of this project.

Publishing a stream

To publish a stream add the publisher WebRtcConnection to the OneToManyProcessor

    wrtc.setAudioReceiver(muxer);
    wrtc.setVideoReceiver(muxer);
    muxer.setPublisher(wrtc);

Subscribing to a stream

To subscribe to a stream add a subscriber WebRtcConnection to the OneToManyProcessor. OneToManyProcessor needs an unique peer identifier for each subscriber.

    muxer.addSubscriber(wrtc, peerId);

In order to start correctly the communication send a FIR packet to the publisher. Make sure the ICE state is READY (wrtc.getCurrentState() > 2)

    muxer.sendFIR();                    

Also you can remove a determined subscriber from the muxer

    muxer.removeSubscriber(peerId);                    

License

The MIT License

Copyright (C) 2012 Universidad Politecnica de Madrid.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you