kurento-client-core
Version:
JavaScript Client API for Kurento Media Server
213 lines (195 loc) • 8.01 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');
/**
*
* @constructor module:core/complexTypes.RTCIceCandidatePairStats
*
* @property {external:String} transportId
* It is a unique identifier that is associated to the object that was
* inspected to produce the RTCTransportStats associated with this candidate
* pair.
* @property {external:String} localCandidateId
* It is a unique identifier that is associated to the object that was
* inspected to produce the RTCIceCandidateAttributes for the local candidate
* associated with this candidate pair.
* @property {external:String} remoteCandidateId
* It is a unique identifier that is associated to the object that was
* inspected to produce the RTCIceCandidateAttributes for the remote candidate
* associated with this candidate pair.
* @property {module:core/complexTypes.RTCStatsIceCandidatePairState} state
* Represents the state of the checklist for the local and remote candidates in
* @property {external:int64} priority
* Calculated from candidate priorities as defined in [RFC5245] section 5.7.2.
* @property {external:Boolean} nominated
* Related to updating the nominated flag described in Section 7.1.3.2.4 of
* [RFC5245].
* @property {external:Boolean} writable
* Has gotten ACK to an ICE request.
* @property {external:Boolean} readable
* Has gotten a valid incoming ICE request.
* @property {external:int64} bytesSent
* Represents the total number of payload bytes sent on this candidate pair,
* i.e., not including headers or padding.
* @property {external:int64} bytesReceived
* Represents the total number of payload bytes received on this candidate
* pair, i.e., not including headers or padding.
* @property {external:double} roundTripTime
* Represents the RTT computed by the STUN connectivity checks
* @property {external:double} availableOutgoingBitrate
* Measured in Bits per second, and is implementation dependent. It may be
* calculated by the underlying congestion control.
* @property {external:double} availableIncomingBitrate
* Measured in Bits per second, and is implementation dependent. It may be
* calculated by the underlying congestion control.
* @extends module:core.RTCStats
*/
function RTCIceCandidatePairStats(rTCIceCandidatePairStatsDict){
if(!(this instanceof RTCIceCandidatePairStats))
return new RTCIceCandidatePairStats(rTCIceCandidatePairStatsDict)
rTCIceCandidatePairStatsDict = rTCIceCandidatePairStatsDict || {}
// Check rTCIceCandidatePairStatsDict has the required fields
//
// checkType('String', 'rTCIceCandidatePairStatsDict.transportId', rTCIceCandidatePairStatsDict.transportId, {required: true});
//
// checkType('String', 'rTCIceCandidatePairStatsDict.localCandidateId', rTCIceCandidatePairStatsDict.localCandidateId, {required: true});
//
// checkType('String', 'rTCIceCandidatePairStatsDict.remoteCandidateId', rTCIceCandidatePairStatsDict.remoteCandidateId, {required: true});
//
// checkType('RTCStatsIceCandidatePairState', 'rTCIceCandidatePairStatsDict.state', rTCIceCandidatePairStatsDict.state, {required: true});
//
// checkType('int64', 'rTCIceCandidatePairStatsDict.priority', rTCIceCandidatePairStatsDict.priority, {required: true});
//
// checkType('boolean', 'rTCIceCandidatePairStatsDict.nominated', rTCIceCandidatePairStatsDict.nominated, {required: true});
//
// checkType('boolean', 'rTCIceCandidatePairStatsDict.writable', rTCIceCandidatePairStatsDict.writable, {required: true});
//
// checkType('boolean', 'rTCIceCandidatePairStatsDict.readable', rTCIceCandidatePairStatsDict.readable, {required: true});
//
// checkType('int64', 'rTCIceCandidatePairStatsDict.bytesSent', rTCIceCandidatePairStatsDict.bytesSent, {required: true});
//
// checkType('int64', 'rTCIceCandidatePairStatsDict.bytesReceived', rTCIceCandidatePairStatsDict.bytesReceived, {required: true});
//
// checkType('double', 'rTCIceCandidatePairStatsDict.roundTripTime', rTCIceCandidatePairStatsDict.roundTripTime, {required: true});
//
// checkType('double', 'rTCIceCandidatePairStatsDict.availableOutgoingBitrate', rTCIceCandidatePairStatsDict.availableOutgoingBitrate, {required: true});
//
// checkType('double', 'rTCIceCandidatePairStatsDict.availableIncomingBitrate', rTCIceCandidatePairStatsDict.availableIncomingBitrate, {required: true});
//
// Init parent class
RTCIceCandidatePairStats.super_.call(this, rTCIceCandidatePairStatsDict)
// Set object properties
Object.defineProperties(this, {
transportId: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.transportId
},
localCandidateId: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.localCandidateId
},
remoteCandidateId: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.remoteCandidateId
},
state: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.state
},
priority: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.priority
},
nominated: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.nominated
},
writable: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.writable
},
readable: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.readable
},
bytesSent: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.bytesSent
},
bytesReceived: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.bytesReceived
},
roundTripTime: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.roundTripTime
},
availableOutgoingBitrate: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.availableOutgoingBitrate
},
availableIncomingBitrate: {
writable: true,
enumerable: true,
value: rTCIceCandidatePairStatsDict.availableIncomingBitrate
}
})
}
inherits(RTCIceCandidatePairStats, 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(RTCIceCandidatePairStats.prototype, {
__module__: {
enumerable: true,
value: "kurento"
},
__type__: {
enumerable: true,
value: "RTCIceCandidatePairStats"
}
})
/**
* Checker for {@link module:core/complexTypes.RTCIceCandidatePairStats}
*
* @memberof module:core/complexTypes
*
* @param {external:String} key
* @param {module:core/complexTypes.RTCIceCandidatePairStats} value
*/
function checkRTCIceCandidatePairStats(key, value)
{
if(!(value instanceof RTCIceCandidatePairStats))
throw ChecktypeError(key, RTCIceCandidatePairStats, value);
};
module.exports = RTCIceCandidatePairStats;
RTCIceCandidatePairStats.check = checkRTCIceCandidatePairStats;