/kurento-room

Kurento room related projects

Primary LanguageJava

Copyright © 2013-2016 Kurento. Licensed under LGPL v2.1 License.

kurento-room

Kurento Room is composed by several modules to offer group communications by means of WebRTC. These modules are:

  • kurento-room-sdk - module that provides a management interface for developers of multimedia conferences (rooms) applications in Java.
  • kurento-room-server - Kurento’s own implementation of server-side room management. It provides a WebSockets API for the communications between room clients and the server.
  • kurento-room-client - Java library that uses WebSockets and JSON-RPC to interact with the Room Server. Can be used to implement the client-side of a room application based on our server.
  • kurento-room-client-js - Javascript library that acts as wrapper for several JS APIs (WebRTC, WebSockets, Kurento Utils). Can be used to implement the client-side of a room application based on our server.
  • kurento-room-test - integration and functionality tests for the room server applications (demo & basic).
  • kurento-room-demo - demonstration project, contains the client-side implementation (HTML, Javascript, graphic resources) and embeds the Room Server to provide the functionality required for group communications.
  • kurento-room-basicapp - lighter demonstration project.

There is extensive documentation on each of these components together with a tutorial based on the Room demo. These docs are generated from a separate Kurento project.

What is Kurento

Kurento is an open source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: http://www.kurento.org.

Kurento is part of FIWARE. For further information on the relationship of FIWARE and Kurento check the Kurento FIWARE Catalog Entry

Kurento is part of the NUBOMEDIA research initiative.

Documentation

The Kurento project provides detailed documentation including tutorials, installation and development guides. A simplified version of the documentation can be found on readthedocs.org. The Open API specification a.k.a. Kurento Protocol is also available on apiary.io.

Source

Code for other Kurento projects can be found in the GitHub Kurento Group.

News and Website

Check the Kurento blog Follow us on Twitter @kurentoms.

Issue tracker

Issues and bug reports should be posted to the GitHub Kurento bugtracker

Licensing and distribution

Software associated to Kurento is provided as open source under GNU Library or "Lesser" General Public License, version 2.1 (LGPL-2.1). Please check the specific terms and conditions linked to this open source license at http://opensource.org/licenses/LGPL-2.1. Please note that software derived as a result of modifying the source code of Kurento software in order to fix a bug or incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise unmodified version of existing software is not considered a derivative work.

Contribution policy

You can contribute to the Kurento community through bug-reports, bug-fixes, new code or new documentation. For contributing to the Kurento community, drop a post to the Kurento Public Mailing List providing full information about your contribution and its value. In your contributions, you must comply with the following guidelines

  • You must specify the specific contents of your contribution either through a detailed bug description, through a pull-request or through a patch.
  • You must specify the licensing restrictions of the code you contribute.
  • For newly created code to be incorporated in the Kurento code-base, you must accept Kurento to own the code copyright, so that its open source nature is guaranteed.
  • You must justify appropriately the need and value of your contribution. The Kurento project has no obligations in relation to accepting contributions from third parties.
  • The Kurento project leaders have the right of asking for further explanations, tests or validations of any code contributed to the community before it being incorporated into the Kurento code-base. You must be ready to addressing all these kind of concerns before having your code approved.

Support

The Kurento project provides community support through the Kurento Public Mailing List and through StackOverflow using the tags kurento and fiware-kurento.

Before asking for support, please read first the Kurento Netiquette Guidelines