/* 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 a {@link Mixer} belonging to the given pipeline.
*
* @classdesc
* A {@link Hub} that allows routing of video between arbitrary port pairs and
* mixing of audio among several ports
*
* @extends module:core/abstracts.Hub
*
* @constructor module:elements.Mixer
*/
function Mixer(){
Mixer.super_.call(this);
};
inherits(Mixer, Hub);
//
// Public methods
//
/**
* Connects each corresponding {@link MediaType} of the given source port with
* the sink port.
*
* @alias module:elements.Mixer.connect
*
* @param {external:MediaType} media
* The sort of media stream to be connected
*
* @param {module:core.HubPort} source
* Source port to be connected
*
* @param {module:core.HubPort} sink
* Sink port to be connected
*
* @param {module:elements.Mixer~connectCallback} [callback]
*
* @return {external:Promise}
*/
Mixer.prototype.connect = function(media, source, sink, callback){
var transaction = (arguments[0] instanceof Transaction)
? Array.prototype.shift.apply(arguments)
: undefined;
//
// checkType('MediaType', 'media', media, {required: true});
//
// checkType('HubPort', 'source', source, {required: true});
//
// checkType('HubPort', 'sink', sink, {required: true});
//
var params = {
media: media,
source: source,
sink: sink
};
callback = (callback || noop).bind(this)
return disguise(this._invoke(transaction, 'connect', params, callback), this)
};
/**
* @callback module:elements.Mixer~connectCallback
* @param {external:Error} error
*/
/**
* Disonnects each corresponding {@link MediaType} of the given source port from
*
* @alias module:elements.Mixer.disconnect
*
* @param {external:MediaType} media
* The sort of media stream to be disconnected
*
* @param {module:core.HubPort} source
* Audio source port to be disconnected
*
* @param {module:core.HubPort} sink
* Audio sink port to be disconnected
*
* @param {module:elements.Mixer~disconnectCallback} [callback]
*
* @return {external:Promise}
*/
Mixer.prototype.disconnect = function(media, source, sink, callback){
var transaction = (arguments[0] instanceof Transaction)
? Array.prototype.shift.apply(arguments)
: undefined;
//
// checkType('MediaType', 'media', media, {required: true});
//
// checkType('HubPort', 'source', source, {required: true});
//
// checkType('HubPort', 'sink', sink, {required: true});
//
var params = {
media: media,
source: source,
sink: sink
};
callback = (callback || noop).bind(this)
return disguise(this._invoke(transaction, 'disconnect', params, callback), this)
};
/**
* @callback module:elements.Mixer~disconnectCallback
* @param {external:Error} error
*/
/**
* @alias module:elements.Mixer.constructorParams
*
* @property {module:core.MediaPipeline} mediaPipeline
* the {@link MediaPipeline} to which the Mixer belongs
*/
Mixer.constructorParams = {
mediaPipeline: {
type: 'kurento.MediaPipeline',
required: true
}
};
/**
* @alias module:elements.Mixer.events
*
* @extends module:core/abstracts.Hub.events
*/
Mixer.events = Hub.events;
/**
* Checker for {@link module:elements.Mixer}
*
* @memberof module:elements
*
* @param {external:String} key
* @param {module:elements.Mixer} value
*/
function checkMixer(key, value)
{
if(!(value instanceof Mixer))
throw ChecktypeError(key, Mixer, value);
};
module.exports = Mixer;
Mixer.check = checkMixer;