Code autogenerated from Kurento/doc-kurento@99e4e20

Kurento · May 12, 2022 · a994f99 · a994f99
1 parent deba8b6
commit a994f99
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 25 deletions.
diff --git a/Makefile b/Makefile
@@ -40,10 +40,6 @@ help:
 	@echo "- texlive-fonts-recommended"
 	@echo "- texlive-latex-recommended"
 	@echo "- texlive-latex-extra"
-	@echo ""
-	@echo "python pip dependencies:"
-	@echo "- sphinx >= 1.5.0 (Tested: 3.3.0)"
-	@echo "- sphinx_rtd_theme  (Tested: 0.5.0)"
 
 init-workdir:
 	mkdir -p $(WORKDIR)

diff --git a/requirements.txt b/requirements.txt
@@ -11,4 +11,13 @@
 
 Sphinx==4.5.0
 sphinx-rtd-theme==1.0.0
-sphinxcontrib-video==0.0.1.dev3
+
+# Sphinx extension "sphinxcontrib.video"
+# https://github.com/sphinx-contrib/video
+#sphinxcontrib-video==0.0.1.dev3
+# However, the extension is unmaintained and lacks some features, such as
+# support for Latex (that we use to generate PDF).
+# A fork exists here with needed fixes:
+# https://github.com/DavidPowell/video
+wheel
+git+https://github.com/DavidPowell/video.git@681dc0c522a66358428fcda83034fac054c37057
diff --git a/source/project/relnotes/v6_18_0.rst b/source/project/relnotes/v6_18_0.rst
@@ -89,7 +89,8 @@ Several object classes contained a ``timestamp`` field, which wasn't fine-graine
 These classes are ``Stats`` (common parent of all Stats classes), and ``RaiseBase`` (common parent of all ``Event`` classes).
 
 * Old: ``timestamp`` - Seconds elapsed since the UNIX Epoch (Jan 1, 1970, UTC)
-* New: ``timestampMillis`` - Milliseconds elapsed since the UNIX Epoch (Jan 1, 1970, UTC)
+
+  New: ``timestampMillis`` - Milliseconds elapsed since the UNIX Epoch (Jan 1, 1970, UTC)
 
 
 
@@ -106,21 +107,25 @@ Media Events
 A series of deprecations and renamings that normalize all events into the same naming convention.
 
 * Old: ``MediaFlowOutStateChange`` event
-* New: ``MediaFlowOutStateChanged`` event
+
+  New: ``MediaFlowOutStateChanged`` event
 
 * Old: ``MediaFlowInStateChange`` event
-* New: ``MediaFlowInStateChanged`` event
+
+  New: ``MediaFlowInStateChanged`` event
 
 * Old: ``MediaTranscodingStateChange`` event
-* New: ``MediaTranscodingStateChanged`` event
+
+  New: ``MediaTranscodingStateChanged`` event
 
 
 
 childs -> children
 ~~~~~~~~~~~~~~~~~~
 
 * Old: ``MediaObject.getChilds()``
-* New: ``MediaObject.getChildren()``
+
+  New: ``MediaObject.getChildren()``
 
 
 
@@ -130,7 +135,8 @@ setOutputBitrate -> minOutputBitrate, maxOutputBitrate
 All ``MediaElement``-derived classes had a ``setOutputBitrate()`` method that could be used to set a specific target bitrate for the video stream. Instead, use the setters to specify a minimum and maximum desired target. To replicate the same behavior that ``setOutputBitrate()`` had, just provide the same value as both min and max.
 
 * Old: ``setOutputBitrate()``
-* New: ``setMinOutputBitrate()``, ``setMaxOutputBitrate()``
+
+  New: ``setMinOutputBitrate()``, ``setMaxOutputBitrate()``
 
 
 
@@ -140,10 +146,12 @@ minOuputBitrate, maxOuputBitrate -> minOutputBitrate, maxOutputBitrate
 These changes fix a typo in the original property names.
 
 * Old: ``getMinOuputBitrate()``, ``setMinOuputBitrate()``
-* New: ``getMinOutputBitrate()``, ``setMinOutputBitrate()``
+
+  New: ``getMinOutputBitrate()``, ``setMinOutputBitrate()``
 
 * Old: ``getMaxOuputBitrate()``, ``getMaxOuputBitrate()``
-* New: ``setMaxOutputBitrate()``, ``setMaxOutputBitrate()``
+
+  New: ``setMaxOutputBitrate()``, ``setMaxOutputBitrate()``
 
 
 
@@ -156,33 +164,41 @@ ICE Events
 A series of deprecations and renamings that normalize all events into the same naming convention.
 
 * Old: ``OnIceCandidate`` event
-* New: ``IceCandidateFound`` event
+
+  New: ``IceCandidateFound`` event
 
 * Old: ``OnIceGatheringDone`` event
-* New: ``IceGatheringDone`` event
+
+  New: ``IceGatheringDone`` event
 
 * Old: ``OnIceComponentStateChanged``, ``IceComponentStateChange`` events
-* New: ``IceComponentStateChanged`` event
+
+  New: ``IceComponentStateChanged`` event
 
 * Old: ``OnDataChannelOpened``, ``DataChannelOpen`` events
-* New: ``DataChannelOpened`` event
+
+  New: ``DataChannelOpened`` event
 
 * Old: ``OnDataChannelClosed``, ``DataChannelClose`` event
-* New: ``DataChannelClosed`` event
+
+  New: ``DataChannelClosed`` event
 
 
 
 externalAddress -> externalIPv4, externalIPv6
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * Old: ``externalAddress`` setting
-* New: ``externalIPv4``, ``externalIPv6`` settings
+
+  New: ``externalIPv4``, ``externalIPv6`` settings
 
 * Old: ``getExternalAddress()``
-* New: ``getExternalIPv4()``, ``getExternalIPv6()``
+
+  New: ``getExternalIPv4()``, ``getExternalIPv6()``
 
 * Old: ``setExternalAddress()``
-* New: ``setExternalIPv4()``, ``setExternalIPv6()``
+
+  New: ``setExternalIPv4()``, ``setExternalIPv6()``
 
 
 
@@ -192,10 +208,12 @@ IceCandidatePair
 Unifies all Kurento "Id" members under the same naming convention.
 
 * Old: ``streamID``
-* New: ``streamId``
+
+  New: ``streamId``
 
 * Old: ``componentID``
-* New: ``componentId``
+
+  New: ``componentId``
 
 
 
@@ -206,15 +224,17 @@ inputAudioLatency, inputVideoLatency -> inputLatency
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * Old: ``ElementStats.inputAudioLatency``, ``ElementStats.inputVideoLatency`` - Average latency, in nanoseconds.
-* New: ``ElementStats.inputLatency`` - Array of average latencies (``MediaLatencyStat[]``), in nanoseconds.
+
+  New: ``ElementStats.inputLatency`` - Array of average latencies (``MediaLatencyStat[]``), in nanoseconds.
 
 
 
 audioE2ELatency, videoE2ELatency -> E2ELatency
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * Old: ``EndpointStats.audioE2ELatency``, ``EndpointStats.videoE2ELatency`` - End-to-end latency, in nanoseconds.
-* New: ``EndpointStats.E2ELatency`` - Array of average latencies (``MediaLatencyStat[]``), in nanoseconds.
+
+  New: ``EndpointStats.E2ELatency`` - Array of average latencies (``MediaLatencyStat[]``), in nanoseconds.