kurento-client-elements - npm Package Compare versions

Comparing version 6.14.0 to 6.15.0

lib/index.js

@@ -29,3 +29,3 @@ /* Autogenerated with Kurento Idl */
 Object.defineProperty(exports, 'name',    {value: 'elements'});
-Object.defineProperty(exports, 'version', {value: '6.14.0'});
+Object.defineProperty(exports, 'version', {value: '6.15.0'});
 
@@ -32,0 +32,0 @@

lib/PlayerEndpoint.js

@@ -297,3 +297,23 @@ /* Autogenerated with Kurento Idl */
  * @property {external:Integer} [networkCache]
- *  When using RTSP sources: Amount of milliseconds to buffer
+ *  RTSP buffer length.
+ *  <p>
+ *    When receiving media from an RTSP source, the streamed video can suffer 
+ *    spikes
+ *    or stuttering, caused by hardware or network issues. Having a reception 
+ *    buffer
+ *    helps alleviate these problems, because it smoothes the stream of incoming
+ *    data to the receiving endpoint.
+ *  </p>
+ *  <p>
+ *    Finding a buffer length that works best for your connection might take 
+ *    some
+ *    tweaking, which can be done with this optional property. Note that a 
+ *    longer
+ *    buffer will be able to fix bigger network spikes, but at the cost of
+ *    introducing more latency to the media playback.
+ *  </p>
+ *  <ul>
+ *    <li>Unit: milliseconds.</li>
+ *    <li>Default: 2000.</li>
+ *  </ul>
  *
@@ -300,0 +320,0 @@ * @property {external:String} uri

lib/RecorderEndpoint.js

@@ -44,6 +44,7 @@ /* Autogenerated with Kurento Idl */
  * @classdesc
- *  Provides the functionality to store contents.
+ *  Provides functionality to store media contents.
  *  <p>
- *    The Recorder can store media in local files or in a network resource. It
- *    receives a media stream from another {@link 
+ *    The RecorderEndpoint can store media in local files or in a network 
+ *    resource.
+ *    It receives a media stream from another {@link 
  *    module:core/abstracts.MediaElement MediaElement} (i.e. the
@@ -69,3 +70,6 @@ *    source), and stores it in the designated location.
  *        <li>
- *          HTTP: Method PUT used against a remote server.
+ *          HTTP: A POST request will be used against a remote server. The 
+ *          server
+ *          must support using the <i>chunked</i> encoding mode (HTTP header
+ *          <code>Transfer-Encoding: chunked</code>).
  *          <ul>
@@ -123,3 +127,4 @@ *            <li><code>http(s)://{server-ip}/path/to/file</code></li>
  *      To save into an HTTP server, the server must be accessible through the
- *      network, and also have the correct access rights.
+ *      network, and also have the correct access rights to the destination 
+ *      path.
  *    </li>
@@ -126,0 +131,0 @@ *  </ul>

lib/WebRtcEndpoint.js

@@ -399,26 +399,30 @@ /* Autogenerated with Kurento Idl */
  * <p>
- *   This setting is normally NOT needed. Only use it if you know what you're
- *   doing, and understand 100% WHY you want it. For the majority of cases, you
- *   should prefer configuring STUN or TURN servers over using this setting.
+ *   Forces all local IPv4 and IPv6 ICE candidates to have the given address. 
+ *   This
+ *   is really nothing more than a hack, but it's very effective to force a 
+ *   public
+ *   IP address when one is known in advance for the media server. In doing so, 
+ *   KMS
+ *   will not need a STUN or TURN server, but remote peers will still be able to
+ *   contact it.
  * </p>
  * <p>
- *   This setting implements a hack that will mangle all local ICE candidates so
- *   that their candidate address is replaced with the provided external 
- *   address,
- *   even for candidates of type 'host'. In doing so, this KMS will not need a
- *   STUN or TURN server, but remote peers will still be able to contact it.
- * </p>
- * <p>
  *   You can try using this setting if KMS is deployed on a publicly accessible
  *   server, without NAT, and with a static public IP address. But if it doesn't
- *   work for you, just go back to using the STUN or TURN settings above.
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
  * </p>
  * <p>
- *   <code>externalAddress</code> is an IPv4 or IPv6 address.
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
  * </p>
+ * <p><code>externalAddress</code> is a single IPv4 or IPv6 address.</p>
  * <p>Examples:</p>
  * <ul>
- *   <li><code>externalAddress=10.70.35.2</code></li>
+ *   <li><code>externalAddress=198.51.100.1</code></li>
  *   <li><code>externalAddress=2001:0db8:85a3:0000:0000:8a2e:0370:7334</code></li>
  * </ul>
+ * @deprecated Use <code>externalIPv4</code> and/or <code>externalIPv6</code> 
+ * instead.
  *
@@ -457,26 +461,30 @@ * @alias module:elements.WebRtcEndpoint#getExternalAddress
  * <p>
- *   This setting is normally NOT needed. Only use it if you know what you're
- *   doing, and understand 100% WHY you want it. For the majority of cases, you
- *   should prefer configuring STUN or TURN servers over using this setting.
+ *   Forces all local IPv4 and IPv6 ICE candidates to have the given address. 
+ *   This
+ *   is really nothing more than a hack, but it's very effective to force a 
+ *   public
+ *   IP address when one is known in advance for the media server. In doing so, 
+ *   KMS
+ *   will not need a STUN or TURN server, but remote peers will still be able to
+ *   contact it.
  * </p>
  * <p>
- *   This setting implements a hack that will mangle all local ICE candidates so
- *   that their candidate address is replaced with the provided external 
- *   address,
- *   even for candidates of type 'host'. In doing so, this KMS will not need a
- *   STUN or TURN server, but remote peers will still be able to contact it.
- * </p>
- * <p>
  *   You can try using this setting if KMS is deployed on a publicly accessible
  *   server, without NAT, and with a static public IP address. But if it doesn't
- *   work for you, just go back to using the STUN or TURN settings above.
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
  * </p>
  * <p>
- *   <code>externalAddress</code> is an IPv4 or IPv6 address.
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
  * </p>
+ * <p><code>externalAddress</code> is a single IPv4 or IPv6 address.</p>
  * <p>Examples:</p>
  * <ul>
- *   <li><code>externalAddress=10.70.35.2</code></li>
+ *   <li><code>externalAddress=198.51.100.1</code></li>
  *   <li><code>externalAddress=2001:0db8:85a3:0000:0000:8a2e:0370:7334</code></li>
  * </ul>
+ * @deprecated Use <code>externalIPv4</code> and/or <code>externalIPv6</code> 
+ * instead.
  *
@@ -513,2 +521,234 @@ * @alias module:elements.WebRtcEndpoint#setExternalAddress
 /**
+ * External IPv4 address of the media server.
+ * <p>
+ *   Forces all local IPv4 ICE candidates to have the given address. This is 
+ *   really
+ *   nothing more than a hack, but it's very effective to force a public IP 
+ *   address
+ *   when one is known in advance for the media server. In doing so, KMS will 
+ *   not
+ *   need a STUN or TURN server, but remote peers will still be able to contact 
+ *   it.
+ * </p>
+ * <p>
+ *   You can try using this setting if KMS is deployed on a publicly accessible
+ *   server, without NAT, and with a static public IP address. But if it doesn't
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
+ * </p>
+ * <p>
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
+ * </p>
+ * <p><code>externalIPv4</code> is a single IPv4 address.</p>
+ * <p>Example:</p>
+ * <ul>
+ *   <li><code>externalIPv4=198.51.100.1</code></li>
+ * </ul>
+ *
+ * @alias module:elements.WebRtcEndpoint#getExternalIPv4
+ *
+ * @param {module:elements.WebRtcEndpoint~getExternalIPv4Callback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.getExternalIPv4 = function(callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  var usePromise = false;
+  
+  if (callback == undefined) {
+    usePromise = true;
+  }
+  
+  if(!arguments.length) callback = undefined;
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'getExternalIPv4', callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~getExternalIPv4Callback
+ * @param {external:Error} error
+ * @param {external:String} result
+ */
+
+/**
+ * External IPv4 address of the media server.
+ * <p>
+ *   Forces all local IPv4 ICE candidates to have the given address. This is 
+ *   really
+ *   nothing more than a hack, but it's very effective to force a public IP 
+ *   address
+ *   when one is known in advance for the media server. In doing so, KMS will 
+ *   not
+ *   need a STUN or TURN server, but remote peers will still be able to contact 
+ *   it.
+ * </p>
+ * <p>
+ *   You can try using this setting if KMS is deployed on a publicly accessible
+ *   server, without NAT, and with a static public IP address. But if it doesn't
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
+ * </p>
+ * <p>
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
+ * </p>
+ * <p><code>externalIPv4</code> is a single IPv4 address.</p>
+ * <p>Example:</p>
+ * <ul>
+ *   <li><code>externalIPv4=198.51.100.1</code></li>
+ * </ul>
+ *
+ * @alias module:elements.WebRtcEndpoint#setExternalIPv4
+ *
+ * @param {external:String} externalIPv4
+ * @param {module:elements.WebRtcEndpoint~setExternalIPv4Callback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.setExternalIPv4 = function(externalIPv4, callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  //  
+  // checkType('String', 'externalIPv4', externalIPv4, {required: true});
+  //  
+
+  var params = {
+    externalIPv4: externalIPv4
+  };
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'setExternalIPv4', params, callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~setExternalIPv4Callback
+ * @param {external:Error} error
+ */
+
+/**
+ * External IPv6 address of the media server.
+ * <p>
+ *   Forces all local IPv6 ICE candidates to have the given address. This is 
+ *   really
+ *   nothing more than a hack, but it's very effective to force a public IP 
+ *   address
+ *   when one is known in advance for the media server. In doing so, KMS will 
+ *   not
+ *   need a STUN or TURN server, but remote peers will still be able to contact 
+ *   it.
+ * </p>
+ * <p>
+ *   You can try using this setting if KMS is deployed on a publicly accessible
+ *   server, without NAT, and with a static public IP address. But if it doesn't
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
+ * </p>
+ * <p>
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
+ * </p>
+ * <p><code>externalIPv6</code> is a single IPv6 address.</p>
+ * <p>Example:</p>
+ * <ul>
+ *   <li><code>externalIPv6=2001:0db8:85a3:0000:0000:8a2e:0370:7334</code></li>
+ * </ul>
+ *
+ * @alias module:elements.WebRtcEndpoint#getExternalIPv6
+ *
+ * @param {module:elements.WebRtcEndpoint~getExternalIPv6Callback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.getExternalIPv6 = function(callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  var usePromise = false;
+  
+  if (callback == undefined) {
+    usePromise = true;
+  }
+  
+  if(!arguments.length) callback = undefined;
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'getExternalIPv6', callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~getExternalIPv6Callback
+ * @param {external:Error} error
+ * @param {external:String} result
+ */
+
+/**
+ * External IPv6 address of the media server.
+ * <p>
+ *   Forces all local IPv6 ICE candidates to have the given address. This is 
+ *   really
+ *   nothing more than a hack, but it's very effective to force a public IP 
+ *   address
+ *   when one is known in advance for the media server. In doing so, KMS will 
+ *   not
+ *   need a STUN or TURN server, but remote peers will still be able to contact 
+ *   it.
+ * </p>
+ * <p>
+ *   You can try using this setting if KMS is deployed on a publicly accessible
+ *   server, without NAT, and with a static public IP address. But if it doesn't
+ *   work for you, just go back to configuring a STUN or TURN server for ICE.
+ * </p>
+ * <p>
+ *   Only set this parameter if you know what you're doing, and you understand 
+ *   100%
+ *   WHY you need it. For the majority of cases, you should just prefer to
+ *   configure a STUN or TURN server.
+ * </p>
+ * <p><code>externalIPv6</code> is a single IPv6 address.</p>
+ * <p>Example:</p>
+ * <ul>
+ *   <li><code>externalIPv6=2001:0db8:85a3:0000:0000:8a2e:0370:7334</code></li>
+ * </ul>
+ *
+ * @alias module:elements.WebRtcEndpoint#setExternalIPv6
+ *
+ * @param {external:String} externalIPv6
+ * @param {module:elements.WebRtcEndpoint~setExternalIPv6Callback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.setExternalIPv6 = function(externalIPv6, callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  //  
+  // checkType('String', 'externalIPv6', externalIPv6, {required: true});
+  //  
+
+  var params = {
+    externalIPv6: externalIPv6
+  };
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'setExternalIPv6', params, callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~setExternalIPv6Callback
+ * @param {external:Error} error
+ */
+
+/**
  * the ICE candidate pair (local and remote candidates) used by the ice library 
@@ -515,0 +755,0 @@ * for each stream.

package.json

 {
   "name": "kurento-client-elements",
-  "version": "6.14.0",
+  "version": "6.15.0",
   "description": "JavaScript Client API for Kurento Media Server",
@@ -5,0 +5,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

232995

increased by5.28%

Lines of code

5197

increased by5.29%

No dependency changes