kurento-client-filters - npm Package Compare versions

Comparing version 6.6.1 to 6.12.0

lib/FaceOverlayFilter.js

@@ -118,7 +118,13 @@ /* Autogenerated with Kurento Idl */
 
-  checkType('String', 'uri', uri, {required: true});
-  checkType('float', 'offsetXPercent', offsetXPercent, {required: true});
-  checkType('float', 'offsetYPercent', offsetYPercent, {required: true});
-  checkType('float', 'widthPercent', widthPercent, {required: true});
-  checkType('float', 'heightPercent', heightPercent, {required: true});
+  //  
+  // checkType('String', 'uri', uri, {required: true});
+  //  
+  // checkType('float', 'offsetXPercent', offsetXPercent, {required: true});
+  //  
+  // checkType('float', 'offsetYPercent', offsetYPercent, {required: true});
+  //  
+  // checkType('float', 'widthPercent', widthPercent, {required: true});
+  //  
+  // checkType('float', 'heightPercent', heightPercent, {required: true});
+  //  
 
@@ -125,0 +131,0 @@ var params = {

lib/GStreamerFilter.js

@@ -25,4 +25,6 @@ /* Autogenerated with Kurento Idl */
 
-var ChecktypeError = kurentoClient.checkType.ChecktypeError;
+var checkType      = kurentoClient.checkType;
+var ChecktypeError = checkType.ChecktypeError;
 
+
 var Transaction = kurentoClient.TransactionsManager.Transaction;
@@ -41,7 +43,12 @@
 /**
- * Create a {@link module:filters.GStreamerFilter GStreamerFilter}
+ * Create a {@link module:filters.GStreamerFilter GStreamerFilter}.
  *
  * @classdesc
- *  This is a generic filter interface, that creates GStreamer filters in the 
- *  media server.
+ *  A generic filter interface that allows injecting any GStreamer element.
+ *        <p>
+ *        Note however that the current implementation of GStreamerFilter only 
+ *        allows single elements to be injected; one cannot indicate more than 
+ *        one at the same time; use several GStreamerFilters if you need to 
+ *        inject more than one element at the same time.
+ *        </p>
  *
@@ -63,3 +70,4 @@ * @extends module:core/abstracts.Filter
 /**
- * GStreamer command.
+ * String used to instantiate the GStreamer element, as in `gst-launch 
+ * <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.
  *
@@ -96,11 +104,56 @@ * @alias module:filters.GStreamerFilter#getCommand
 
+//
+// Public methods
+//
+
 /**
+ * Provide a value to one of the GStreamer element's properties.
+ *
+ * @alias module:filters.GStreamerFilter.setElementProperty
+ *
+ * @param {external:String} propertyName
+ *  Name of the property that needs to be modified in the GStreamer element.
+ *
+ * @param {external:String} propertyValue
+ *  Value that must be assigned to the property.
+ *
+ * @param {module:filters.GStreamerFilter~setElementPropertyCallback} [callback]
+ *
+ * @return {external:Promise}
+ */
+GStreamerFilter.prototype.setElementProperty = function(propertyName, propertyValue, callback){
+  var transaction = (arguments[0] instanceof Transaction)
+                  ? Array.prototype.shift.apply(arguments)
+                  : undefined;
+
+  //  
+  // checkType('String', 'propertyName', propertyName, {required: true});
+  //  
+  // checkType('String', 'propertyValue', propertyValue, {required: true});
+  //  
+
+  var params = {
+    propertyName: propertyName,
+    propertyValue: propertyValue
+  };
+
+  callback = (callback || noop).bind(this)
+
+  return disguise(this._invoke(transaction, 'setElementProperty', params, callback), this)
+};
+/**
+ * @callback module:filters.GStreamerFilter~setElementPropertyCallback
+ * @param {external:Error} error
+ */
+
+
+/**
  * @alias module:filters.GStreamerFilter.constructorParams
  *
  * @property {external:String} command
- *  command that would be used to instantiate the filter, as in `gst-launch 
- *  <http://rpm.pbone.net/index.php3/stat/45/idpl/19531544/numer/1/nazwa/gst-launch-1.0>`__
+ *  String used to instantiate the GStreamer element, as in `gst-launch 
+ *  <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.
  *
  * @property {external:FilterType} [filterType]
- *  Filter type that define if the filter is set as audio, video or autodetect
+ *  Sets the filter as Audio, Video, or Autodetect.
  *
@@ -107,0 +160,0 @@ * @property {module:core.MediaPipeline} mediaPipeline

lib/ImageOverlayFilter.js

@@ -105,10 +105,19 @@ /* Autogenerated with Kurento Idl */
 
-  checkType('String', 'id', id, {required: true});
-  checkType('String', 'uri', uri, {required: true});
-  checkType('float', 'offsetXPercent', offsetXPercent, {required: true});
-  checkType('float', 'offsetYPercent', offsetYPercent, {required: true});
-  checkType('float', 'widthPercent', widthPercent, {required: true});
-  checkType('float', 'heightPercent', heightPercent, {required: true});
-  checkType('boolean', 'keepAspectRatio', keepAspectRatio, {required: true});
-  checkType('boolean', 'center', center, {required: true});
+  //  
+  // checkType('String', 'id', id, {required: true});
+  //  
+  // checkType('String', 'uri', uri, {required: true});
+  //  
+  // checkType('float', 'offsetXPercent', offsetXPercent, {required: true});
+  //  
+  // checkType('float', 'offsetYPercent', offsetYPercent, {required: true});
+  //  
+  // checkType('float', 'widthPercent', widthPercent, {required: true});
+  //  
+  // checkType('float', 'heightPercent', heightPercent, {required: true});
+  //  
+  // checkType('boolean', 'keepAspectRatio', keepAspectRatio, {required: true});
+  //  
+  // checkType('boolean', 'center', center, {required: true});
+  //  
 
@@ -152,3 +161,5 @@ var params = {
 
-  checkType('String', 'id', id, {required: true});
+  //  
+  // checkType('String', 'id', id, {required: true});
+  //  
 
@@ -173,3 +184,3 @@ var params = {
  * @property {module:core.MediaPipeline} mediaPipeline
- *  pipeline to which this {@link module:core/abstracts.Filter Filter} belons
+ *  pipeline to which this {@link module:core/abstracts.Filter Filter} belongs
  */
@@ -176,0 +187,0 @@ ImageOverlayFilter.constructorParams = {

lib/index.js

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

package.json

 {
   "name": "kurento-client-filters",
-  "version": "6.6.1",
-  "description": "Filter implementations for kurento media server",
-  "main": "lib/index.js",
+  "version": "6.12.0",
+  "description": "JavaScript Client API for Kurento Media Server",
   "repository": {
     "type": "git",
-    "url": "Kurento/kurento-client-filters-js"
+    "url": "https://github.com/Kurento/kurento-client-filters-js.git"
   },
@@ -15,2 +14,3 @@ "keywords": [
   ],
+  "main": "lib/index.js",
   "license": "ALv2",
@@ -17,0 +17,0 @@ "homepage": "http://www.kurento.com",

README_bower.md

@@ -16,3 +16,3 @@ [![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
-Module "filters" description: Filter implementations for kurento media server
+Module "filters" description: JavaScript Client API for Kurento Media Server
 
@@ -19,0 +19,0 @@ What is Kurento

README.md

@@ -15,3 +15,3 @@ [![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
-Module "filters" description: Filter implementations for kurento media server
+Module "filters" description: JavaScript Client API for Kurento Media Server
 
@@ -18,0 +18,0 @@ What is Kurento

src/filters.kmd.json

 {
   "name": "filters",
-  "version": "6.6.1",
-  "kurentoVersion": "^6.1.0",
+  "version": "6.12.0",
+  "kurentoVersion": "^6.7.0",
   "imports": [
     {
       "name": "core",
-      "version": "^6.1.0",
-      "mavenVersion": "[6.1.0,7.0.0-SNAPSHOT)",
-      "npmVersion": ">=6.1.0 <7.0.0"
+      "version": "^6.7.0",
+      "mavenVersion": "[6.7.0,7.0.0-SNAPSHOT)",
+      "npmVersion": ">=6.7.0 <7.0.0"
     },
     {
       "name": "elements",
-      "version": "^6.1.0",
-      "mavenVersion": "[6.1.0,7.0.0-SNAPSHOT)",
-      "npmVersion": ">=6.1.0 <7.0.0"
+      "version": "^6.7.0",
+      "mavenVersion": "[6.7.0,7.0.0-SNAPSHOT)",
+      "npmVersion": ">=6.7.0 <7.0.0"
     }
@@ -24,3 +24,3 @@ ],
         "mavenArtifactId": "kms-api-filters",
-        "mavenVersion": "6.6.1"
+        "mavenVersion": "6.12.0"
       }
@@ -33,9 +33,9 @@ },
         "mavenArtifactId": "kurento-client",
-        "mavenVersion": "6.6.1"
+        "mavenVersion": "6.12.0"
       },
       "js": {
         "nodeName": "kurento-client-filters",
-        "npmDescription": "Filter implementations for kurento media server",
+        "npmDescription": "JavaScript Client API for Kurento Media Server",
         "npmGit": "Kurento/kurento-client-filters-js",
-        "npmVersion": "6.6.1"
+        "npmVersion": "6.12.0"
       }
@@ -104,3 +104,3 @@ },
       "name": "GStreamerFilter",
-      "doc": "This is a generic filter interface, that creates GStreamer filters in the media server.",
+      "doc": "A generic filter interface that allows injecting any GStreamer element.\n      <p>\n      Note however that the current implementation of GStreamerFilter only allows single elements to be injected; one cannot indicate more than one at the same time; use several GStreamerFilters if you need to inject more than one element at the same time.\n      </p>\n      ",
       "extends": "Filter",
@@ -116,3 +116,3 @@ "constructor": {
             "name": "command",
-            "doc": "command that would be used to instantiate the filter, as in `gst-launch <http://rpm.pbone.net/index.php3/stat/45/idpl/19531544/numer/1/nazwa/gst-launch-1.0>`__",
+            "doc": "String used to instantiate the GStreamer element, as in `gst-launch <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.",
             "type": "String"
@@ -122,3 +122,3 @@ },
             "name": "filterType",
-            "doc": "Filter type that define if the filter is set as audio, video or autodetect",
+            "doc": "Sets the filter as Audio, Video, or Autodetect.",
             "type": "FilterType",
@@ -129,3 +129,3 @@ "optional": true,
         ],
-        "doc": "Create a :rom:cls:`GStreamerFilter`"
+        "doc": "Create a :rom:cls:`GStreamerFilter`."
       },
@@ -135,33 +135,27 @@ "properties": [
           "name": "command",
-          "doc": "GStreamer command.",
+          "doc": "String used to instantiate the GStreamer element, as in `gst-launch <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.",
           "type": "String",
           "readOnly": true
         }
+      ],
+      "methods": [
+        {
+          "params": [
+            {
+              "name": "propertyName",
+              "doc": "Name of the property that needs to be modified in the GStreamer element.",
+              "type": "String"
+            },
+            {
+              "name": "propertyValue",
+              "doc": "Value that must be assigned to the property.",
+              "type": "String"
+            }
+          ],
+          "name": "setElementProperty",
+          "doc": "Provide a value to one of the GStreamer element's properties."
+        }
       ]
     },
     {
-      "name": "OpenCVFilter",
-      "doc": "Generic OpenCV Filter",
-      "abstract": true,
-      "extends": "Filter"
-    },
-    {
-      "name": "ZBarFilter",
-      "doc": "This filter detects :term:`QR` codes in a video feed. When a code is found, the filter raises a :rom:evnt:`CodeFound` event.",
-      "extends": "Filter",
-      "constructor": {
-        "params": [
-          {
-            "name": "mediaPipeline",
-            "doc": "the :rom:cls:`MediaPipeline` to which the filter belongs",
-            "type": "MediaPipeline"
-          }
-        ],
-        "doc": "Builder for the :rom:cls:`ZBarFilter`."
-      },
-      "events": [
-        "CodeFound"
-      ]
-    },
-    {
       "name": "ImageOverlayFilter",
@@ -174,3 +168,3 @@ "doc": "ImageOverlayFilter interface. This type of :rom:cls:`Filter` draws an image in a configured position over a video feed.",
             "name": "mediaPipeline",
-            "doc": "pipeline to which this :rom:cls:`Filter` belons",
+            "doc": "pipeline to which this :rom:cls:`Filter` belongs",
             "type": "MediaPipeline"
@@ -240,2 +234,26 @@ }
       ]
+    },
+    {
+      "name": "OpenCVFilter",
+      "doc": "Generic OpenCV Filter",
+      "abstract": true,
+      "extends": "Filter"
+    },
+    {
+      "name": "ZBarFilter",
+      "doc": "This filter detects :term:`QR` codes in a video feed. When a code is found, the filter raises a :rom:evnt:`CodeFound` event.",
+      "extends": "Filter",
+      "constructor": {
+        "params": [
+          {
+            "name": "mediaPipeline",
+            "doc": "the :rom:cls:`MediaPipeline` to which the filter belongs",
+            "type": "MediaPipeline"
+          }
+        ],
+        "doc": "Builder for the :rom:cls:`ZBarFilter`."
+      },
+      "events": [
+        "CodeFound"
+      ]
     }
@@ -242,0 +260,0 @@ ],

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

59516

increased by4.84%

Lines of code

1071

increased by8.18%

Worsened metrics

Number of package files

14

decreased by-6.67%

No dependency changes