Copyright 2018 Kurento. Licensed under Apache 2.0 License.

Kurento Utils for Node.js and Browsers

⚠️ Warning

This library is not actively maintained. It was written to simplify the Kurento Tutorials and has several shortcomings for more advanced uses.

For real-world applications we recommend to avoid using this library and instead to write your JavaScript code directly against the browser’s WebRTC API.

kurento-utils-js is a browser library that can be used to simplify creation and handling of RTCPeerConnection objects, to control the browser’s WebRTC API.

Installation instructions

Be sure to have installed Node.js and Bower in your system:

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
sudo 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
cd kurento-utils
npm 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 getScreenConstraints function yourself on runtime. If it's not available, when trying to share the screen or a window content it will throw an exception.

Browser

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:

node_modules/.bin/grunt

Acknowledges

• Bertrand CHEVRIER for grunt-jsdoc

About 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: https://kurento.openvidu.io/.

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

Documentation

The Kurento project provides detailed documentation including tutorials, installation and development guides. The Open API specification, also known as Kurento Protocol, is available on apiary.io.

Useful Links

Usage:

• Installation Guide
• Compilation Guide
• Contribution Guide

Issues:

• Bug Tracker
• Support

News:

• Kurento Blog
• Google Groups

Source

All source code belonging to the Kurento project can be found in the Kurento GitHub organization page.

Licensing and distribution

Copyright 2018 Kurento

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.