Skip to content

Commit

Permalink
Code autogenerated from Kurento/doc-kurento@c7d97e0
Browse files Browse the repository at this point in the history
  • Loading branch information
@jenkinskurento
jenkinskurento committed Dec 3, 2020
1 parent 2254600 commit 89df968
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 40 deletions.
14 changes: 7 additions & 7 deletions source/project/relnotes/v6_13_0.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Added

Use this parameter if you know beforehand what will be the external or public IP address of the media server (e.g. because your deployment has an static IP), although keep in mind that some types of networks will still need you to install a TURN server. Best thing to do is to try with this option enabled, and if WebRTC fails, then default to the standard method of installing and configuring Coturn.

Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setExternalAddress>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setExternalAddress>`__.

* **WebRTC**: Add ``networkInterfaces`` to WebRtcEndpoint config & client API.

Expand All @@ -35,13 +35,13 @@ Added

More rationale for this feature can be found here: `Kurento/bugtracker#278 <https://github.com/Kurento/bugtracker/issues/278>`__ (*RFC: Add WebRtcEndpoint.externalIPs configuration parameter*).

Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setNetworkInterfaces-java.lang.String->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__.

* **WebRTC** / **RTP**: Add ``mtu`` to BaseRtpEndpoint config & client API.

Allows configuring the network MTU that Kurento will use for RTP transmissions, in both RtpEndpoint and WebRtcEndpoint. This parameter ends up configured in the GStreamer RTP payloader (``rtpvp8pay``, ``rtph264pay``).

Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html#setMtu-int->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-core_abstracts.BaseRtpEndpoint.html#setMtu>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-core_abstracts.BaseRtpEndpoint.html#setMtu>`__.

* **RTP**: Add support for ``a=rtcp:{Port}`` in SDP messages.

Expand Down Expand Up @@ -81,7 +81,7 @@ Added
log.info("CPU USAGE: {}", sm.getUsedCpu(1000)); // Average CPU usage over 1 second
log.info("RAM USAGE: {}", sm.getUsedMemory()); // Resident memory used by the Kurento process
Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/ServerManager.html#getUsedCpu-int->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-core_abstracts.ServerManager.html#.getUsedCpu>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-core_abstracts.ServerManager.html#.getUsedCpu>`__.



Expand All @@ -102,17 +102,17 @@ Changed

It doesn't make much sense that Kurento purposely limits the incoming bitrate to such a low value. Better leave it to negotiate the best bitrate by using congestion control (REMB).

Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/SdpEndpoint.html#setMaxVideoRecvBandwidth-int->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-core_abstracts.SdpEndpoint.html#setMaxVideoRecvBandwidth>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-core_abstracts.SdpEndpoint.html#setMaxVideoRecvBandwidth>`__.

* **ServerManager**: The client API method ``getUsedMemory()`` now returns **resident (RSS)** instead of **virtual (VSZ)** memory.

Resident memory is a more useful measurement because it tells the physical used memory, which is usually what users want to know about their server. Giving virtual size here wouldn't be of much use, as the server (or any of its libraries) could map a huge area, then not use it, and the reported VSZ would be huge for no real benefit.

RSS gives a good view about how many MB are being used by KMS at any given time. This is also what users check on ``htop`` or ``top`` so see how much memory is used by KMS. However, keep in mind that if you are trying to establish whether Kurento Media Server has a memory leak, then neither ``top`` nor ``ps`` are the right tool for the job; `Valgrind <https://valgrind.org/>`__ is.

Kurento Client API docs: `Java <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/ServerManager.html#getUsedMemory-->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-jsdoc/module-core_abstracts.ServerManager.html#.getUsedMemory>`__.
Kurento Client API docs: `Java <../_static/client-jsdoc/module-core_abstracts.ServerManager.html#.getUsedMemory>`__.

* **Documentation**: Rewritten all the ``{Min,Max}`` bandwidth / bitrate texts for `BaseRtpEndpoint <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html>`__ and `WebRtcEndpoint <https://doc-kurento.readthedocs.io/en/6.13.0/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html>`__.
* **Documentation**: Rewritten all the ``{Min,Max}`` bandwidth / bitrate texts for `BaseRtpEndpoint <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html>`__.

Kurento defaults to a very conservative maximum bitrate for outgoing streams; most applications will want to raise this value, but API documentation was not very clear so these sections needed a good review.

Expand Down
6 changes: 3 additions & 3 deletions source/project/relnotes/v6_13_2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Changed

This is very helpful for writing useful bug reports.

* ``BaseRtpEndpoint``'s event `MediaStateChangedEvent <https://doc-kurento.readthedocs.io/en/6.13.2/_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html>`__ documentation has been rewritten, so now it contains a better explanation of what exactly is reported by this event.
* ``BaseRtpEndpoint``'s event `MediaStateChangedEvent <../_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html>`__ documentation has been rewritten, so now it contains a better explanation of what exactly is reported by this event.

* Media server's Secure WebSocket connections (``wss://`` as opposed to ``ws://``) is now using TLS 1.2 instead of the old TLS 1.0, which has been deprecated by most web browsers.

Expand All @@ -31,7 +31,7 @@ Changed
Fixed
=====

* ``BaseRtpEndpoint``'s method `getMediaState <https://doc-kurento.readthedocs.io/en/6.13.2/_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html#getMediaState-->`__ has been changed to really return the current value of ``MediaState`` (see :ref:`events-basertpendpoint`).
* ``BaseRtpEndpoint``'s method `getMediaState <../_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html#getMediaState-->`__ has been changed to really return the current value of ``MediaState`` (see :ref:`events-basertpendpoint`).

Previously, this method was wrongly returning the current value of a different property: ``MediaFlowIn``.

Expand Down Expand Up @@ -64,7 +64,7 @@ Some of the most relevant changes are:

This change reduces the amount of work that the ICE protocol needs to do when trying to establish WebRTC connections with remote peers, thus having the connectivity tests be much quicker. It also prevents some edge cases where libnice selected a virtual network interface as the best possible candidate, which would have Kurento sending and/or receiving streams in convoluted loopbacks through the local virtual devices.

You can complement this with the ``networkInterfaces`` parameter of WebRtcEndpoint (either with ``/etc/kurento/modules/kurento/WebRtcEndpoint.conf.ini``, `Java <https://doc-kurento.readthedocs.io/en/6.13.2/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setNetworkInterfaces-java.lang.String->`__, or `JavaScript <https://doc-kurento.readthedocs.io/en/6.13.2/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__), which allows to select the exact network interface(s) that Kurento Media Server should use for WebRTC connections.
You can complement this with the ``networkInterfaces`` parameter of WebRtcEndpoint (either with ``/etc/kurento/modules/kurento/WebRtcEndpoint.conf.ini``, `Java <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__), which allows to select the exact network interface(s) that Kurento Media Server should use for WebRTC connections.

* Miscellaneous improvements, such as `connectivity keepalives <https://gitlab.freedesktop.org/libnice/libnice/-/commit/36d7f8141bcab3d4583573a59cdd2b01d7598648>`__, `peer-reflexive candidates <https://gitlab.freedesktop.org/libnice/libnice/-/commit/061c627ea9a772faa9b2ea110a21d9fac58c698a>`__, `memory leaks <https://gitlab.freedesktop.org/libnice/libnice/-/merge_requests/59>`__, and lots of other small fixes.

Expand Down
2 changes: 1 addition & 1 deletion source/project/relnotes/v6_15_0.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ When a WebRTC implementation creates a new SDP Offer in order to negotiate usage

**RecorderEndpoint HTTP docs**.

Client docs (`Java <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/RecorderEndpoint.html>`__, `JavaScript <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.RecorderEndpoint.html>`__) wrongly stated that the HTTP recording mode requires an HTTP server with support for the ``PUT`` method. This was wrong, and now it correctly explains that the HTTP method is ``POST`` in chunked mode (using the HTTP header ``Transfer-Encoding: chunked``).
Client docs (`Java <../_static/client-jsdoc/module-elements.RecorderEndpoint.html>`__) wrongly stated that the HTTP recording mode requires an HTTP server with support for the ``PUT`` method. This was wrong, and now it correctly explains that the HTTP method is ``POST`` in chunked mode (using the HTTP header ``Transfer-Encoding: chunked``).

**GStreamer Merge Request 38**.

Expand Down
16 changes: 8 additions & 8 deletions source/user/configuration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ Read :ref:`faq-stun-needed` to learn about when you might need to use these, and

**Client API**

* Java: `setStunServerAddress <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerAddress-java.lang.String->`__, `setStunServerPort <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerPort-int->`__, `setTurnUrl <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setTurnUrl-java.lang.String->`__.
* JavaScript: `setStunServerAddress <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setStunServerAddress>`__, `setStunServerPort <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setStunServerPort>`__, `setTurnUrl <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setTurnUrl>`__.
* Java: `setStunServerAddress <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setTurnUrl-java.lang.String->`__.
* JavaScript: `setStunServerAddress <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setTurnUrl>`__.



Expand All @@ -95,8 +95,8 @@ To specify the network interface name(s) that KMS should use to communicate from

**Client API**

* Java: `setNetworkInterfaces <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setNetworkInterfaces-java.lang.String->`__.
* JavaScript: `setNetworkInterfaces <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__.
* Java: `setNetworkInterfaces <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setNetworkInterfaces-java.lang.String->`__.
* JavaScript: `setNetworkInterfaces <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setNetworkInterfaces>`__.



Expand Down Expand Up @@ -138,8 +138,8 @@ When this feature is used, all of the Kurento IPv4 and/or IPv6 ICE candidates ar

**Client API**

* Java: `setExternalIPv4 <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setExternalIPv4-java.lang.String->`__.
* JavaScript: `setExternalIPv4 <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setExternalIPv4>`__.
* Java: `setExternalIPv4 <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setExternalIPv4-java.lang.String->`__.
* JavaScript: `setExternalIPv4 <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setExternalIPv4>`__.



Expand All @@ -160,5 +160,5 @@ For the vast majority of use cases it is better to use the default MTU value of

**Client API**

* Java: `setMtu <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html#setMtu-int->`__.
* JavaScript: `setMtu <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-core_abstracts.BaseRtpEndpoint.html#setMtu>`__.
* Java: `setMtu <../_static/client-javadoc/org/kurento/client/BaseRtpEndpoint.html#setMtu-int->`__.
* JavaScript: `setMtu <../_static/client-jsdoc/module-core_abstracts.BaseRtpEndpoint.html#setMtu>`__.
6 changes: 3 additions & 3 deletions source/user/faq.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,8 @@ To configure a :term:`STUN` server or :term:`TURN` relay with Kurento Media Serv
**Client API**

* Java: `setStunServerAddress </_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerAddress-java.lang.String->`__, `setStunServerPort <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerPort-int->`__, `setTurnUrl <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setTurnUrl-java.lang.String->`__.
* JavaScript: `setStunServerAddress <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setStunServerAddress>`__, `setStunServerPort <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setStunServerPort>`__, `setTurnUrl <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setTurnUrl>`__.
* Java: `setStunServerAddress <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerAddress-java.lang.String->`__, `setStunServerPort <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setStunServerPort-int->`__, `setTurnUrl <../_static/client-javadoc/org/kurento/client/WebRtcEndpoint.html#setTurnUrl-java.lang.String->`__.
* JavaScript: `setStunServerAddress <../_static/client-jsdoc/module-elements.WebRtcEndpoint.html#setTurnUrl>`__.

.. note::

Expand Down Expand Up @@ -370,7 +370,7 @@ The equivalent definition for Docker Compose would look like this:
Where are my recordings?
------------------------

A frequent question, by users who are new to Docker, is where the *RecorderEndpoint* files are being stored, because they don't show up anywhere in the host file system. The answer is that KMS is recording files *inside the container's local storage*, in the path defined by the *RecorderEndpoint* constructor (`Java <https://doc-kurento.readthedocs.io/en/latest/_static/client-javadoc/org/kurento/client/RecorderEndpoint.Builder.html#Builder-org.kurento.client.MediaPipeline-java.lang.String->`__, `JavaScript <https://doc-kurento.readthedocs.io/en/latest/_static/client-jsdoc/module-elements.RecorderEndpoint.html#.constructorParams>`__).
A frequent question, by users who are new to Docker, is where the *RecorderEndpoint* files are being stored, because they don't show up anywhere in the host file system. The answer is that KMS is recording files *inside the container's local storage*, in the path defined by the *RecorderEndpoint* constructor (`Java <../_static/client-jsdoc/module-elements.RecorderEndpoint.html#.constructorParams>`__).

In general, running a Docker container **won't modify your host system** and **won't create new files** in it, at least by default. This is an integral part of how Docker containers work. To get those files out, you should use the mechanisms that Docker offers, like for example a `bind-mount <https://docs.docker.com/storage/bind-mounts/>`__ to the recording path.

Expand Down

0 comments on commit 89df968

Please sign in to comment.