kurento-client-filters
Advanced tools
Comparing version 6.16.0 to 6.18.0
@@ -21,3 +21,4 @@ /* Autogenerated with Kurento Idl */ | ||
/** | ||
* Event raised by a {@link module:filters.ZBarFilter ZBarFilter} when a code is | ||
* Event raised by a {@link ZBarFilter} when a code is found in the data being | ||
* streamed. | ||
* | ||
@@ -29,7 +30,5 @@ * @event module:filters#CodeFound | ||
* @property {external:String} codeType | ||
* type of <a | ||
* href="http://www.kurento.org/docs/current/glossary.html#term-qr">QR</a> code | ||
* type of QR code found | ||
* @property {external:String} value | ||
* value contained in the <a | ||
* href="http://www.kurento.org/docs/current/glossary.html#term-qr">QR</a> code | ||
* value contained in the QR code | ||
*/ |
@@ -42,7 +42,8 @@ /* Autogenerated with Kurento Idl */ | ||
/** | ||
* FaceOverlayFilter interface. This type of {@link module:core/abstracts.Filter | ||
* FaceOverlayFilter interface. This type of {@link Filter} detects faces in a | ||
* video feed. The face is then overlaid with an image. | ||
* | ||
* @classdesc | ||
* FaceOverlayFilter interface. This type of {@link | ||
* module:core/abstracts.Filter Filter} detects faces in a video feed. The face | ||
* FaceOverlayFilter interface. This type of {@link Filter} detects faces in a | ||
* video feed. The face is then overlaid with an image. | ||
* | ||
@@ -185,3 +186,3 @@ * @extends module:core/abstracts.Filter | ||
* @property {module:core.MediaPipeline} mediaPipeline | ||
* pipeline to which this {@link module:core/abstracts.Filter Filter} belons | ||
* pipeline to which this {@link Filter} belons | ||
*/ | ||
@@ -188,0 +189,0 @@ FaceOverlayFilter.constructorParams = { |
@@ -42,12 +42,22 @@ /* Autogenerated with Kurento Idl */ | ||
/** | ||
* Create a {@link module:filters.GStreamerFilter GStreamerFilter}. | ||
* Create a {@link GStreamerFilter}. | ||
* | ||
* @classdesc | ||
* 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> | ||
* A generic filter that allows injecting a single GStreamer element. | ||
* <p> | ||
* 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 into the | ||
* pipeline. | ||
* </p> | ||
* <p> | ||
* Note that usage of some popular GStreamer elements requires installation | ||
* of | ||
* additional packages. For example, overlay elements such as | ||
* <em>timeoverlay</em> or <em>textoverlay</em> require installation of the | ||
* <strong>gstreamer1.5-x</strong> package, which will also install the | ||
* <em>Pango</em> rendering library. | ||
* </p> | ||
* | ||
@@ -69,4 +79,4 @@ * @extends module:core/abstracts.Filter | ||
/** | ||
* String used to instantiate the GStreamer element, as in `gst-launch | ||
* <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__. | ||
* String used to instantiate the GStreamer element, as in gst-launch | ||
* (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html). | ||
* | ||
@@ -152,4 +162,4 @@ * @alias module:filters.GStreamerFilter#getCommand | ||
* @property {external:String} command | ||
* String used to instantiate the GStreamer element, as in `gst-launch | ||
* <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__. | ||
* String used to instantiate the GStreamer element, as in gst-launch | ||
* (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html). | ||
* | ||
@@ -160,4 +170,3 @@ * @property {external:FilterType} [filterType] | ||
* @property {module:core.MediaPipeline} mediaPipeline | ||
* the {@link module:core.MediaPipeline MediaPipeline} to which the filter | ||
* belongs | ||
* the {@link MediaPipeline} to which the filter belongs | ||
*/ | ||
@@ -164,0 +173,0 @@ GStreamerFilter.constructorParams = { |
@@ -42,9 +42,7 @@ /* Autogenerated with Kurento Idl */ | ||
/** | ||
* ImageOverlayFilter interface. This type of {@link | ||
* module:core/abstracts.Filter Filter} draws an image in a configured position | ||
* over a video feed. | ||
* ImageOverlayFilter interface. This type of {@link Filter} draws an image in a | ||
* | ||
* @classdesc | ||
* ImageOverlayFilter interface. This type of {@link | ||
* module:core/abstracts.Filter Filter} draws an image in a configured position | ||
* ImageOverlayFilter interface. This type of {@link Filter} draws an image in | ||
* a configured position over a video feed. | ||
* | ||
@@ -183,3 +181,3 @@ * @extends module:core/abstracts.Filter | ||
* @property {module:core.MediaPipeline} mediaPipeline | ||
* pipeline to which this {@link module:core/abstracts.Filter Filter} belongs | ||
* pipeline to which this {@link Filter} belongs | ||
*/ | ||
@@ -186,0 +184,0 @@ ImageOverlayFilter.constructorParams = { |
@@ -29,3 +29,3 @@ /* Autogenerated with Kurento Idl */ | ||
Object.defineProperty(exports, 'name', {value: 'filters'}); | ||
Object.defineProperty(exports, 'version', {value: '6.16.0'}); | ||
Object.defineProperty(exports, 'version', {value: '6.18.0'}); | ||
@@ -32,0 +32,0 @@ |
@@ -31,9 +31,7 @@ /* Autogenerated with Kurento Idl */ | ||
/** | ||
* Builder for the {@link module:filters.ZBarFilter ZBarFilter}. | ||
* Builder for the {@link ZBarFilter}. | ||
* | ||
* @classdesc | ||
* This filter detects <a | ||
* href="http://www.kurento.org/docs/current/glossary.html#term-qr">QR</a> | ||
* codes in a video feed. When a code is found, the filter raises a | ||
* :rom:evnt:`CodeFound` event. | ||
* This filter detects QR codes in a video feed. When a code is found, the | ||
* filter raises a :rom:evnt:`CodeFound` event. | ||
* | ||
@@ -56,4 +54,3 @@ * @extends module:core/abstracts.Filter | ||
* @property {module:core.MediaPipeline} mediaPipeline | ||
* the {@link module:core.MediaPipeline MediaPipeline} to which the filter | ||
* belongs | ||
* the {@link MediaPipeline} to which the filter belongs | ||
*/ | ||
@@ -60,0 +57,0 @@ ZBarFilter.constructorParams = { |
{ | ||
"name": "kurento-client-filters", | ||
"version": "6.16.0", | ||
"version": "6.18.0", | ||
"description": "JavaScript Client API for Kurento Media Server", | ||
@@ -5,0 +5,0 @@ "repository": { |
{ | ||
"name": "filters", | ||
"version": "6.16.0", | ||
"kurentoVersion": "^6.16.0", | ||
"version": "6.18.0", | ||
"kurentoVersion": "^6.18.0", | ||
"imports": [ | ||
{ | ||
"name": "core", | ||
"version": "^6.16.0", | ||
"mavenVersion": "[6.16.0,7.0.0-SNAPSHOT)", | ||
"npmVersion": ">=6.16.0 <7.0.0" | ||
"version": "^6.18.0", | ||
"mavenVersion": "[6.18.0,7.0.0-SNAPSHOT)", | ||
"npmVersion": ">=6.18.0 <7.0.0" | ||
}, | ||
{ | ||
"name": "elements", | ||
"version": "^6.16.0", | ||
"mavenVersion": "[6.16.0,7.0.0-SNAPSHOT)", | ||
"npmVersion": ">=6.16.0 <7.0.0" | ||
"version": "^6.18.0", | ||
"mavenVersion": "[6.18.0,7.0.0-SNAPSHOT)", | ||
"npmVersion": ">=6.18.0 <7.0.0" | ||
} | ||
@@ -24,3 +24,3 @@ ], | ||
"mavenArtifactId": "kms-api-filters", | ||
"mavenVersion": "6.16.0" | ||
"mavenVersion": "6.18.0" | ||
} | ||
@@ -33,3 +33,3 @@ }, | ||
"mavenArtifactId": "kurento-client", | ||
"mavenVersion": "6.16.0" | ||
"mavenVersion": "6.18.0" | ||
}, | ||
@@ -40,3 +40,3 @@ "js": { | ||
"npmGit": "Kurento/kurento-client-filters-js", | ||
"npmVersion": "6.16.0" | ||
"npmVersion": "6.18.0" | ||
} | ||
@@ -105,3 +105,3 @@ }, | ||
"name": "GStreamerFilter", | ||
"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 ", | ||
"doc": "A generic filter that allows injecting a single GStreamer element.\n<p>\n The current implementation of GStreamerFilter only allows single elements to\n be injected; one cannot indicate more than one at the same time; use several\n GStreamerFilters if you need to inject more than one element into the\n pipeline.\n</p>\n<p>\n Note that usage of some popular GStreamer elements requires installation of\n additional packages. For example, overlay elements such as\n <em>timeoverlay</em> or <em>textoverlay</em> require installation of the\n <strong>gstreamer1.5-x</strong> package, which will also install the\n <em>Pango</em> rendering library.\n</p>\n ", | ||
"extends": "Filter", | ||
@@ -117,3 +117,3 @@ "constructor": { | ||
"name": "command", | ||
"doc": "String used to instantiate the GStreamer element, as in `gst-launch <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.", | ||
"doc": "String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).", | ||
"type": "String" | ||
@@ -134,3 +134,3 @@ }, | ||
"name": "command", | ||
"doc": "String used to instantiate the GStreamer element, as in `gst-launch <https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html>`__.", | ||
"doc": "String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).", | ||
"type": "String", | ||
@@ -241,3 +241,3 @@ "readOnly": true | ||
"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.", | ||
"doc": "This filter detects QR codes in a video feed. When a code is found, the filter raises a :rom:evnt:`CodeFound` event.", | ||
"extends": "Filter", | ||
@@ -265,3 +265,3 @@ "constructor": { | ||
"name": "codeType", | ||
"doc": "type of :term:`QR` code found", | ||
"doc": "type of QR code found", | ||
"type": "String" | ||
@@ -271,3 +271,3 @@ }, | ||
"name": "value", | ||
"doc": "value contained in the :term:`QR` code", | ||
"doc": "value contained in the QR code", | ||
"type": "String" | ||
@@ -274,0 +274,0 @@ } |
59694
1076