Kurento Utils for Node.js and Browsers

:warning: 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:

1curl -sSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
2sudo apt-get install -y nodejs
3sudo npm install -g bower

To install the library, it's recommended to do that from the NPM repository:

1npm install kurento-utils

Alternatively, you can download the code using git and install manually its dependencies:

1git clone https://github.com/Kurento/kurento.git
2cd kurento/browser/kurento-utils-js/
3npm 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:

1node_modules/.bin/grunt

Acknowledges

• Bertrand CHEVRIER for grunt-jsdoc