/* Autogenerated with Kurento Idl */
/*
* (C) Copyright 2013-2015 Kurento (https://kurento.openvidu.io/)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var inherits = require('inherits');
var kurentoClient = require('kurento-client');
var disguise = kurentoClient.disguise;
var checkType = kurentoClient.checkType;
var ChecktypeError = checkType.ChecktypeError;
var Transaction = kurentoClient.TransactionsManager.Transaction;
var Filter = require('kurento-client-core').abstracts.Filter;
function noop(error, result) {
if (error) console.trace(error);
return result
};
/**
* 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 Filter} detects faces in a
* video feed. The face is then overlaid with an image.
*
* @extends module:core/abstracts.Filter
*
* @constructor module:filters.FaceOverlayFilter
*/
function FaceOverlayFilter(){
FaceOverlayFilter.super_.call(this);
};
inherits(FaceOverlayFilter, Filter);
//
// Public methods
//
/**
* Sets the image to use as overlay on the detected faces.
*
* @alias module:filters.FaceOverlayFilter.setOverlayedImage
*
* @param {external:String} uri
* URI where the image is located
*
* @param {external:Number} offsetXPercent
* the offset applied to the image, from the X coordinate of the detected face
* upper right corner. A positive value indicates right displacement, while a
* negative value moves the overlaid image to the left. This offset is
* specified as a percentage of the face width.
* For example, to cover the detected face with the overlaid image, the
* parameter has to be <code>0.0</code>. Values of <code>1.0</code> or
* <code>-1.0</code> indicate that the image upper right corner will be at the
* face´s X coord, +- the face´s width.
* <hr/><b>Note</b>
* The parameter name is misleading, the value is not a percent but a ratio
*
* @param {external:Number} offsetYPercent
* the offset applied to the image, from the Y coordinate of the detected face
* upper right corner. A positive value indicates up displacement, while a
* negative value moves the overlaid image down. This offset is specified as a
* percentage of the face width.
* For example, to cover the detected face with the overlaid image, the
* parameter has to be <code>0.0</code>. Values of <code>1.0</code> or
* <code>-1.0</code> indicate that the image upper right corner will be at the
* face´s Y coord, +- the face´s width.
* <hr/><b>Note</b>
* The parameter name is misleading, the value is not a percent but a ratio
*
* @param {external:Number} widthPercent
* proportional width of the overlaid image, relative to the width of the
* detected face. A value of 1.0 implies that the overlaid image will have the
* same width as the detected face. Values greater than 1.0 are allowed, while
* negative values are forbidden.
* <hr/><b>Note</b>
* The parameter name is misleading, the value is not a percent but a ratio
*
* @param {external:Number} heightPercent
* proportional height of the overlaid image, relative to the height of the
* detected face. A value of 1.0 implies that the overlaid image will have the
* same height as the detected face. Values greater than 1.0 are allowed, while
* <hr/><b>Note</b>
* The parameter name is misleading, the value is not a percent but a ratio
*
* @param {module:filters.FaceOverlayFilter~setOverlayedImageCallback} [callback]
*
* @return {external:Promise}
*/
FaceOverlayFilter.prototype.setOverlayedImage = function(uri, offsetXPercent, offsetYPercent, widthPercent, heightPercent, callback){
var transaction = (arguments[0] instanceof Transaction)
? Array.prototype.shift.apply(arguments)
: undefined;
//
// 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});
//
var params = {
uri: uri,
offsetXPercent: offsetXPercent,
offsetYPercent: offsetYPercent,
widthPercent: widthPercent,
heightPercent: heightPercent
};
callback = (callback || noop).bind(this)
return disguise(this._invoke(transaction, 'setOverlayedImage', params, callback), this)
};
/**
* @callback module:filters.FaceOverlayFilter~setOverlayedImageCallback
* @param {external:Error} error
*/
/**
* Clear the image to be shown over each detected face. Stops overlaying the
* faces.
*
* @alias module:filters.FaceOverlayFilter.unsetOverlayedImage
*
* @param {module:filters.FaceOverlayFilter~unsetOverlayedImageCallback} [callback]
*
* @return {external:Promise}
*/
FaceOverlayFilter.prototype.unsetOverlayedImage = 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, 'unsetOverlayedImage', callback), this)
};
/**
* @callback module:filters.FaceOverlayFilter~unsetOverlayedImageCallback
* @param {external:Error} error
*/
/**
* @alias module:filters.FaceOverlayFilter.constructorParams
*
* @property {module:core.MediaPipeline} mediaPipeline
* pipeline to which this {@link Filter} belons
*/
FaceOverlayFilter.constructorParams = {
mediaPipeline: {
type: 'kurento.MediaPipeline',
required: true
}
};
/**
* @alias module:filters.FaceOverlayFilter.events
*
* @extends module:core/abstracts.Filter.events
*/
FaceOverlayFilter.events = Filter.events;
/**
* Checker for {@link module:filters.FaceOverlayFilter}
*
* @memberof module:filters
*
* @param {external:String} key
* @param {module:filters.FaceOverlayFilter} value
*/
function checkFaceOverlayFilter(key, value)
{
if(!(value instanceof FaceOverlayFilter))
throw ChecktypeError(key, FaceOverlayFilter, value);
};
module.exports = FaceOverlayFilter;
FaceOverlayFilter.check = checkFaceOverlayFilter;