twilio-video
Version:
Twilio Video JavaScript Library
232 lines • 7.97 kB
JavaScript
'use strict';
const MediaSignaling = require('./mediasignaling');
const AsyncVar = require('../../util/asyncvar');
const Timeout = require('../../util/timeout');
const NETWORK_QUALITY_RESPONSE_TIME_MS = 5000;
/**
* @interface MediaSignalingTransport
* @property {function(object): boolean} send
* @emits MediaSignalingTransport#message
*/
/**
* The {@link MediaSignalingTransport} received a message.
* @event MediaSignalingTransport#message
* @param {object} message
*/
/**
* @interface LatencyStats
* @property {number} jitter
* @property {number} rtt
* @property {number} level
*/
/**
* @interface FractionLostStats
* @property {number} fractionLost
* @property {number} level
*/
/**
* @interface BandwidthStats
* @property {number} actual
* @property {number} available
* @property {number} level
*/
/**
* @interface SendOrRecvStats
* @property {BandwidthStats} bandwidth
* @property {FractionLostStats} fractionLost
* @property {LatencyStats} latency
*/
/**
* @interface MediaLevels
* @property {number} send
* @property {SendOrRecvStats} sendStats
* @property {number} recv
* @property {SendOrRecvStats} recvStats
*/
/**
* @interface NetworkQualityLevels
* @property {number} level
* @property {MediaLevels} audio
* @property {MediaLevels} video
*/
/**
* @typedef {PeerConnectionSummary} NetworkQualityInputs
*/
/**
* @classdesc The {@link NetworkQualitySignaling} class allows submitting
* {@link NetworkQualityInputs} for computing {@link NetworkQualityLevel}. It
* does so by sending and receiving messages over a
* {@link MediaSignalingTransport}. The exact transport used depends on the
* topology of the {@link Room} that {@link NetworkQualitySignaling} is being
* used within: for P2P Rooms, we re-use the {@link TransportV2}; and for
* Group Rooms, we use a {@link DataTransport}.
* @emits NetworkQualitySignaling#updated
*/
class NetworkQualitySignaling extends MediaSignaling {
/**
* Construct a {@link NetworkQualitySignaling}.
* @param {Promise<DataTrackReceiver>} getReceiver
* @param {NetworkQualityConfigurationImpl} networkQualityConfiguration
*/
constructor(getReceiver, networkQualityConfiguration, options) {
super(getReceiver, 'network_quality', options);
Object.defineProperties(this, {
_level: {
value: null,
writable: true
},
_levels: {
value: null,
writable: true
},
_remoteLevels: {
value: new Map(),
writable: true
},
_networkQualityInputs: {
value: new AsyncVar()
},
_resendTimer: {
value: new Timeout(() => {
// and schedule next timer at x1.5 the delay..
this._resendTimer.setDelay(this._resendTimer.delay * 1.5);
this._sendNetworkQualityInputs();
}, NETWORK_QUALITY_RESPONSE_TIME_MS, false),
},
_networkQualityReportLevels: {
get() {
return {
reportLevel: networkQualityConfiguration.local,
remoteReportLevel: networkQualityConfiguration.remote
};
}
}
});
this.on('ready', transport => {
transport.on('message', message => {
this._log.debug('Incoming: ', message);
switch (message.type) {
case 'network_quality':
this._handleNetworkQualityMessage(message);
break;
default:
break;
}
});
});
this._sendNetworkQualityInputs();
}
/**
* Get the current {@link NetworkQualityLevel}, if any.
* @returns {?NetworkQualityLevel} level - initially null
*/
get level() {
return this._level;
}
/**
* Get the current {@link NetworkQualityLevels}, if any.
* @returns {?NetworkQualityLevels} levels - initially null
*/
get levels() {
return this._levels;
}
/**
* Get the current {@link NetworkQualityLevels} of remote participants, if any.
* @returns {Map<String, NetworkQualityLevels>} remoteLevels
*/
get remoteLevels() {
return this._remoteLevels;
}
/**
* Check to see if the {@link NetworkQualityLevel} is new, and raise an
* event if necessary.
* @private
* @param {object} message
* @returns {void}
*/
_handleNetworkQualityMessage(message) {
let updated = false;
let level = null;
const local = message ? message.local : null;
if (typeof local === 'number') {
// NOTE(mroberts): In prod, we plan to only send the level.
level = local;
this._levels = null;
}
else if (typeof local === 'object' && local) {
// NOTE(mroberts): In dev, we plan to send the decomposed levels. An early
// VMS version does not compute `level` for us, so we fallback to taking
// the minimum ourselves.
this._levels = local;
level = typeof local.level === 'number'
? local.level
: Math.min(local.audio.send, local.audio.recv, local.video.send, local.video.recv);
}
if (level !== null && this.level !== level) {
this._level = level;
updated = true;
}
this._remoteLevels = message && message.remotes
? message.remotes.reduce((levels, obj) => {
const oldObj = this._remoteLevels.get(obj.sid) || {};
if (oldObj.level !== obj.level) {
updated = true;
}
return levels.set(obj.sid, obj);
}, new Map())
: this._remoteLevels;
if (updated) {
this.emit('updated');
}
// score is received. so reset the timer to default timeout.
this._resendTimer.setDelay(NETWORK_QUALITY_RESPONSE_TIME_MS);
// timer is cleared only while we are sending inputs.
// if we are already sending inputs do not send them again.
if (this._resendTimer.isSet) {
setTimeout(() => this._sendNetworkQualityInputs(), 1000);
}
}
/**
* Start sending {@link NetworkQualityInputs}.
* @private
* @returns {Promise<void>}
*/
_sendNetworkQualityInputs() {
this._resendTimer.clear();
return this._networkQualityInputs.take().then(networkQualityInputs => {
if (this._transport) {
this._transport.publish(createNetworkQualityInputsMessage(networkQualityInputs, this._networkQualityReportLevels));
}
}).finally(() => {
this._resendTimer.start();
});
}
/**
* Put {@link NetworkQualityInputs} to be used for computing
* {@link NetworkQualityLevel}.
* @param {NetworkQualityInputs} networkQualityInputs
* @returns {void}
*/
put(networkQualityInputs) {
this._networkQualityInputs.put(networkQualityInputs);
}
}
/**
* The {@link NetworkQualityLevel} changed.
* @event NetworkQualitySignaling#updated
*/
/**
* @typedef {object} NetworkQualityReportLevels
* @param {number} reportLevel
* @param {number} remoteReportLevel
*/
/**
* @param {NetworkQualityInputs} networkQualityInputs
* @param {NetworkQualityReportLevels} networkQualityReportLevels
* @returns {object} message
*/
function createNetworkQualityInputsMessage(networkQualityInputs, networkQualityReportLevels) {
return Object.assign({ type: 'network_quality' }, networkQualityInputs, networkQualityReportLevels);
}
module.exports = NetworkQualitySignaling;
//# sourceMappingURL=networkqualitysignaling.js.map