Skip to content

Commit

Permalink
Code autogenerated from Kurento/doc-kurento@0e13b69
Browse files Browse the repository at this point in the history
  • Loading branch information
jenkinskurento committed Mar 2, 2021
1 parent 8fa536b commit ad5f575
Show file tree
Hide file tree
Showing 415 changed files with 4,295 additions and 2,216 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ help:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo " langdoc to make JavaDocs and JsDocs of the Kurento Clients"
@echo " dist to make <langdoc html epub latexpdf> and then pack"
@echo " all resulting files as kurento-doc-6.15.1-dev.tgz"
@echo " all resulting files as kurento-doc-6.16.0.tgz"
@echo " readthedocs to make <langdoc> and then copy the results to the"
@echo " Sphinx theme's static folder"
@echo ""
Expand Down Expand Up @@ -63,7 +63,7 @@ langdoc-client-java: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-java.git
cd kurento-java
[ "false" = "true" ] && git checkout "6.15.0"
[ "true" = "true" ] && git checkout "6.16.0"
cd kurento-client || { echo "ERROR: 'cd' failed, ls:"; ls -lA; exit 1; }
mvn --batch-mode --quiet clean package \
-DskipTests || { echo "ERROR: 'mvn clean' failed"; exit 1; }
Expand All @@ -77,7 +77,7 @@ langdoc-client-js: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-client-js.git
cd kurento-client-js
[ "false" = "true" ] && git checkout "6.15.0"
[ "true" = "true" ] && git checkout "6.16.0"
npm install --no-color
node_modules/.bin/grunt --no-color --force jsdoc \
|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }
Expand All @@ -87,7 +87,7 @@ langdoc-utils-js: langdoc-init
cd $(WORKPATH)
git clone https://github.com/Kurento/kurento-utils-js.git
cd kurento-utils-js
[ "false" = "true" ] && git checkout "6.15.0"
[ "true" = "true" ] && git checkout "6.16.0"
npm install --no-color
node_modules/.bin/grunt --no-color --force jsdoc \
|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }
Expand All @@ -96,7 +96,7 @@ langdoc-utils-js: langdoc-init
langdoc: langdoc-client-java langdoc-client-js langdoc-utils-js

dist: langdoc html epub latexpdf
$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.15.1-dev)
$(eval DISTDIR := $(BUILDDIR)/dist/kurento-doc-6.16.0)
mkdir -p $(DISTDIR)
rsync -a $(BUILDDIR)/html $(BUILDDIR)/epub/Kurento.epub \
$(BUILDDIR)/latex/Kurento.pdf $(DISTDIR)
Expand Down
18 changes: 9 additions & 9 deletions VERSIONS.conf.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@
# shellcheck disable=SC2034
declare -A PROJECT_VERSIONS=(
# Version of the documentation itself; it appears in the main menu
[VERSION_DOC]="6.15.1-dev"
[VERSION_DOC]="6.16.0"

# Version of Kurento Media Server
[VERSION_KMS]="6.15.0"
[VERSION_KMS]="6.16.0"

# Version of each Client API SDK
[VERSION_CLIENT_JAVA]="6.15.0"
[VERSION_CLIENT_JS]="6.15.0"
[VERSION_CLIENT_JAVA]="6.16.0"
[VERSION_CLIENT_JS]="6.16.0"

# Version of the JavaScript utils module (kurento-utils-js)
[VERSION_UTILS_JS]="6.15.0"
[VERSION_UTILS_JS]="6.16.0"

# Version of each platform's tutorials
[VERSION_TUTORIAL_JAVA]="6.15.0"
[VERSION_TUTORIAL_JS]="6.15.0"
[VERSION_TUTORIAL_NODE]="6.15.0"
[VERSION_TUTORIAL_JAVA]="6.16.0"
[VERSION_TUTORIAL_JS]="6.16.0"
[VERSION_TUTORIAL_NODE]="6.16.0"

# Indicates if the current state of this code is Release or Nightly.
# If "true", all mentioned repos will be checked out to the corresponding
# versions; otherwise, they will be kept at the default branch (master).
[VERSION_RELEASE]="false"
[VERSION_RELEASE]="true"
)

# If the build is not for a release, then some versions can be set to more
Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
# built documents.

# The short X.Y version.
version = '6.15.1-dev'
version = '6.16.0'

# The full version, including alpha/beta/rc tags.
release = version
Expand Down
2 changes: 1 addition & 1 deletion source/dev/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Stability tests have been also created using Java, and they are contained in the
Tutorials
---------

The documentation of Kurento includes a number of tutorials `tutorials <https://doc-kurento.readthedocs.io/en/latest/user/tutorials.html>`_ which allows to understand Kurento capabilities using ready to be used simple applications. Kurento tutorials have been developed for three technologies: Java, JavaScript, and Node.js. Moreover, for some of the Java tutorials, different E2E tests have been created. These tests are available in the project `kurento-tutorial-test <https://github.com/Kurento/kurento-tutorial-test/>`_. In order to run these tests, Maven should be used:
The documentation of Kurento includes a number of :doc:`tutorials </user/tutorials>` which allows to understand Kurento capabilities using ready to be used simple applications. Kurento tutorials have been developed for three technologies: Java, JavaScript, and Node.js. Moreover, for some of the Java tutorials, different E2E tests have been created. These tests are available in the project `kurento-tutorial-test <https://github.com/Kurento/kurento-tutorial-test/>`_. In order to run these tests, Maven should be used:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion source/dev/writing_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Our Sphinx-based project is hosted in the `doc-kurento <https://github.com/Kuren

* **init-workdir**. This target constitutes the first step to be run before most other targets. Our documentation source files contain substitution keywords in some parts, in the form ``| KEYWORD |``, which is expected to be substituted by some actual value during the generation process. Currently, the only keyword in use is ``VERSION``, which must be expanded to the actual version of the documentation being built.

For example, here is the *VERSION_KMS* keyword when substituted with its final value: ``6.15.0``.
For example, here is the *VERSION_KMS* keyword when substituted with its final value: ``6.16.0``.

.. note::

Expand Down
38 changes: 22 additions & 16 deletions source/features/kurento_client.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
==============
Kurento Client
==============
====================
Client API Reference
====================

Currently, the Kurento project provides implementations of the :doc:`/features/kurento_protocol` for two programming languages: *Java* and *JavaScript*.

In the future, additional Kurento Clients can be created, exposing the same kind of modularity in other languages such as Python, C/C++, PHP, etc.



Kurento Java Client
===================
Java Client
===========

**Kurento Java Client** is a Java SE layer which consumes the Kurento API and exposes its capabilities through a simple-to-use interface based on Java POJOs representing Media Elements and Media Pipelines.
**Kurento Java Client** is a Java SE layer which consumes the Kurento API and exposes its capabilities through a simple-to-use interface based on Java POJOs representing Media Elements and Media Pipelines. Using the Kurento Java Client only requires adding the appropriate dependency to a *Maven* project or to download the corresponding *jar* into the application's *Java Classpath*.

This API is abstract in the sense that all the non-intuitive inherent complexities of the internal Kurento Protocol workings are abstracted and developers do not need to deal with them when creating applications. Using the Kurento Java Client only requires adding the appropriate dependency to a *Maven* project or to download the corresponding *jar* into the application's *Java Classpath*.
* **Reference**: `Kurento Client JavaDoc <../_static/client-javadoc/index.html>`__.

It is important to remark that the Kurento Java Client is a media-plane control API. In other words, its objective is to expose the capability of managing media objects, but it does not provide any signaling plane capabilities.


JavaScript Client
=================

Kurento JavaScript Client
=========================
**Kurento JavaScript Client** is a JavaScript layer which consumes the Kurento API and exposes its capabilities to JavaScript developers. It allow to build *Node.js* and browser-based applications.

**Kurento JavaScript Client** is a JavaScript layer which consumes the Kurento API and exposes its capabilities to JavaScript developers. It allow to build *Node.js* and browser based applications.
* **Reference**: `Kurento Client JsDoc <../_static/client-jsdoc/index.html>`__.



Reference Documentation
=======================
Kurento Js Utils
================

- `Kurento Client JavaDoc <../_static/client-javadoc/index.html>`__
- `Kurento Client JsDoc <../_static/client-jsdoc/index.html>`__
- `Kurento Js Utils <../_static/utils-jsdoc/index.html>`__: a JavaScript utility library aimed to simplify the development of WebRTC applications.
`kurento-utils-js <https://github.com/Kurento/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>`__.

.. warning::

This library is not actively maintained. It was written to simplify the :doc:`Kurento Tutorials </user/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.

* **Reference**: `kurento-utils-js JsDoc <../_static/utils-jsdoc/index.html>`__.
2 changes: 1 addition & 1 deletion source/features/kurento_utils_js.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ How to use it
=============

* **Minified file** - Download the file from
`here <http://builds.openvidu.io/release/6.15.0/js/kurento-utils.min.js>`__.
`here <http://builds.openvidu.io/release/6.16.0/js/kurento-utils.min.js>`__.


* **NPM** - Install and use library in your Node.js files.
Expand Down
4 changes: 2 additions & 2 deletions source/features/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ PlayerEndpoint

.. code-block:: shell
export GST_DEBUG="${GST_DEBUG:-2},KurentoUriEndpointImpl:5,playerendpoint:5,kmselement:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:5,souphttpsrc:5,*CAPS*:3"
export GST_DEBUG="${GST_DEBUG:-2},KurentoUriEndpointImpl:5,uriendpoint:5,playerendpoint:5,kmselement:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:6,souphttpsrc:5,GST_URI:6,*CAPS*:3"
Expand All @@ -95,7 +95,7 @@ RecorderEndpoint

.. code-block:: shell
export GST_DEBUG="${GST_DEBUG:-2},KurentoRecorderEndpointImpl:4,recorderendpoint:5,basemediamuxer:5,qtmux:5,curl*:5"
export GST_DEBUG="${GST_DEBUG:-2},KurentoUriEndpointImpl:5,uriendpoint:5,GST_URI:6,KurentoRecorderEndpointImpl:5,recorderendpoint:5,basemediamuxer:5,qtmux:5,curl*:6"
Expand Down
2 changes: 1 addition & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Information about *development of Kurento itself* is also available:
:maxdepth: 2
:caption: Feature Documentation

/features/kurento_modules
/features/kurento_client
/features/kurento_modules
/features/kurento_protocol
/features/kurento_utils_js
/features/security
Expand Down
1 change: 1 addition & 0 deletions source/langdoc/client-javadoc/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/kurento/client/Filter.html" title="interface in org.kurento.client" target="classFrame"><span class="interfaceName">Filter</span></a></li>
<li><a href="org/kurento/client/FilterType.html" title="enum in org.kurento.client" target="classFrame">FilterType</a></li>
<li><a href="org/kurento/client/Fraction.html" title="class in org.kurento.client" target="classFrame">Fraction</a></li>
<li><a href="org/kurento/client/GapsFixMethod.html" title="enum in org.kurento.client" target="classFrame">GapsFixMethod</a></li>
<li><a href="org/kurento/client/GenericMediaElement.html" title="interface in org.kurento.client" target="classFrame"><span class="interfaceName">GenericMediaElement</span></a></li>
<li><a href="org/kurento/client/GenericMediaElement.Builder.html" title="class in org.kurento.client" target="classFrame">GenericMediaElement.Builder</a></li>
<li><a href="org/kurento/client/GenericMediaEvent.html" title="class in org.kurento.client" target="classFrame">GenericMediaEvent</a></li>
Expand Down
1 change: 1 addition & 0 deletions source/langdoc/client-javadoc/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/kurento/client/Filter.html" title="interface in org.kurento.client"><span class="interfaceName">Filter</span></a></li>
<li><a href="org/kurento/client/FilterType.html" title="enum in org.kurento.client">FilterType</a></li>
<li><a href="org/kurento/client/Fraction.html" title="class in org.kurento.client">Fraction</a></li>
<li><a href="org/kurento/client/GapsFixMethod.html" title="enum in org.kurento.client">GapsFixMethod</a></li>
<li><a href="org/kurento/client/GenericMediaElement.html" title="interface in org.kurento.client"><span class="interfaceName">GenericMediaElement</span></a></li>
<li><a href="org/kurento/client/GenericMediaElement.Builder.html" title="class in org.kurento.client">GenericMediaElement.Builder</a></li>
<li><a href="org/kurento/client/GenericMediaEvent.html" title="class in org.kurento.client">GenericMediaEvent</a></li>
Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -90,7 +90,7 @@ <h2 title="Contents">Contents</h2>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -306,7 +306,7 @@ <h2 title="Contents">Contents</h2>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down
4 changes: 2 additions & 2 deletions source/langdoc/client-javadoc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down Expand Up @@ -191,7 +191,7 @@ <h2>Constant Field Values</h2>
<li><a href="index-all.html">Index</a></li>
<li class="navBarCell1Rev">Help</li>
</ul>
<div class="aboutLanguage"><b>Kurento Client 6.15.1-SNAPSHOT</b></div>
<div class="aboutLanguage"><b>Kurento Client 6.16.0</b></div>
</div>
<div class="subNav">
<ul class="navList">
Expand Down

0 comments on commit ad5f575

Please sign in to comment.