Kurento Utils for Node.js and Browsers
The Kurento Utils project contains a set of reusable components that have been found useful during the development of the WebRTC applications with Kurento.
The source code of this project can be cloned from the GitHub repository.
Be sure to have installed Node.js and [Bower] in your system:
curl -sL https://deb.nodesource.com/setup | sudo bash -sudo apt-get install -y nodejssudo npm install -g bower
To install the library, it's recommended to do that from the NPM repository :
npm install kurento-utils
Alternatively, you can download the code using git and install manually its dependencies:
git clone https://github.com/Kurento/kurento-utils-jscd kurento-utils-jsnpm install
Screen and window sharing depends on the privative module
kurento-browser-extensions. To enable its support, you'll need to install
the package dependency manually or use a
yourself on runtime. If it's not available, when trying to share the screen or
a window content it will throw an exception.
To build the browser version of the library you'll only need to exec the grunt
task runner and they will be generated on the
dist folder. Alternatively,
if you don't have it globally installed, you can run a local copy by executing
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 the NUBOMEDIA research initiative.
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.
Code for other Kurento projects can be found in the GitHub Kurento Group.
News and Website
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.
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.
Before asking for support, please read first the Kurento Netiquette Guidelines