kurento-client-elements - npm Package Compare versions

Comparing version 6.1.0 to 6.1.1

lib/events.js

@@ -25,2 +25,24 @@ /* Autogenerated with Kurento Idl */
 /**
+ * Notify the destruction of a data channel.
+ *
+ * @event module:elements#OnDataChannelClosed
+ *
+ * @type {module:elements#event:Media}
+ *
+ * @property {external:Integer} channelId
+ *  The channel identifier
+ */
+
+/**
+ * Notify the creation of a new data channel.
+ *
+ * @event module:elements#OnDataChannelOpened
+ *
+ * @type {module:elements#event:Media}
+ *
+ * @property {external:Integer} channelId
+ *  The channel identifier
+ */
+
+/**
  * Notify of a new gathered local candidate.
@@ -27,0 +49,0 @@ *

lib/index.js

@@ -27,3 +27,3 @@ /* Autogenerated with Kurento Idl */
 Object.defineProperty(exports, 'name',    {value: 'elements'});
-Object.defineProperty(exports, 'version', {value: '6.1.0'});
+Object.defineProperty(exports, 'version', {value: '6.1.1'});
 
@@ -30,0 +30,0 @@

lib/WebRtcEndpoint.js

@@ -50,2 +50,4 @@ /* Autogenerated with Kurento Idl */
  *
+ * @fires {@link module:elements#event:OnDataChannelClosed OnDataChannelClosed}
+ * @fires {@link module:elements#event:OnDataChannelOpened OnDataChannelOpened}
  * @fires {@link module:elements#event:OnIceCandidate OnIceCandidate}
@@ -277,2 +279,110 @@ * @fires {@link module:elements#event:OnIceComponentStateChanged OnIceComponentStateChanged}
 /**
+ * Close an opened data channel
+ *
+ * @alias module:elements.WebRtcEndpoint.closeDataChannel
+ *
+ * @param {external:Integer} channelId
+ *  The channel identifier
+ *
+ * @param {module:elements.WebRtcEndpoint~closeDataChannelCallback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.closeDataChannel = function(channelId, callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  checkType('int', 'channelId', channelId, {required: true});
+
+  var params = {
+    channelId: channelId
+  };
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'closeDataChannel', params, callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~closeDataChannelCallback
+ * @param {external:Error} error
+ */
+
+/**
+ * Create a new data channel if data channel are supported
+ *
+ * @alias module:elements.WebRtcEndpoint.createDataChannel
+ *
+ * @param {external:String} [label]
+ *  Channel's label attribute
+ *
+ * @param {external:Boolean} [ordered]
+ *  If the data channel should guarantee order or not
+ *
+ * @param {external:Integer} [maxPacketLifeTime]
+ *  the length of the time window (in milliseconds) during which transmissions 
+ *  and retransmissions may occur in unreliable mode
+ *
+ * @param {external:Integer} [maxRetransmits]
+ *  maximum number of retransmissions that are attempted in unreliable mode
+ *
+ * @param {external:String} [protocol]
+ *  the name of the sub-protocol used
+ *
+ * @param {module:elements.WebRtcEndpoint~createDataChannelCallback} [callback]
+ *
+ * @return {external:Promise}
+ */
+WebRtcEndpoint.prototype.createDataChannel = function(label, ordered, maxPacketLifeTime, maxRetransmits, protocol, callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  callback = arguments[arguments.length-1] instanceof Function
+           ? Array.prototype.pop.call(arguments)
+           : undefined;
+
+  switch(arguments.length){
+    case 0: label = undefined;
+    case 1: ordered = undefined;
+    case 2: maxPacketLifeTime = undefined;
+    case 3: maxRetransmits = undefined;
+    case 4: protocol = undefined;
+    break;
+    case 5: 
+    break;
+
+    default:
+      var error = new RangeError('Number of params ('+arguments.length+') not in range [0-5]');
+          error.length = arguments.length;
+          error.min = 0;
+          error.max = 5;
+
+      throw error;
+  }
+
+  checkType('String', 'label', label);
+  checkType('boolean', 'ordered', ordered);
+  checkType('int', 'maxPacketLifeTime', maxPacketLifeTime);
+  checkType('int', 'maxRetransmits', maxRetransmits);
+  checkType('String', 'protocol', protocol);
+
+  var params = {
+    label: label,
+    ordered: ordered,
+    maxPacketLifeTime: maxPacketLifeTime,
+    maxRetransmits: maxRetransmits,
+    protocol: protocol
+  };
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'createDataChannel', params, callback), this)
+};
+/**
+ * @callback module:elements.WebRtcEndpoint~createDataChannelCallback
+ * @param {external:Error} error
+ */
+
+/**
  * Init the gathering of ICE candidates.
@@ -329,3 +439,3 @@ * It must be called after SdpEndpoint::generateOffer or
  */
-WebRtcEndpoint.events = BaseRtpEndpoint.events.concat(['OnIceCandidate', 'OnIceComponentStateChanged', 'OnIceGatheringDone']);
+WebRtcEndpoint.events = BaseRtpEndpoint.events.concat(['OnDataChannelClosed', 'OnDataChannelOpened', 'OnIceCandidate', 'OnIceComponentStateChanged', 'OnIceGatheringDone']);
 
@@ -332,0 +442,0 @@

package.json

 {
   "name": "kurento-client-elements",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "Elements implementations for kurento media server",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,7 +0,109 @@
-kurento-client-elements
-============
-Elements implementations for kurento media server
+[![][KurentoImage]][Kurento]
 
-This repository host the descriptor file for the [kurento] module elements.
+Copyright © 2013-2016 [Kurento]. Licensed under [LGPL v2.1 License].
 
-[kurento]: http://www.kurento.org
+kurento-client-elements-js
+===============
+
+This repository host the auto-generated JavaScript client for [Kurento] module "elements".
+
+Module "elements" description: Elements implementations for kurento media server
+
+What is Kurento
+---------------
+
+Kurento is an open source software project providing a platform suitable 
+for creating modular applications with advanced real-time communication
+capabilities. For knowing more about Kurento, please visit the Kurento
+project website: http://www.kurento.org.
+
+Kurento is part of [FIWARE]. For further information on the relationship of 
+FIWARE and Kurento check the [Kurento FIWARE Catalog Entry]
+
+Kurento is part of the [NUBOMEDIA] research initiative.
+
+Documentation
+-------------
+
+The Kurento project provides detailed [documentation] including tutorials,
+installation and development guides. A simplified version of the documentation
+can be found on [readthedocs.org]. The [Open API specification] a.k.a. Kurento
+Protocol is also available on [apiary.io].
+
+Source
+------
+
+Code for other Kurento projects can be found in the [GitHub Kurento Group].
+
+News and Website
+----------------
+
+Check the [Kurento blog]
+Follow us on Twitter @[kurentoms].
+
+Issue tracker
+-------------
+
+Issues and bug reports should be posted to the [GitHub Kurento bugtracker]
+
+Licensing and distribution
+--------------------------
+
+Software associated to Kurento is provided as open source under GNU Library or
+"Lesser" General Public License, version 2.1 (LGPL-2.1). Please check the
+specific terms and conditions linked to this open source license at
+http://opensource.org/licenses/LGPL-2.1. Please note that software derived as a
+result of modifying the source code of Kurento software in order to fix a bug
+or incorporate enhancements is considered a derivative work of the product.
+Software that merely uses or aggregates (i.e. links to) an otherwise unmodified
+version of existing software is not considered a derivative work.
+
+Contribution policy
+-------------------
+
+You can contribute to the Kurento community through bug-reports, bug-fixes, new
+code or new documentation. For contributing to the Kurento community, drop a
+post to the [Kurento Public Mailing List] providing full information about your
+contribution and its value. In your contributions, you must comply with the
+following guidelines
+
+* You must specify the specific contents of your contribution either through a
+  detailed bug description, through a pull-request or through a patch.
+* You must specify the licensing restrictions of the code you contribute.
+* For newly created code to be incorporated in the Kurento code-base, you must
+  accept Kurento to own the code copyright, so that its open source nature is
+  guaranteed.
+* You must justify appropriately the need and value of your contribution. The
+  Kurento project has no obligations in relation to accepting contributions
+  from third parties.
+* The Kurento project leaders have the right of asking for further
+  explanations, tests or validations of any code contributed to the community
+  before it being incorporated into the Kurento code-base. You must be ready to
+  addressing all these kind of concerns before having your code approved.
+
+Support
+-------
+
+The Kurento project provides community support through the  [Kurento Public
+Mailing List] and through [StackOverflow] using the tags *kurento* and
+*fiware-kurento*.
+
+Before asking for support, please read first the [Kurento Netiquette Guidelines]
+
+[documentation]: http://www.kurento.org/documentation
+[FIWARE]: http://www.fiware.org
+[GitHub Kurento bugtracker]: https://github.com/Kurento/bugtracker/issues
+[GitHub Kurento Group]: https://github.com/kurento
+[kurentoms]: http://twitter.com/kurentoms
+[Kurento]: http://kurento.org
+[Kurento Blog]: http://www.kurento.org/blog
+[Kurento FIWARE Catalog Entry]: http://catalogue.fiware.org/enablers/stream-oriented-kurento
+[Kurento Netiquette Guidelines]: http://www.kurento.org/blog/kurento-netiquette-guidelines
+[Kurento Public Mailing list]: https://groups.google.com/forum/#!forum/kurento
+[KurentoImage]: https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120
+[LGPL v2.1 License]: http://www.gnu.org/licenses/lgpl-2.1.html
+[NUBOMEDIA]: http://www.nubomedia.eu
+[StackOverflow]: http://stackoverflow.com/search?q=kurento
+[readthedocs.org]: http://kurento.readthedocs.org/
+[Open API specification]: http://kurento.github.io/doc-kurento/
+[apiary.io]: http://docs.streamoriented.apiary.io/

src/elements.kmd.json

 {
   "name": "elements",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "kurentoVersion": "^6.1.0",
@@ -18,3 +18,3 @@ "imports": [
         "mavenArtifactId": "kms-api-elements",
-        "mavenVersion": "6.1.0"
+        "mavenVersion": "6.1.1"
       }
@@ -27,3 +27,3 @@ },
         "mavenArtifactId": "kurento-client",
-        "mavenVersion": "6.1.0"
+        "mavenVersion": "6.1.1"
       },
@@ -34,3 +34,3 @@ "js": {
         "npmGit": "Kurento/kurento-client-elements-js",
-        "npmVersion": "6.1.0"
+        "npmVersion": "6.1.1"
       }
@@ -131,2 +131,54 @@ },
           "doc": "Provide a remote ICE candidate"
+        },
+        {
+          "params": [
+            {
+              "name": "label",
+              "doc": "Channel's label attribute",
+              "type": "String",
+              "optional": true,
+              "defaultValue": ""
+            },
+            {
+              "name": "ordered",
+              "doc": "If the data channel should guarantee order or not",
+              "type": "boolean",
+              "optional": true,
+              "defaultValue": true
+            },
+            {
+              "name": "maxPacketLifeTime",
+              "doc": "the length of the time window (in milliseconds) during which transmissions and retransmissions may occur in unreliable mode",
+              "type": "int",
+              "optional": true,
+              "defaultValue": -1
+            },
+            {
+              "name": "maxRetransmits",
+              "doc": "maximum number of retransmissions that are attempted in unreliable mode",
+              "type": "int",
+              "optional": true,
+              "defaultValue": -1
+            },
+            {
+              "name": "protocol",
+              "doc": "the name of the sub-protocol used",
+              "type": "String",
+              "optional": true,
+              "defaultValue": ""
+            }
+          ],
+          "name": "createDataChannel",
+          "doc": "Create a new data channel if data channel are supported"
+        },
+        {
+          "params": [
+            {
+              "name": "channelId",
+              "doc": "The channel identifier",
+              "type": "int"
+            }
+          ],
+          "name": "closeDataChannel",
+          "doc": "Close an opened data channel"
         }
@@ -137,3 +189,5 @@ ],
         "OnIceGatheringDone",
-        "OnIceComponentStateChanged"
+        "OnIceComponentStateChanged",
+        "OnDataChannelOpened",
+        "OnDataChannelClosed"
       ]
@@ -552,2 +606,26 @@ },
     {
+      "properties": [
+        {
+          "name": "channelId",
+          "doc": "The channel identifier",
+          "type": "int"
+        }
+      ],
+      "extends": "Media",
+      "name": "OnDataChannelOpened",
+      "doc": "Notify the creation of a new data channel."
+    },
+    {
+      "properties": [
+        {
+          "name": "channelId",
+          "doc": "The channel identifier",
+          "type": "int"
+        }
+      ],
+      "extends": "Media",
+      "name": "OnDataChannelClosed",
+      "doc": "Notify the destruction of a data channel."
+    },
+    {
       "properties": [],
@@ -554,0 +632,0 @@ "extends": "Media",

No alert changes

Improved metrics

Total package byte prevSize

118853

increased by14.63%

Number of package files

25

increased by4.17%

Lines of code

2501

increased by8.41%

Number of lines in readme file

110

increased by1275%

No dependency changes