WebRTC client library speaking the palava protocol
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
coffee
.gitignore
.npmignore
CHANGELOG.md
COPYING
COPYING.LESSER
Gemfile
Gemfile.lock
README.md
Rakefile
bower.json
package.json
palava.bundle.js
palava.js
palava.min.js
uglifier_options.json

README.md

palava | client

palava.tv is simplistic video communication with your friends and colleagues from within your web browser. It is build on top of the WebRTC technology. No registration or browser plugin required.

Please see the palava repository for an overview of palava and report issues there.

This is palava's client-side WebRTC library for the browser. It enables you to create PeerConnections to other browsers. It uses the palava protocol to works together with the SignalTower or the PalavaMachine signaling server. The portal is a React web application that makes use of this library.

Setup

palava is written in CoffeeScript. However, if you want to only use it (not hack on it), just use option 1 or 2 to include the compiled JavaScript version:

1) bower

$ bower install palava

This will install palava and its dependencies into a sub directory. Include all (palava, jQuery, eventEmitter) into your source file. For more information on bower, see bower.io.

2) JS bundle file

Include a direct link to the source file into your HTML:

<script src="https://path/to/palava.bundle.js" type="text/javascript"></script>

3) Browserify

See http://browserify.org

4) Sprockets/Middleman

Alternatively, you can directly include the coffee files into your project. See the palava portal for how it is done.

Documentation

The code is annotated and API documentation is generated by Codo.

A minimal example using JQuery is available to illustrate the basic workflow.

You can also take a look at the portal web application to get an example of how you can use this library.

Credits

LGPLv3. Part of the palava project.

Copyright (C) 2013 Jan Lelis          mail@janlelis.de
Copyright (C) 2013 Marius Melzer      marius@rasumi.net
Copyright (C) 2013 Stephan Thamm      stephan@innovailable.eu
Copyright (C) 2013 Kilian Ulbrich     kilian@innovailable.eu
Copyright (C) 2014-2017 palava e. V.  contact@palava.tv

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.