Code autogenerated from Kurento/doc-kurento@b426163

VERSIONS.conf.sh

@@ -1,14 +1,16 @@
-#!/usr/bin/env bash
+#!/bin/bash
+# (shebang not really needed, but required by ShellCheck)
+# File checked with ShellCheck (https://www.shellcheck.net/)
 
 # This file should be sourced by "configure.sh".
-
+#
 # PROJECT_VERSIONS is a Bash Associative Array. It contains all placeholder
 # names and their values, that get replaced in the documentation sources.
-
+#
 # Normally, KMS is updated faster than other modules, so it is common that
-# e.g. VERSION_KMS is 6.8.5 while most other modules still are at 6.8.0
-# or even older.
+# e.g. VERSION_KMS is 6.8.5 while most other modules still are at 6.8.0.
 
+# shellcheck disable=SC2034
 declare -A PROJECT_VERSIONS=(
     # Version of the documentation itself; it appears in the main menu
     [VERSION_DOC]="6.13.0"
@@ -20,7 +22,7 @@ declare -A PROJECT_VERSIONS=(
     [VERSION_CLIENT_JAVA]="6.13.0"
     [VERSION_CLIENT_JS]="6.13.0"
 
-    # Version of the JavaScript utils module
+    # Version of the JavaScript utils module (kurento-utils-js)
     [VERSION_UTILS_JS]="6.13.0"
 
     # Version of each platform's tutorials
@@ -29,7 +31,18 @@ declare -A PROJECT_VERSIONS=(
     [VERSION_TUTORIAL_NODE]="6.13.0"
 
     # Indicates if the current state of this code is Release or Nightly.
-    # If "true", all dependent repos will be checked out to the corresponding
+    # 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"
 )
+
+# If the build is not a release build, then some versions can be set to more
+# adequate values for each case:
+if [[ "${PROJECT_VERSIONS[VERSION_RELEASE]}" == "true" ]]; then
+    # VERSION_TUTORIAL_{JAVA,JS,NODE} are used in tutorial texts to instruct the
+    # user about running `git checkout <Version>`, so making it "master" will
+    # keep them at the development versions on non-release builds of the docs.
+    PROJECT_VERSIONS[VERSION_TUTORIAL_JAVA]="master"
+    PROJECT_VERSIONS[VERSION_TUTORIAL_JS]="master"
+    PROJECT_VERSIONS[VERSION_TUTORIAL_NODE]="master"
+fi

configure.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+# File checked with ShellCheck (https://www.shellcheck.net/)
 
 #/ Initialization script for Kurento documentation.
 #/
@@ -27,7 +28,7 @@ fi
 
 # Log function
 BASENAME="$(basename "$0")"  # Complete file name
-log() { echo "[${BASENAME}] $*"; }
+log() { echo "[$BASENAME] $*"; }
 
 
 
@@ -59,13 +60,13 @@ for NAME in "${!PROJECT_VERSIONS[@]}"; do
         --binary-files=without-match \
         --recursive \
         --null \
-        "|${NAME}|" "$BASEPATH" \
+        "|$NAME|" "$BASEPATH" \
         | xargs \
             --null \
             --max-lines=1 \
             --no-run-if-empty \
             sed \
-                --in-place --expression="s/|${NAME}|/$VALUE/g"
+                --in-place --expression="s/|$NAME|/$VALUE/g"
 done
 
 log "Done!"

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">
@@ -122,76 +122,33 @@ <h2 title="Interface BaseRtpEndpoint" class="title">Interface BaseRtpEndpoint</h
  </p>
  <ul>
    <li>
-     <strong>ConnectionStateChangedEvent</strong>: This event is raised when the
-     connection between two peers changes. It can have two values:
+     ConnectionStateChangedEvent: This event is raised when the connection
+     between two peers changes. It can have two values:
      <ul>
        <li>CONNECTED</li>
        <li>DISCONNECTED</li>
      </ul>
    </li>
    <li>
-     <strong>MediaStateChangedEvent</strong>: This event provides information
-     about the state of the underlying RTP session.
-     <p>
-       The standard definition of RTP (<a
-         href='https://tools.ietf.org/html/rfc3550'
-         target='_blank'
-         >RFC 3550</a
-       >) describes a session as active whenever there is a maintained flow of
-       RTCP control packets, regardless of whether there is actual media flowing
-       through RTP data packets or not. The reasoning behind this is that, at any
-       given moment, a participant of an RTP session might temporarily stop
-       sending RTP data packets, but this wouldn't necessarily mean that the RTP
-       session as a whole is finished; it maybe just means that the participant
-       has some temporary issues but it will soon resume sending data. For this
-       reason, that an RTP session has really finished is something that is
-       considered only by the prolonged absence of RTCP control packets between
-       participants.
-     </p>
-     <p>
-       Since RTCP packets do not flow at a constant rate (for instance,
-       minimizing a browser window with a WebRTC's
-       <code>RTCPeerConnection</code> object might affect the sending interval),
-       it is not possible to immediately detect their absence and assume that the
-       RTP session has finished. Instead, there is a guard period of
-       approximately <strong>5 seconds</strong> of missing RTCP packets before
-       considering that the underlying RTP session is effectively finished, thus
-       triggering a <code>MediaStateChangedEvent = DISCONNECTED</code> event.
-     </p>
-     <p>
-       In other words, there is always a period during which there might be no
-       media flowing, but this event hasn't been fired yet. Nevertheless, this is
-       the most reliable and useful way of knowing what is the long-term, steady
-       state of RTP media exchange.
-     </p>
-     <p>
-       The <code>ConnectionStateChangedEvent</code> comes in contrast with more
-       instantaneous events such as MediaElement's
-       <code>#MediaFlowInStateChange</code> and
-       <code>#MediaFlowOutStateChange</code>, which are triggered almost
-       immediately after the RTP data packets stop flowing between RTP session
-       participants. This makes the <em>MediaFlow</em> events a good way to
-       know if participants are suffering from short-term intermittent
-       connectivity issues, but they are not enough to know if the connectivity
-       issues are just spurious network hiccups or are part of a more long-term
-       disconnection problem.
-     </p>
-     <p>
-       Possible values are:
-     </p>
+     MediaStateChangedEvent: Based on RTCP packet flow, this event provides more
+     reliable information about the state of media flow. Since RTCP packets are
+     not flowing at a constant rate (minimizing a browser with an
+     RTCPeerConnection might affect this interval, for instance), there is a
+     guard period of about 5s. This traduces in a period where there might be no
+     media flowing, but the event hasn't been fired yet. Nevertheless, this is
+     the most reliable and useful way of knowing what the state of media exchange
+     is. Possible values are:
      <ul>
        <li>CONNECTED: There is an RTCP packet flow between peers.</li>
        <li>
-         DISCONNECTED: Either no RTCP packets have been received yet, or the
-         remote peer has ended the RTP session with a <code>BYE</code> message,
-         or at least 5 seconds have elapsed since the last RTCP packet was
-         received.
+         DISCONNECTED: No RTCP packets have been received, or at least 5s have
+         passed since the last packet arrived.
        </li>
      </ul>
    </li>
  </ul>
  <p>
-   Part of the bandwidth control for the video component of the media session is
+   Part of the bandwidth control of the video component of the media session is
    done here:
  </p>
  <ul>
@@ -1790,7 +1747,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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">

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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-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.13.1-SNAPSHOT</b></div>
+<div class="aboutLanguage"><b>Kurento Client 6.13.2-SNAPSHOT</b></div>
 </div>
 <div class="subNav">
 <ul class="navList">