Code autogenerated from Kurento/doc-kurento@14edfd1

source/features/security.rst

@@ -123,7 +123,7 @@ Securing Kurento Media Server
 Signaling Plane authorization
 -----------------------------
 
-You should protect the JSON-RPC API control port (WebSocket port *8888* by default) of your Kurento Media Server instances from unauthorized access from public networks.
+You should protect the JSON-RPC API control port (WebSocket port, by default TCP 8888) of your Kurento Media Server instances from unauthorized access from public networks.
 
 The Kurento WebSocket server supports using SSL certificates in order to guarantee secure communications between clients and server; however, at the time no authentication mechanism is provided. Kurento doesn't reinvent the wheel here including its own mechanism, and instead it relies on layers of security that already exist at the system level. This is something we may add (contributions are welcomed!) but for now here are some tips on how other big players are protecting KMS from unauthorized use.
 
@@ -143,9 +143,9 @@ If you need more flexibility, one idea is to restrict KMS connections to the sam
 Signaling Plane security (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`.
+With the default configuration, Kurento Media Server will use the ``ws://`` URI scheme for non-secure WebSocket connections, listening on the port TCP 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*.
+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 TCP 8433.
 
 To enable Secure WebSocket, edit the main KMS configuration file (``/etc/kurento/kurento.conf.json``), and un-comment the following lines:
 

source/langdoc/client-javadoc/deprecated-list.html

@@ -145,35 +145,65 @@ <h2 title="Contents">Contents</h2>
 </td>
 </tr>
 <tr class="rowColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress--">org.kurento.client.WebRtcEndpoint.getExternalAddress()</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Continuation-">org.kurento.client.WebRtcEndpoint.getExternalAddress(Continuation&lt;String&gt;)</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Transaction-">org.kurento.client.WebRtcEndpoint.getExternalAddress(Transaction)</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMaxOuputBitrate--">org.kurento.client.MediaElement.getMaxOuputBitrate()</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#maxOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMaxOuputBitrate-org.kurento.client.Continuation-">org.kurento.client.MediaElement.getMaxOuputBitrate(Continuation&lt;Integer&gt;)</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#maxOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMaxOuputBitrate-org.kurento.client.Transaction-">org.kurento.client.MediaElement.getMaxOuputBitrate(Transaction)</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#maxOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMinOuputBitrate--">org.kurento.client.MediaElement.getMinOuputBitrate()</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#minOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMinOuputBitrate-org.kurento.client.Continuation-">org.kurento.client.MediaElement.getMinOuputBitrate(Continuation&lt;Integer&gt;)</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#minOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#getMinOuputBitrate-org.kurento.client.Transaction-">org.kurento.client.MediaElement.getMinOuputBitrate(Transaction)</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#minOutputBitrate</code> instead of this function.</span></div>
 </td>
 </tr>
+<tr class="altColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-">org.kurento.client.WebRtcEndpoint.setExternalAddress(String)</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Continuation-">org.kurento.client.WebRtcEndpoint.setExternalAddress(String, Continuation&lt;Void&gt;)</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Transaction-">org.kurento.client.WebRtcEndpoint.setExternalAddress(String, Transaction)</a>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</td>
+</tr>
 <tr class="rowColor">
 <td class="colOne"><a href="org/kurento/client/MediaElement.html#setMaxOuputBitrate-int-">org.kurento.client.MediaElement.setMaxOuputBitrate(int)</a>
 <div class="block"><span class="deprecationComment">Deprecated due to a typo. Use <code>#maxOutputBitrate</code> instead of this function.</span></div>

source/langdoc/client-javadoc/index-all.html

@@ -1381,15 +1381,45 @@ <h2 class="title">G</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress--">getExternalAddress()</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Get External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Continuation-">getExternalAddress(Continuation&lt;String&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Get External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalAddress-org.kurento.client.Transaction-">getExternalAddress(Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Get External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv4--">getExternalIPv4()</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv4-org.kurento.client.Continuation-">getExternalIPv4(Continuation&lt;String&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv4-org.kurento.client.Transaction-">getExternalIPv4(Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv6--">getExternalIPv6()</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv6 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv6-org.kurento.client.Continuation-">getExternalIPv6(Continuation&lt;String&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv6 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#getExternalIPv6-org.kurento.client.Transaction-">getExternalIPv6(Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Get External IPv6 address of the media server.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/ModuleInfo.html#getFactories--">getFactories()</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/ModuleInfo.html" title="class in org.kurento.client">ModuleInfo</a></dt>
 <dd>
@@ -3873,7 +3903,7 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setAudioFormat-org.kurento.client.AudioCaps-">setAudioFormat(AudioCaps)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
-<div class="block">Sets the type of data for the audio stream.</div>
+<div class="block">Set the type of data for the audio stream.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setAudioFormat-org.kurento.client.AudioCaps-org.kurento.client.Continuation-">setAudioFormat(AudioCaps, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
@@ -3883,7 +3913,7 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setAudioFormat-org.kurento.client.Transaction-org.kurento.client.AudioCaps-">setAudioFormat(Transaction, AudioCaps)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
-<div class="block">Sets the type of data for the audio stream.</div>
+<div class="block">Set the type of data for the audio stream.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/RTCMediaStreamTrackStats.html#setAudioLevel-double-">setAudioLevel(double)</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/RTCMediaStreamTrackStats.html" title="class in org.kurento.client">RTCMediaStreamTrackStats</a></dt>
 <dd>
@@ -4103,15 +4133,45 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-">setExternalAddress(String)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Set External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Continuation-">setExternalAddress(String, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Set External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalAddress-java.lang.String-org.kurento.client.Transaction-">setExternalAddress(String, Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
 <dd>
-<div class="block">Set External IP address of the media server.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <code>externalIPv4</code> and/or <code>externalIPv6</code> instead.</span></div>
+</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv4-java.lang.String-">setExternalIPv4(String)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv4-java.lang.String-org.kurento.client.Continuation-">setExternalIPv4(String, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv4-java.lang.String-org.kurento.client.Transaction-">setExternalIPv4(String, Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv4 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv6-java.lang.String-">setExternalIPv6(String)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv6 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv6-java.lang.String-org.kurento.client.Continuation-">setExternalIPv6(String, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv6 address of the media server.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/kurento/client/WebRtcEndpoint.html#setExternalIPv6-java.lang.String-org.kurento.client.Transaction-">setExternalIPv6(String, Transaction)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/WebRtcEndpoint.html" title="interface in org.kurento.client">WebRtcEndpoint</a></dt>
+<dd>
+<div class="block">Set External IPv6 address of the media server.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/ModuleInfo.html#setFactories-java.util.List-">setFactories(List&lt;String&gt;)</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/ModuleInfo.html" title="class in org.kurento.client">ModuleInfo</a></dt>
 <dd>
@@ -4994,7 +5054,7 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setVideoFormat-org.kurento.client.VideoCaps-">setVideoFormat(VideoCaps)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
-<div class="block">Sets the type of data for the video stream.</div>
+<div class="block">Set the type of data for the video stream.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setVideoFormat-org.kurento.client.VideoCaps-org.kurento.client.Continuation-">setVideoFormat(VideoCaps, Continuation&lt;Void&gt;)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
@@ -5004,7 +5064,7 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/MediaElement.html#setVideoFormat-org.kurento.client.Transaction-org.kurento.client.VideoCaps-">setVideoFormat(Transaction, VideoCaps)</a></span> - Method in interface org.kurento.client.<a href="org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></dt>
 <dd>
-<div class="block">Sets the type of data for the video stream.</div>
+<div class="block">Set the type of data for the video stream.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/kurento/client/RTCIceCandidatePairStats.html#setWritable-boolean-">setWritable(boolean)</a></span> - Method in class org.kurento.client.<a href="org/kurento/client/RTCIceCandidatePairStats.html" title="class in org.kurento.client">RTCIceCandidatePairStats</a></dt>
 <dd>