Code autogenerated from Kurento/doc-kurento@37e4d08

source/features/events.rst

@@ -22,6 +22,8 @@ Some error has occurred. Check the event parameters (such as *description*, *err
 
 
 
+.. _events-mediaelement:
+
 MediaElement events
 ===================
 

source/features/logging.rst

@@ -109,73 +109,75 @@ 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:
 
-- Event MediaFlow{In,Out} state changes
+* **MediaFlowIn**, **MediaFlowOut** state changes, important to know if media is actually flowing between endpoints (see :ref:`events-mediaelement`):
 
   .. code-block:: text
 
      export GST_DEBUG="${GST_DEBUG:-3},KurentoMediaElementImpl:5"
 
-- ICE candidate gathering
+* **WebRTC** related logging:
 
-  .. code-block:: text
+  - SDP Offer/Answer messages:
 
-     export GST_DEBUG="${GST_DEBUG:-3},webrtcendpoint:5,kmswebrtcsession:5,kmsiceniceagent:5"
+    .. code-block:: text
 
-  .. note::
+       export GST_DEBUG="${GST_DEBUG:-3},kmssdpsession:5"
 
-     - 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).
+  - ICE candidate gathering:
 
-- Player
+    .. code-block:: text
 
-  .. code-block:: text
+       export GST_DEBUG="${GST_DEBUG:-3},webrtcendpoint:5,kmswebrtcsession:5,kmsiceniceagent:5"
 
-     export GST_DEBUG="${GST_DEBUG:-3},kmselement:5,playerendpoint:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:5,souphttpsrc:5,*CAPS*:3"
+    .. note::
 
-- Recorder
+       - 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).
 
-  .. code-block:: text
+  - REMB congestion control:
 
-     export GST_DEBUG="${GST_DEBUG:-3},KurentoRecorderEndpointImpl:4,recorderendpoint:5,qtmux:5"
+    .. code-block:: text
 
-- REMB congestion control
+       export GST_DEBUG="${GST_DEBUG:-3},kmsremb:5"
 
-  .. code-block:: text
+    .. note::
+
+       - *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:-3},kmsremb:5"
+* **PlayerEndpoint**:
 
-  .. note::
+  .. code-block:: text
 
-     - *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:-3},kmselement:5,playerendpoint:5,appsrc:4,agnosticbin*:5,uridecodebin:6,rtspsrc:5,souphttpsrc:5,*CAPS*:3"
 
-- RPC calls
+* **RecorderEndpoint**:
 
   .. code-block:: text
 
-     export GST_DEBUG="${GST_DEBUG:-3},KurentoWebSocket*:5"
+     export GST_DEBUG="${GST_DEBUG:-3},KurentoRecorderEndpointImpl:4,recorderendpoint:5,qtmux:5"
 
-- RTP Sync
+* **JSON-RPC** API server calls:
 
   .. code-block:: text
 
-     export GST_DEBUG="${GST_DEBUG:-3},kmsutils:5,rtpsynchronizer:5,rtpsynccontext:5,basertpendpoint:5"
+     export GST_DEBUG="${GST_DEBUG:-3},KurentoWebSocket*:5"
 
-- SDP processing
+* **RTP Synchronization**:
 
   .. code-block:: text
 
-     export GST_DEBUG="${GST_DEBUG:-3},kmssdpsession:5"
+     export GST_DEBUG="${GST_DEBUG:-3},kmsutils:5,rtpsynchronizer:5,rtpsynccontext:5,basertpendpoint:5"
 
-- Transcoding of media
+* **Transcoding of media**:
 
   .. code-block:: text
 
      export GST_DEBUG="${GST_DEBUG:-3},Kurento*:5,agnosticbin*:5"
 
-- Unit tests
+* **Unit tests**:
 
   .. code-block:: text
 

source/features/security.rst

@@ -51,7 +51,8 @@ Configure a Java server to use HTTPS
 
 .. sourcecode:: bash
 
-   mvn -U clean spring-boot:run -Dspring-boot.run.jvmArguments="-Dkms.url=ws://kms_host:kms_port/kurento"
+   mvn -U clean spring-boot:run \
+       -Dspring-boot.run.jvmArguments="-Dkms.url=ws://{KMS_HOST}:8888/kurento"
 
 .. note::
 
@@ -195,7 +196,7 @@ Because self-signed certificates are untrusted by nature, client browsers and se
 
 * **Node applications**: Take a look at this page: `Painless Self Signed Certificates in node.js <https://git.coolaj86.com/coolaj86/ssl-root-cas.js/src/branch/master/Painless-Self-Signed-Certificates-in-node.js.md>`__.
 
-* **Browser JavaScript applications**: Similar to what happens with self-signed certificates used for HTTPS, browsers also require the user to accept a security warning before Secure WebSocket connections can be established. This is done by directly opening the KMS WebSocket URL: https://KMS_HOST:8433/kurento
+* **Browser JavaScript applications**: Similar to what happens with self-signed certificates used for HTTPS, browsers also require the user to accept a security warning before Secure WebSocket connections can be established. This is done by directly opening the KMS WebSocket URL: https://{KMS_HOST}:8433/kurento
 
 
 
@@ -212,13 +213,14 @@ Make sure your application uses a WebSocket URL that starts with ``wss://`` inst
 
   .. code-block:: java
 
-     mvn clean spring-boot:run -Dkms.url="wss://KMS_HOST:8433/kurento"
+     mvn -U clean spring-boot:run \
+         -Dkms.url="wss://{KMS_HOST}:8433/kurento"
 
 * **Node.js**: Launch with the ``ws_uri`` command-line argument. For example:
 
   .. code-block:: js
 
-     npm start -- --ws_uri="wss://KMS_HOST:8433/kurento"
+     npm start -- --ws_uri="wss://{KMS_HOST}:8433/kurento"
 
 * **Browser JavaScript**: Application-specific method. For example, using hardcoded values: