UNPKG

@twilio/voice-sdk

Version:
213 lines 16.5 kB
"use strict"; var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) { if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) { if (ar || !(i in from)) { if (!ar) ar = Array.prototype.slice.call(from, 0, i); ar[i] = from[i]; } } return to.concat(ar || Array.prototype.slice.call(from)); }; Object.defineProperty(exports, "__esModule", { value: true }); exports.getRTCStats = getRTCStats; exports.getRTCIceCandidateStatsReport = getRTCIceCandidateStatsReport; // @ts-nocheck // tslint:disable no-empty var errors_1 = require("../errors"); var mockrtcstatsreport_1 = require("./mockrtcstatsreport"); var ERROR_PEER_CONNECTION_NULL = 'PeerConnection is null'; var ERROR_WEB_RTC_UNSUPPORTED = 'WebRTC statistics are unsupported'; /** * Helper function to find a specific stat from a report. * Some environment provide the stats report as a map (regular browsers) * but some provide stats report as an array (citrix vdi) * @private */ function findStatById(report, id) { if (typeof report.get === 'function') { return report.get(id); } return report.find(function (s) { return s.id === id; }); } /** * Generate WebRTC statistics report for the given {@link PeerConnection} * @param {PeerConnection} peerConnection - Target connection. * @return {Promise<RTCStatsReport>} WebRTC RTCStatsReport object */ function getRTCStatsReport(peerConnection) { if (!peerConnection) { return Promise.reject(new errors_1.InvalidArgumentError(ERROR_PEER_CONNECTION_NULL)); } if (typeof peerConnection.getStats !== 'function') { return Promise.reject(new errors_1.NotSupportedError(ERROR_WEB_RTC_UNSUPPORTED)); } var promise; try { promise = peerConnection.getStats(); } catch (e) { promise = new Promise(function (resolve) { return peerConnection.getStats(resolve); }).then(mockrtcstatsreport_1.default.fromRTCStatsResponse); } return promise; } /** * @typedef {Object} StatsOptions * Used for testing to inject and extract methods. * @property {function} [createRTCSample] - Method for parsing an RTCStatsReport */ /** * Collects any WebRTC statistics for the given {@link PeerConnection} * @param {PeerConnection} peerConnection - Target connection. * @param {StatsOptions} options - List of custom options. * @return {Promise<RTCSample>} Universally-formatted version of RTC stats. */ function getRTCStats(peerConnection, options) { options = Object.assign({ createRTCSample: createRTCSample }, options); return getRTCStatsReport(peerConnection).then(options.createRTCSample); } /** * Generate WebRTC stats report containing relevant information about ICE candidates for the given {@link PeerConnection} * @param {PeerConnection} peerConnection - Target connection. * @return {Promise<RTCIceCandidateStatsReport>} RTCIceCandidateStatsReport object */ function getRTCIceCandidateStatsReport(peerConnection) { return getRTCStatsReport(peerConnection).then(function (report) { // Find the relevant information needed to determine selected candidates later var _a = Array.from(report.values()).reduce(function (rval, stat) { ['candidatePairs', 'localCandidates', 'remoteCandidates'].forEach(function (prop) { if (!rval[prop]) { rval[prop] = []; } }); switch (stat.type) { case 'candidate-pair': rval.candidatePairs.push(stat); break; case 'local-candidate': rval.localCandidates.push(stat); break; case 'remote-candidate': rval.remoteCandidates.push(stat); break; case 'transport': // This transport is the one being used if selectedCandidatePairId is populated if (stat.selectedCandidatePairId) { rval.transport = stat; } break; } return rval; }, {}), candidatePairs = _a.candidatePairs, localCandidates = _a.localCandidates, remoteCandidates = _a.remoteCandidates, transport = _a.transport; // This is a report containing information about the selected candidates, such as IDs // This is coming from WebRTC stats directly and doesn't contain the actual ICE Candidates info var selectedCandidatePairReport = candidatePairs.find(function (pair) { // Firefox return pair.selected || // Spec-compliant way (transport && pair.id === transport.selectedCandidatePairId); }); var selectedIceCandidatePairStats; if (selectedCandidatePairReport) { selectedIceCandidatePairStats = { localCandidate: localCandidates.find(function (candidate) { return candidate.id === selectedCandidatePairReport.localCandidateId; }), remoteCandidate: remoteCandidates.find(function (candidate) { return candidate.id === selectedCandidatePairReport.remoteCandidateId; }), }; } // Build the return object return { iceCandidateStats: __spreadArray(__spreadArray([], localCandidates, true), remoteCandidates, true), selectedIceCandidatePairStats: selectedIceCandidatePairStats, }; }); } /** * @typedef {Object} RTCSample - A sample containing relevant WebRTC stats information. * @property {Number} [timestamp] * @property {String} [codecName] - MimeType name of the codec being used by the outbound audio stream * @property {Number} [rtt] - Round trip time * @property {Number} [jitter] * @property {Number} [packetsSent] * @property {Number} [packetsLost] * @property {Number} [packetsReceived] * @property {Number} [bytesReceived] * @property {Number} [bytesSent] * @property {Number} [localAddress] * @property {Number} [remoteAddress] */ function RTCSample() { } /** * Create an RTCSample object from an RTCStatsReport * @private * @param {RTCStatsReport} statsReport * @returns {RTCSample} */ function createRTCSample(statsReport) { var activeTransportId = null; var sample = new RTCSample(); var fallbackTimestamp; Array.from(statsReport.values()).forEach(function (stats) { // Skip isRemote tracks which will be phased out completely and break in FF66. if (stats.isRemote) { return; } // Firefox hack -- Older firefox doesn't have dashes in type names var type = stats.type.replace('-', ''); fallbackTimestamp = fallbackTimestamp || stats.timestamp; // (rrowland) As I understand it, this is supposed to come in on remote-inbound-rtp but it's // currently coming in on remote-outbound-rtp, so I'm leaving this outside the switch until // the appropriate place to look is cleared up. if (stats.remoteId) { var remote = findStatById(statsReport, stats.remoteId); if (remote && remote.roundTripTime) { sample.rtt = remote.roundTripTime * 1000; } } switch (type) { case 'inboundrtp': sample.timestamp = sample.timestamp || stats.timestamp; sample.jitter = stats.jitter * 1000; sample.packetsLost = stats.packetsLost; sample.packetsReceived = stats.packetsReceived; sample.bytesReceived = stats.bytesReceived; break; case 'outboundrtp': sample.timestamp = stats.timestamp; sample.packetsSent = stats.packetsSent; sample.bytesSent = stats.bytesSent; if (stats.codecId) { var codec = findStatById(statsReport, stats.codecId); sample.codecName = codec ? codec.mimeType && codec.mimeType.match(/(.*\/)?(.*)/)[2] : stats.codecId; } break; case 'transport': activeTransportId = stats.id; break; } }); if (!sample.timestamp) { sample.timestamp = fallbackTimestamp; } var activeTransport = findStatById(statsReport, activeTransportId); if (!activeTransport) { return sample; } var selectedCandidatePair = findStatById(statsReport, activeTransport.selectedCandidatePairId); if (!selectedCandidatePair) { return sample; } var localCandidate = findStatById(statsReport, selectedCandidatePair.localCandidateId); var remoteCandidate = findStatById(statsReport, selectedCandidatePair.remoteCandidateId); if (!sample.rtt) { sample.rtt = selectedCandidatePair && (selectedCandidatePair.currentRoundTripTime * 1000); } Object.assign(sample, { // ip is deprecated. use address first then ip if on older versions of browser localAddress: localCandidate && (localCandidate.address || localCandidate.ip), remoteAddress: remoteCandidate && (remoteCandidate.address || remoteCandidate.ip), }); return sample; } //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9saWIvdHdpbGlvL3J0Yy9zdGF0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7OztBQWtPRSxrQ0FBVztBQUNYLHNFQUE2QjtBQW5PL0IsY0FBYztBQUNkLDBCQUEwQjtBQUMxQixvQ0FBb0U7QUFDcEUsMkRBQXNEO0FBRXRELElBQU0sMEJBQTBCLEdBQUcsd0JBQXdCLENBQUM7QUFDNUQsSUFBTSx5QkFBeUIsR0FBRyxtQ0FBbUMsQ0FBQztBQUV0RTs7Ozs7R0FLRztBQUNILFNBQVMsWUFBWSxDQUFDLE1BQU0sRUFBRSxFQUFFO0lBQzlCLElBQUksT0FBTyxNQUFNLENBQUMsR0FBRyxLQUFLLFVBQVUsRUFBRSxDQUFDO1FBQ3JDLE9BQU8sTUFBTSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUN4QixDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQUEsQ0FBQyxJQUFJLE9BQUEsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQVgsQ0FBVyxDQUFDLENBQUM7QUFDdkMsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxTQUFTLGlCQUFpQixDQUFDLGNBQWM7SUFDdkMsSUFBSSxDQUFDLGNBQWMsRUFBRSxDQUFDO1FBQ3BCLE9BQU8sT0FBTyxDQUFDLE1BQU0sQ0FBQyxJQUFJLDZCQUFvQixDQUFDLDBCQUEwQixDQUFDLENBQUMsQ0FBQztJQUM5RSxDQUFDO0lBRUQsSUFBSSxPQUFPLGNBQWMsQ0FBQyxRQUFRLEtBQUssVUFBVSxFQUFFLENBQUM7UUFDbEQsT0FBTyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksMEJBQWlCLENBQUMseUJBQXlCLENBQUMsQ0FBQyxDQUFDO0lBQzFFLENBQUM7SUFFRCxJQUFJLE9BQU8sQ0FBQztJQUNaLElBQUksQ0FBQztRQUNILE9BQU8sR0FBRyxjQUFjLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDdEMsQ0FBQztJQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7UUFDWCxPQUFPLEdBQUcsSUFBSSxPQUFPLENBQUMsVUFBQSxPQUFPLElBQUksT0FBQSxjQUFjLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxFQUFoQyxDQUFnQyxDQUFDLENBQUMsSUFBSSxDQUFDLDRCQUFrQixDQUFDLG9CQUFvQixDQUFDLENBQUM7SUFDbkgsQ0FBQztJQUVELE9BQU8sT0FBTyxDQUFDO0FBQ2pCLENBQUM7QUFFRDs7OztHQUlHO0FBQ0g7Ozs7O0dBS0c7QUFDSCxTQUFTLFdBQVcsQ0FBQyxjQUFjLEVBQUUsT0FBTztJQUMxQyxPQUFPLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxFQUFFLGVBQWUsaUJBQUEsRUFBRSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBRXRELE9BQU8saUJBQWlCLENBQUMsY0FBYyxDQUFDLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztBQUN6RSxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQVMsNkJBQTZCLENBQUMsY0FBYztJQUNuRCxPQUFPLGlCQUFpQixDQUFDLGNBQWMsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFDLE1BQU07UUFDbkQsOEVBQThFO1FBQ3hFLElBQUEsS0FFRixLQUFLLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxVQUFDLElBQUksRUFBRSxJQUFJO1lBQ2hELENBQUMsZ0JBQWdCLEVBQUUsaUJBQWlCLEVBQUUsa0JBQWtCLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBQyxJQUFJO2dCQUNyRSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7b0JBQ2hCLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7Z0JBQ2xCLENBQUM7WUFDSCxDQUFDLENBQUMsQ0FBQztZQUVILFFBQVEsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO2dCQUNsQixLQUFLLGdCQUFnQjtvQkFDbkIsSUFBSSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7b0JBQy9CLE1BQU07Z0JBQ1IsS0FBSyxpQkFBaUI7b0JBQ3BCLElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNoQyxNQUFNO2dCQUNSLEtBQUssa0JBQWtCO29CQUNyQixJQUFJLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNqQyxNQUFNO2dCQUNSLEtBQUssV0FBVztvQkFDZCwrRUFBK0U7b0JBQy9FLElBQUksSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUM7d0JBQ2pDLElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDO29CQUN4QixDQUFDO29CQUNELE1BQU07WUFDVixDQUFDO1lBRUQsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDLEVBQUUsRUFBRSxDQUFDLEVBM0JKLGNBQWMsb0JBQUEsRUFBRSxlQUFlLHFCQUFBLEVBQUUsZ0JBQWdCLHNCQUFBLEVBQUUsU0FBUyxlQTJCeEQsQ0FBQztRQUVQLHFGQUFxRjtRQUNyRiwrRkFBK0Y7UUFDL0YsSUFBTSwyQkFBMkIsR0FBRyxjQUFjLENBQUMsSUFBSSxDQUFDLFVBQUEsSUFBSTtZQUMxRCxVQUFVO1lBQ1YsT0FBQSxJQUFJLENBQUMsUUFBUTtnQkFDYixxQkFBcUI7Z0JBQ3JCLENBQUMsU0FBUyxJQUFJLElBQUksQ0FBQyxFQUFFLEtBQUssU0FBUyxDQUFDLHVCQUF1QixDQUFDO1FBRjVELENBRTRELENBQUMsQ0FBQztRQUVoRSxJQUFJLDZCQUE2QixDQUFDO1FBQ2xDLElBQUksMkJBQTJCLEVBQUUsQ0FBQztZQUNoQyw2QkFBNkIsR0FBRztnQkFDOUIsY0FBYyxFQUFFLGVBQWUsQ0FBQyxJQUFJLENBQUMsVUFBQSxTQUFTLElBQUksT0FBQSxTQUFTLENBQUMsRUFBRSxLQUFLLDJCQUEyQixDQUFDLGdCQUFnQixFQUE3RCxDQUE2RCxDQUFDO2dCQUNoSCxlQUFlLEVBQUUsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLFVBQUEsU0FBUyxJQUFJLE9BQUEsU0FBUyxDQUFDLEVBQUUsS0FBSywyQkFBMkIsQ0FBQyxpQkFBaUIsRUFBOUQsQ0FBOEQsQ0FBQzthQUNwSCxDQUFDO1FBQ0osQ0FBQztRQUVELDBCQUEwQjtRQUMxQixPQUFPO1lBQ0wsaUJBQWlCLGtDQUFNLGVBQWUsU0FBSyxnQkFBZ0IsT0FBQztZQUM1RCw2QkFBNkIsK0JBQUE7U0FDOUIsQ0FBQztJQUNKLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVEOzs7Ozs7Ozs7Ozs7O0dBYUc7QUFDSCxTQUFTLFNBQVMsS0FBSyxDQUFDO0FBRXhCOzs7OztHQUtHO0FBQ0gsU0FBUyxlQUFlLENBQUMsV0FBVztJQUNsQyxJQUFJLGlCQUFpQixHQUFHLElBQUksQ0FBQztJQUM3QixJQUFNLE1BQU0sR0FBRyxJQUFJLFNBQVMsRUFBRSxDQUFDO0lBQy9CLElBQUksaUJBQWlCLENBQUM7SUFFdEIsS0FBSyxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBQSxLQUFLO1FBQzVDLDhFQUE4RTtRQUM5RSxJQUFJLEtBQUssQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUFDLE9BQU87UUFBQyxDQUFDO1FBRS9CLGtFQUFrRTtRQUNsRSxJQUFNLElBQUksR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFFekMsaUJBQWlCLEdBQUcsaUJBQWlCLElBQUksS0FBSyxDQUFDLFNBQVMsQ0FBQztRQUV6RCw0RkFBNEY7UUFDNUYsMkZBQTJGO1FBQzNGLCtDQUErQztRQUMvQyxJQUFJLEtBQUssQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNuQixJQUFNLE1BQU0sR0FBRyxZQUFZLENBQUMsV0FBVyxFQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUN6RCxJQUFJLE1BQU0sSUFBSSxNQUFNLENBQUMsYUFBYSxFQUFFLENBQUM7Z0JBQ25DLE1BQU0sQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFDLGFBQWEsR0FBRyxJQUFJLENBQUM7WUFDM0MsQ0FBQztRQUNILENBQUM7UUFFRCxRQUFRLElBQUksRUFBRSxDQUFDO1lBQ2IsS0FBSyxZQUFZO2dCQUNmLE1BQU0sQ0FBQyxTQUFTLEdBQUcsTUFBTSxDQUFDLFNBQVMsSUFBSSxLQUFLLENBQUMsU0FBUyxDQUFDO2dCQUN2RCxNQUFNLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQyxNQUFNLEdBQUcsSUFBSSxDQUFDO2dCQUNwQyxNQUFNLENBQUMsV0FBVyxHQUFHLEtBQUssQ0FBQyxXQUFXLENBQUM7Z0JBQ3ZDLE1BQU0sQ0FBQyxlQUFlLEdBQUcsS0FBSyxDQUFDLGVBQWUsQ0FBQztnQkFDL0MsTUFBTSxDQUFDLGFBQWEsR0FBRyxLQUFLLENBQUMsYUFBYSxDQUFDO2dCQUUzQyxNQUFNO1lBQ1IsS0FBSyxhQUFhO2dCQUNoQixNQUFNLENBQUMsU0FBUyxHQUFHLEtBQUssQ0FBQyxTQUFTLENBQUM7Z0JBQ25DLE1BQU0sQ0FBQyxXQUFXLEdBQUcsS0FBSyxDQUFDLFdBQVcsQ0FBQztnQkFDdkMsTUFBTSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFDO2dCQUVuQyxJQUFJLEtBQUssQ0FBQyxPQUFPLEVBQUUsQ0FBQztvQkFDbEIsSUFBTSxLQUFLLEdBQUcsWUFBWSxDQUFDLFdBQVcsRUFBRSxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7b0JBQ3ZELE1BQU0sQ0FBQyxTQUFTLEdBQUcsS0FBSzt3QkFDdEIsQ0FBQyxDQUFDLEtBQUssQ0FBQyxRQUFRLElBQUksS0FBSyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDO3dCQUMxRCxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQztnQkFDcEIsQ0FBQztnQkFFRCxNQUFNO1lBQ1IsS0FBSyxXQUFXO2dCQUNkLGlCQUFpQixHQUFHLEtBQUssQ0FBQyxFQUFFLENBQUM7Z0JBQzdCLE1BQU07UUFDVixDQUFDO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFFSCxJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3RCLE1BQU0sQ0FBQyxTQUFTLEdBQUcsaUJBQWlCLENBQUM7SUFDdkMsQ0FBQztJQUVELElBQU0sZUFBZSxHQUFHLFlBQVksQ0FBQyxXQUFXLEVBQUUsaUJBQWlCLENBQUMsQ0FBQztJQUNyRSxJQUFJLENBQUMsZUFBZSxFQUFFLENBQUM7UUFBQyxPQUFPLE1BQU0sQ0FBQztJQUFDLENBQUM7SUFFeEMsSUFBTSxxQkFBcUIsR0FBRyxZQUFZLENBQUMsV0FBVyxFQUFFLGVBQWUsQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO0lBQ2pHLElBQUksQ0FBQyxxQkFBcUIsRUFBRSxDQUFDO1FBQUMsT0FBTyxNQUFNLENBQUM7SUFBQyxDQUFDO0lBRTlDLElBQU0sY0FBYyxHQUFHLFlBQVksQ0FBQyxXQUFXLEVBQUUscUJBQXFCLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztJQUN6RixJQUFNLGVBQWUsR0FBRyxZQUFZLENBQUMsV0FBVyxFQUFFLHFCQUFxQixDQUFDLGlCQUFpQixDQUFDLENBQUM7SUFFM0YsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNoQixNQUFNLENBQUMsR0FBRyxHQUFHLHFCQUFxQjtZQUNoQyxDQUFDLHFCQUFxQixDQUFDLG9CQUFvQixHQUFHLElBQUksQ0FBQyxDQUFDO0lBQ3hELENBQUM7SUFFRCxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRTtRQUNwQiw4RUFBOEU7UUFDOUUsWUFBWSxFQUFFLGNBQWMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxPQUFPLElBQUksY0FBYyxDQUFDLEVBQUUsQ0FBQztRQUM3RSxhQUFhLEVBQUUsZUFBZSxJQUFJLENBQUMsZUFBZSxDQUFDLE9BQU8sSUFBSSxlQUFlLENBQUMsRUFBRSxDQUFDO0tBQ2xGLENBQUMsQ0FBQztJQUVILE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMifQ==