palavatv / palava-client

Signaling client for WebRTC video-/audio conferencing using the palava protocol

palava | client

palava.tv is a cost-free, simple to use, secure, and open source platform for video calls, built on top of the WebRTC technology.

This repository contains the WebRTC client-side library of palava.tv. There is an overview of all parts of palava.tv at palavatv/palava.

Description

This JavaScript library implements the palava protocol to function together with the signaltower or the palava-machine signaling server. It allows you to create PeerConnections to other browser. It includes the webrtc-adapter project for better WebRTC compatibility.

Setup

npm / yarn

$ npm install palava-client

This will install palava and its dependencies into the node_modules folder.

JS bundle file

Include a direct link to the bundle file (which has all dependencies included) into your HTML:

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

You can get it from here: https://raw.githubusercontent.com/palavatv/palava-client/master/palava.bundle.js

API Docs

• See https://palavatv.github.io/palava-client/

Local Development

Use the yarn link feature:

• Clone this repository and run $ yarn link inside the project folder
• Navigate to palava-web and run $ yarn link palava-client
• Done, everything is properly symlinked now

Compile latest source

• Make sure you have Ruby and Bundler installed (and have run $ bundle install once)
• $ rake bundle
• Rebuild palava-web, for example, by restarting the yarn dev server

Credits

LGPLv3. Part of the palava project.

Copyright (C) 2014-2020 palava e. V.  [e-mail]

Copyright (C) 2013 Jan Lelis          [e-mail]
Copyright (C) 2013 Marius Melzer      [e-mail]
Copyright (C) 2013 Stephan Thamm      [e-mail]
Copyright (C) 2013 Kilian Ulbrich     [e-mail]

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/>.