/* 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 Hub = require('kurento-client-core').abstracts.Hub;
function noop(error, result) {
if (error) console.trace(error);
return result
};
/**
* Create for the given pipeline
*
* @classdesc
* A {@link Hub} that mixes the {@link elements.AlphaBlendingMediaType#AUDIO}
* stream of its connected sources and constructs one output with {@link
* elements.AlphaBlendingMediaType#VIDEO} streams of its connected sources into
*
* @extends module:core/abstracts.Hub
*
* @constructor module:elements.AlphaBlending
*/
function AlphaBlending(){
AlphaBlending.super_.call(this);
};
inherits(AlphaBlending, Hub);
//
// Public methods
//
/**
* Sets the source port that will be the master entry to the mixer
*
* @alias module:elements.AlphaBlending.setMaster
*
* @param {module:core.HubPort} source
* The reference to the HubPort setting as master port
*
* @param {external:Integer} zOrder
* The order in z to draw the master image
*
* @param {module:elements.AlphaBlending~setMasterCallback} [callback]
*
* @return {external:Promise}
*/
AlphaBlending.prototype.setMaster = function(source, zOrder, callback){
var transaction = (arguments[0] instanceof Transaction)
? Array.prototype.shift.apply(arguments)
: undefined;
//
// checkType('HubPort', 'source', source, {required: true});
//
// checkType('int', 'zOrder', zOrder, {required: true});
//
var params = {
source: source,
zOrder: zOrder
};
callback = (callback || noop).bind(this)
return disguise(this._invoke(transaction, 'setMaster', params, callback), this)
};
/**
* @callback module:elements.AlphaBlending~setMasterCallback
* @param {external:Error} error
*/
/**
* Configure the blending mode of one port.
*
* @alias module:elements.AlphaBlending.setPortProperties
*
* @param {external:Number} relativeX
* The x position relative to the master port. Values from 0 to 1 are accepted.
*
* @param {external:Number} relativeY
* The y position relative to the master port. Values from 0 to 1 are accepted.
*
* @param {external:Integer} zOrder
* The order in z to draw the images. The greatest value of z is in the top.
*
* @param {external:Number} relativeWidth
* The image width relative to the master port width. Values from 0 to 1 are
* accepted.
*
* @param {external:Number} relativeHeight
* The image height relative to the master port height. Values from 0 to 1 are
* accepted.
*
* @param {module:core.HubPort} port
* The reference to the confingured port.
*
* @param {module:elements.AlphaBlending~setPortPropertiesCallback} [callback]
*
* @return {external:Promise}
*/
AlphaBlending.prototype.setPortProperties = function(relativeX, relativeY, zOrder, relativeWidth, relativeHeight, port, callback){
var transaction = (arguments[0] instanceof Transaction)
? Array.prototype.shift.apply(arguments)
: undefined;
//
// checkType('float', 'relativeX', relativeX, {required: true});
//
// checkType('float', 'relativeY', relativeY, {required: true});
//
// checkType('int', 'zOrder', zOrder, {required: true});
//
// checkType('float', 'relativeWidth', relativeWidth, {required: true});
//
// checkType('float', 'relativeHeight', relativeHeight, {required: true});
//
// checkType('HubPort', 'port', port, {required: true});
//
var params = {
relativeX: relativeX,
relativeY: relativeY,
zOrder: zOrder,
relativeWidth: relativeWidth,
relativeHeight: relativeHeight,
port: port
};
callback = (callback || noop).bind(this)
return disguise(this._invoke(transaction, 'setPortProperties', params, callback), this)
};
/**
* @callback module:elements.AlphaBlending~setPortPropertiesCallback
* @param {external:Error} error
*/
/**
* @alias module:elements.AlphaBlending.constructorParams
*
* @property {module:core.MediaPipeline} mediaPipeline
* the {@link MediaPipeline} to which the dispatcher belongs
*/
AlphaBlending.constructorParams = {
mediaPipeline: {
type: 'kurento.MediaPipeline',
required: true
}
};
/**
* @alias module:elements.AlphaBlending.events
*
* @extends module:core/abstracts.Hub.events
*/
AlphaBlending.events = Hub.events;
/**
* Checker for {@link module:elements.AlphaBlending}
*
* @memberof module:elements
*
* @param {external:String} key
* @param {module:elements.AlphaBlending} value
*/
function checkAlphaBlending(key, value)
{
if(!(value instanceof AlphaBlending))
throw ChecktypeError(key, AlphaBlending, value);
};
module.exports = AlphaBlending;
AlphaBlending.check = checkAlphaBlending;