kurento-utils-js

KO | EN

gitlite — search

#javascript #react #llm #golang #go #machine-learning #deep-learning #cli #kubernetes #vue #security #mcp #ios #open-source

kurento-utils-js

(★ 93)

[UNMAINTAINED][ARCHIVED] Repository moved to the new monorepo: https://github.com/Kurento/kurento

File Explorer

Download Latest Version (.zip)

- set-versions.sh
- browser.js
- index.js
- WebRtcPeer.js
- coveralls
- test
- .gitignore
- _common.js
- bower.json
- index.html
- WebRtcPeer.js
.gitignore
.jsdoc.conf.js
Gruntfile.js
LICENSE
NOTICE
package.json
README.md
README_bower.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![Documentation badge](https://readthedocs.org/projects/fiware-orion/badge/?version=latest)](https://doc-kurento.readthedocs.io)
[![Docker badge](https://img.shields.io/docker/pulls/fiware/orion.svg)](https://hub.docker.com/r/fiware/stream-oriented-kurento/)
[![Support badge](https://img.shields.io/badge/support-sof-yellowgreen.svg)](https://stackoverflow.com/questions/tagged/kurento)

[![][KurentoImage]][Kurento]

[Kurento]: https://kurento.openvidu.io/
[KurentoImage]: https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120
[Apache 2.0 License]: http://www.apache.org/licenses/LICENSE-2.0

Kurento Utils for Node.js and Browsers
======================================

> :warning: **Warning**
>
> This library is not actively maintained. It was written to simplify the [Kurento Tutorials](https://doc-kurento.readthedocs.io/en/latest/user/tutorials.html) 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](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection) objects, to control the browser’s [WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API).

Installation instructions
-------------------------

Be sure to have installed [Node.js](https://nodejs.org/en/) and [Bower](https://bower.io/) in your system:

```bash
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](https://www.npmjs.com/):

```bash
npm install kurento-utils
```

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

```bash
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](https://gruntjs.com) 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:

```bash
node_modules/.bin/grunt
```

Acknowledges
------------

* [Bertrand CHEVRIER](https://github.com/krampstudio) for
  [grunt-jsdoc](https://github.com/krampstudio/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.

[FIWARE]: http://www.fiware.org
[Kurento FIWARE Catalog Entry]: http://catalogue.fiware.org/enablers/stream-oriented-kurento
[NUBOMEDIA]: http://www.nubomedia.eu

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

[documentation]: https://kurento.openvidu.io/documentation
[Open API specification]: http://kurento.github.io/doc-kurento/
[apiary.io]: http://docs.streamoriented.apiary.io/

Useful Links
------------

Usage:

* [Installation Guide](https://doc-kurento.readthedocs.io/en/latest/user/installation.html)
* [Compilation Guide](https://doc-kurento.readthedocs.io/en/latest/dev/dev_guide.html#developing-kms)
* [Contribution Guide](https://doc-kurento.readthedocs.io/en/latest/project/contribute.html)

Issues:

* [Bug Tracker](https://github.com/Kurento/bugtracker/issues)
* [Support](https://doc-kurento.readthedocs.io/en/latest/user/support.html)

News:

* [Kurento Blog](https://kurento.openvidu.io/blog)
* [Google Groups](https://groups.google.com/forum/#!forum/kurento)

Source
------

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

[Kurento GitHub organization page]: https://github.com/Kurento

Licensing and distribution
--------------------------

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.

kurento-utils-js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

kurento-utils-js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README