Code autogenerated from Kurento/doc-kurento@735dc02

Kurento · Jul 9, 2020 · c5f4150 · c5f4150
1 parent 089151d
commit c5f4150
Show file tree

Hide file tree

Showing 312 changed files with 671 additions and 683 deletions.
diff --git a/source/features/logging.rst b/source/features/logging.rst
@@ -109,79 +109,67 @@ The **default suggested level** is what KMS sets automatically when it is starte
 
 From that baseline, one can add any other values to extend the amount of information that gets logged:
 
-* **MediaFlowIn**, **MediaFlowOut** state changes, important to know if media is actually flowing between endpoints (see :ref:`events-mediaelement`):
+* **Transcoding of media**:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},KurentoMediaElementImpl:5"
-
-* **WebRTC** related logging:
+     export GST_DEBUG="$GST_DEBUG,Kurento*:5,agnosticbin*:5"
 
-  - SDP Offer/Answer messages:
+* **WebRtcEndpoint** and **RtpEndpoint**:
 
-    .. code-block:: console
-
-       export GST_DEBUG="${GST_DEBUG:-3},kmssdpsession:5"
+  .. code-block:: console
 
-  - ICE candidate gathering:
+     export GST_DEBUG="$GST_DEBUG,KurentoMediaElementImpl:5"
+     export GST_DEBUG="$GST_DEBUG,kmssdpsession:5,sdp*:5"
+     export GST_DEBUG="$GST_DEBUG,webrtcendpoint:5,kmswebrtcsession:5,kmsiceniceagent:5"
 
-    .. code-block:: console
+  A bit of explanation about what is achieved by each logging category:
 
-       export GST_DEBUG="${GST_DEBUG:-3},webrtcendpoint:5,kmswebrtcsession:5,kmsiceniceagent:5"
+  - *KurentoMediaElementImpl* shows *MediaFlowIn* and *MediaFlowOut* state changes, important to know if media is actually flowing between endpoints (see :ref:`events-mediaelement`).
+  - *kmssdpsession* and *sdp** shows messages related to the SDP Offer/Answer negotiations and all of the media handlers.
+  - *webrtcendpoint*, *kmswebrtcsession*, and *kmsiceniceagent* all contain the logic that governs ICE gathering and ICE candidate selection for WebRTC.
 
     .. note::
 
-       - See also :ref:`logging-libnice` to enable advanced logging.
-       - *webrtcendpoint* shows detailed messages from the WebRtcEndpoint (good enough for most cases).
-       - *kmswebrtcsession* shows messages from the internal WebRtcSession class (broarder decision logic).
-       - *kmsiceniceagent* shows messages from the *libnice* Agent (very low-level, probably too verbose for day to day troubleshooting).
+       - See also :ref:`logging-libnice` to enable advanced ICE logging for WebRTC.
 
-  - REMB congestion control:
+  You can also see messages about the REMB congestion control algorithm for WebRTC. However these will constantly be filling the log, so you shouldn't enable them unless explicitly working out an issue with REMB:
 
-    .. code-block:: console
-
-       export GST_DEBUG="${GST_DEBUG:-3},kmsremb:5"
-
-    .. note::
+  .. code-block:: console
 
-       - *kmsremb:5* (debug level 5) shows only effective REMB send/recv values.
-       - *kmsremb:6* (debug level 6) shows full (very verbose) handling of all source SSRCs.
+     export GST_DEBUG="$GST_DEBUG,kmsremb:5"
 
 * **PlayerEndpoint**:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},kmselement:5,playerendpoint:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:5,souphttpsrc:5,*CAPS*:3"
+     export GST_DEBUG="$GST_DEBUG,kmselement:5,playerendpoint:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:5,souphttpsrc:5,*CAPS*:3"
 
 * **RecorderEndpoint**:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},KurentoRecorderEndpointImpl:4,recorderendpoint:5,qtmux:5"
-
-* **JSON-RPC** API server calls:
+     export GST_DEBUG="$GST_DEBUG,basemediamuxer:5,KurentoRecorderEndpointImpl:4,recorderendpoint:5,qtmux:5,curl*:5"
 
-  .. code-block:: console
-
-     export GST_DEBUG="${GST_DEBUG:-3},KurentoWebSocket*:5"
+Other less commonly used logging levels are:
 
 * **RTP Synchronization**:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},kmsutils:5,rtpsynchronizer:5,rtpsynccontext:5,basertpendpoint:5"
+     export GST_DEBUG="$GST_DEBUG,kmsutils:5,rtpsynchronizer:5,rtpsynccontext:5,basertpendpoint:5"
 
-* **Transcoding of media**:
+* **JSON-RPC** API server calls:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},Kurento*:5,agnosticbin*:5"
+     export GST_DEBUG="$GST_DEBUG,KurentoWebSocket*:5"
 
 * **Unit tests**:
 
   .. code-block:: console
 
-     export GST_DEBUG="${GST_DEBUG:-3},check:5,test_base:5"
+     export GST_DEBUG="$GST_DEBUG,check:5,test_base:5"
 
 
 
@@ -213,7 +201,7 @@ Example:
 .. code-block:: console
 
    export G_MESSAGES_DEBUG="libnice,libnice-stun"
-   export GST_DEBUG="${GST_DEBUG:-3},glib:5"
+   export GST_DEBUG="$GST_DEBUG,glib:5"
    /usr/bin/kurento-media-server
 
 You can also set this configuration in the Kurento service settings file, which gets installed at ``/etc/default/kurento-media-server``.

diff --git a/source/features/security.rst b/source/features/security.rst
@@ -2,16 +2,6 @@
 Securing Kurento Applications
 =============================
 
-[TODO full review]
-
-Starting with Chrome 47, WebRTC is only allowed from SECURE ORIGINS (HTTPS or localhost). Check their `release notes <https://groups.google.com/forum/#!topic/discuss-webrtc/sq5CVmY69sc>`__ for further information about this issue.
-
-.. note::
-
-   Keep in mind that serving your application through HTTPS, forces you to use WebSockets Secure (WSS) if you are using websockets to control your application server.
-
-
-
 Securing Application Servers
 ============================
 
@@ -128,11 +118,14 @@ WebRTC requires HTTPS, so your JavaScript application must be served by a secure
 
 
 
-.. _features-security-kms-wss:
-
 Securing Kurento Media Server
 =============================
 
+.. _features-security-kms-wss:
+
+Securing the Signaling Plane (WebSocket)
+----------------------------------------
+
 With the default configuration, Kurento Media Server will use the ``ws://`` URI scheme for non-secure WebSocket connections, listening on the port ``8888``. Application Servers (Kurento clients) will establish a WebSocket connection with KMS, in order to control the media server and send messages conforming to the :doc:`/features/kurento_api`.
 
 This is fine for initial stages of application development, but before deploying on production environments you'll probably want to move to ``wss://`` connections, i.e. using Secure WebSocket, which by default uses the port ``8433``.
@@ -208,6 +201,17 @@ Make sure your application uses a WebSocket URL that starts with ``wss://`` inst
 
 
 
+Securing the Media Plane (WebRTC DTLS)
+--------------------------------------
+
+WebRTC uses DTLS for media data authentication. By default, if no certificate is provided for this, Kurento Media Server will auto-generate its own self-signed certificate for every WebRtcEndpoint instance, but it is also possible to provide an already existing certificate to be used for all endpoints.
+
+To do so, edit the file ``/etc/kurento/modules/kurento/WebRtcEndpoint.conf.ini`` and set either *pemCertificateRSA* or *pemCertificateECDSA* with a file containing the concatenation of your certificate (chain) file(s) and the private key.
+
+Setting a custom certificate for DTLS is needed, for example, for situations where you have to manage multiple media servers and want to make sure that all of them use the same certificate for their connections. Some browsers, such as Firefox, require this in order to allow multiple WebRTC connections from the same tab to different KMS instances.
+
+
+
 .. _features-security-selfsigned:
 
 Generating a self-signed certificate

diff --git a/source/langdoc/client-javadoc/constant-values.html b/source/langdoc/client-javadoc/constant-values.html
@@ -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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/deprecated-list.html b/source/langdoc/client-javadoc/deprecated-list.html
@@ -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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -276,7 +276,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/help-doc.html b/source/langdoc/client-javadoc/help-doc.html
@@ -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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/index-all.html b/source/langdoc/client-javadoc/index-all.html
@@ -39,7 +39,7 @@
 <li class="navBarCell1Rev">Index</li>
 <li><a href="help-doc.html">Help</a></li>
 </ul>
-<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -5489,7 +5489,7 @@ <h2 class="title">Z</h2>
 <li class="navBarCell1Rev">Index</li>
 <li><a href="help-doc.html">Help</a></li>
 </ul>
-<div class="aboutLanguage"><b>Kurento Client 6.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AbstractBuilder.html b/source/langdoc/client-javadoc/org/kurento/client/AbstractBuilder.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -364,7 +364,7 @@ <h4>with</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.Builder.html b/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.Builder.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -279,7 +279,7 @@ <h4>with</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.html b/source/langdoc/client-javadoc/org/kurento/client/AlphaBlending.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -399,7 +399,7 @@ <h4>setPortProperties</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AudioCaps.html b/source/langdoc/client-javadoc/org/kurento/client/AudioCaps.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -297,7 +297,7 @@ <h4>setBitrate</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/AudioCodec.html b/source/langdoc/client-javadoc/org/kurento/client/AudioCodec.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -305,7 +305,7 @@ <h4>valueOf</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/BaseRtpEndpoint.html b/source/langdoc/client-javadoc/org/kurento/client/BaseRtpEndpoint.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -1790,7 +1790,7 @@ <h4>removeConnectionStateChangedListener</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CertificateKeyType.html b/source/langdoc/client-javadoc/org/kurento/client/CertificateKeyType.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -293,7 +293,7 @@ <h4>valueOf</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CodeFoundEvent.html b/source/langdoc/client-javadoc/org/kurento/client/CodeFoundEvent.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -343,7 +343,7 @@ <h4>setValue</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

diff --git a/source/langdoc/client-javadoc/org/kurento/client/CodecConfiguration.html b/source/langdoc/client-javadoc/org/kurento/client/CodecConfiguration.html
@@ -45,7 +45,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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -277,7 +277,7 @@ <h4>setProperties</h4>
 <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.14.0</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.14.1-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">