kurento-client-core
Version:
JavaScript Client API for Kurento Media Server
220 lines (202 loc) • 8.12 kB
JavaScript
/* 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 checkType = kurentoClient.checkType;
var ChecktypeError = checkType.ChecktypeError;
var RTCStats = require('./RTCStats');
/**
* Statistics related to the media stream.
*
* @constructor module:core/complexTypes.RTCMediaStreamTrackStats
*
* @property {external:String} trackIdentifier
* Represents the track.id property.
* @property {external:Boolean} remoteSource
* true indicates that this is a remote source. false in other case.
* @property {external:String} ssrcIds
* Synchronized sources.
* @property {external:int64} frameWidth
* Only makes sense for video media streams and represents the width of the
* video frame for this SSRC.
* @property {external:int64} frameHeight
* Only makes sense for video media streams and represents the height of the
* video frame for this SSRC.
* @property {external:double} framesPerSecond
* Only valid for video. It represents the nominal FPS value.
* @property {external:int64} framesSent
* Only valid for video. It represents the total number of frames sent for this
* @property {external:int64} framesReceived
* Only valid for video and when remoteSource is set to true. It represents the
* @property {external:int64} framesDecoded
* Only valid for video. It represents the total number of frames correctly
* decoded for this SSRC.
* @property {external:int64} framesDropped
* Only valid for video. The total number of frames dropped pre-decoding or
* dropped because the frame missed its display deadline.
* @property {external:int64} framesCorrupted
* Only valid for video. The total number of corrupted frames that have been
* detected.
* @property {external:double} audioLevel
* Only valid for audio, and the value is between 0..1 (linear), where 1.0
* represents 0 dBov.
* @property {external:double} echoReturnLoss
* Only present on audio tracks sourced from a microphone where echo
* cancellation is applied. Calculated in decibels.
* @property {external:double} echoReturnLossEnhancement
* Only present on audio tracks sourced from a microphone where echo
* cancellation is applied.
* @extends module:core.RTCStats
*/
function RTCMediaStreamTrackStats(rTCMediaStreamTrackStatsDict){
if(!(this instanceof RTCMediaStreamTrackStats))
return new RTCMediaStreamTrackStats(rTCMediaStreamTrackStatsDict)
rTCMediaStreamTrackStatsDict = rTCMediaStreamTrackStatsDict || {}
// Check rTCMediaStreamTrackStatsDict has the required fields
//
// checkType('String', 'rTCMediaStreamTrackStatsDict.trackIdentifier', rTCMediaStreamTrackStatsDict.trackIdentifier, {required: true});
//
// checkType('boolean', 'rTCMediaStreamTrackStatsDict.remoteSource', rTCMediaStreamTrackStatsDict.remoteSource, {required: true});
//
// checkType('String', 'rTCMediaStreamTrackStatsDict.ssrcIds', rTCMediaStreamTrackStatsDict.ssrcIds, {isArray: true, required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.frameWidth', rTCMediaStreamTrackStatsDict.frameWidth, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.frameHeight', rTCMediaStreamTrackStatsDict.frameHeight, {required: true});
//
// checkType('double', 'rTCMediaStreamTrackStatsDict.framesPerSecond', rTCMediaStreamTrackStatsDict.framesPerSecond, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.framesSent', rTCMediaStreamTrackStatsDict.framesSent, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.framesReceived', rTCMediaStreamTrackStatsDict.framesReceived, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.framesDecoded', rTCMediaStreamTrackStatsDict.framesDecoded, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.framesDropped', rTCMediaStreamTrackStatsDict.framesDropped, {required: true});
//
// checkType('int64', 'rTCMediaStreamTrackStatsDict.framesCorrupted', rTCMediaStreamTrackStatsDict.framesCorrupted, {required: true});
//
// checkType('double', 'rTCMediaStreamTrackStatsDict.audioLevel', rTCMediaStreamTrackStatsDict.audioLevel, {required: true});
//
// checkType('double', 'rTCMediaStreamTrackStatsDict.echoReturnLoss', rTCMediaStreamTrackStatsDict.echoReturnLoss, {required: true});
//
// checkType('double', 'rTCMediaStreamTrackStatsDict.echoReturnLossEnhancement', rTCMediaStreamTrackStatsDict.echoReturnLossEnhancement, {required: true});
//
// Init parent class
RTCMediaStreamTrackStats.super_.call(this, rTCMediaStreamTrackStatsDict)
// Set object properties
Object.defineProperties(this, {
trackIdentifier: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.trackIdentifier
},
remoteSource: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.remoteSource
},
ssrcIds: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.ssrcIds
},
frameWidth: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.frameWidth
},
frameHeight: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.frameHeight
},
framesPerSecond: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesPerSecond
},
framesSent: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesSent
},
framesReceived: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesReceived
},
framesDecoded: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesDecoded
},
framesDropped: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesDropped
},
framesCorrupted: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.framesCorrupted
},
audioLevel: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.audioLevel
},
echoReturnLoss: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.echoReturnLoss
},
echoReturnLossEnhancement: {
writable: true,
enumerable: true,
value: rTCMediaStreamTrackStatsDict.echoReturnLossEnhancement
}
})
}
inherits(RTCMediaStreamTrackStats, RTCStats)
// Private identifiers to allow re-construction of the complexType on the server
// They need to be enumerable so JSON.stringify() can access to them
Object.defineProperties(RTCMediaStreamTrackStats.prototype, {
__module__: {
enumerable: true,
value: "kurento"
},
__type__: {
enumerable: true,
value: "RTCMediaStreamTrackStats"
}
})
/**
* Checker for {@link module:core/complexTypes.RTCMediaStreamTrackStats}
*
* @memberof module:core/complexTypes
*
* @param {external:String} key
* @param {module:core/complexTypes.RTCMediaStreamTrackStats} value
*/
function checkRTCMediaStreamTrackStats(key, value)
{
if(!(value instanceof RTCMediaStreamTrackStats))
throw ChecktypeError(key, RTCMediaStreamTrackStats, value);
};
module.exports = RTCMediaStreamTrackStats;
RTCMediaStreamTrackStats.check = checkRTCMediaStreamTrackStats;