@webex/plugin-meetings 3.7.0-wxcc.1 → 3.8.0

package/dist/rtcMetrics/index.js

@@ -0,0 +1,197 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+var _internalPluginMetrics = require("@webex/internal-plugin-metrics");
+var _uuid = _interopRequireDefault(require("uuid"));
+var _constants = _interopRequireDefault(require("./constants"));
+/* eslint-disable class-methods-use-this */
+
+var parseJsonPayload = function parseJsonPayload(payload) {
+  try {
+    if (payload && payload[0]) {
+      return JSON.parse(payload[0]);
+    }
+    return null;
+  } catch (_) {
+    return null;
+  }
+};
+
+/**
+ * Rtc Metrics
+ */
+var RtcMetrics = exports.default = /*#__PURE__*/function () {
+  /**
+   * Initialize the interval.
+   *
+   * @param {object} webex - The main `webex` object.
+   * @param {string} meetingId - The meeting id.
+   * @param {string} correlationId - The correlation id.
+   */
+  function RtcMetrics(webex, meetingId, correlationId) {
+    (0, _classCallCheck2.default)(this, RtcMetrics);
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    (0, _defineProperty2.default)(this, "metricsQueue", []);
+    (0, _defineProperty2.default)(this, "intervalId", void 0);
+    (0, _defineProperty2.default)(this, "webex", void 0);
+    (0, _defineProperty2.default)(this, "meetingId", void 0);
+    (0, _defineProperty2.default)(this, "correlationId", void 0);
+    (0, _defineProperty2.default)(this, "connectionId", void 0);
+    (0, _defineProperty2.default)(this, "shouldSendMetricsOnNextStatsReport", void 0);
+    // `window` is used to prevent typescript from returning a NodeJS.Timer.
+    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
+    this.meetingId = meetingId;
+    this.webex = webex;
+    this.correlationId = correlationId;
+    this.resetConnection();
+  }
+
+  /**
+   * Check to see if the metrics queue has any items.
+   *
+   * @returns {void}
+   */
+  (0, _createClass2.default)(RtcMetrics, [{
+    key: "sendMetricsInQueue",
+    value: function sendMetricsInQueue() {
+      if (this.metricsQueue.length) {
+        this.sendMetrics();
+        this.metricsQueue = [];
+      }
+    }
+
+    /**
+     * Forces sending metrics when we get the next stats-report
+     *
+     * This is useful for cases when something important happens that affects the media connection,
+     * for example when we move from lobby into the meeting.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "sendNextMetrics",
+    value: function sendNextMetrics() {
+      this.shouldSendMetricsOnNextStatsReport = true;
+    }
+
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "addMetrics",
+    value: function addMetrics(data) {
+      if (data.payload.length) {
+        if (data.name === 'stats-report') {
+          data.payload = data.payload.map(this.anonymizeIp);
+        }
+        this.metricsQueue.push(data);
+        if (this.shouldSendMetricsOnNextStatsReport && data.name === 'stats-report') {
+          // this is the first useful set of data (WCME gives it to us after 5s), send it out immediately
+          // in case the user is unhappy and closes the browser early
+          this.sendMetricsInQueue();
+          this.shouldSendMetricsOnNextStatsReport = false;
+        }
+        try {
+          // If a connection fails, send the rest of the metrics in queue and get a new connection id.
+          var parsedPayload = parseJsonPayload(data.payload);
+          if (data.name === 'onconnectionstatechange' && parsedPayload && parsedPayload.value === 'failed') {
+            this.sendMetricsInQueue();
+            this.resetConnection();
+          }
+        } catch (e) {
+          console.error(e);
+        }
+      }
+    }
+
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "closeMetrics",
+    value: function closeMetrics() {
+      this.sendMetricsInQueue();
+      clearInterval(this.intervalId);
+    }
+
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+  }, {
+    key: "anonymizeIp",
+    value: function anonymizeIp(stats) {
+      var data = JSON.parse(stats);
+      // on local and remote candidates, anonymize the last 4 bits.
+      if (data.type === 'local-candidate' || data.type === 'remote-candidate') {
+        data.ip = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;
+        data.address = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;
+        data.relatedAddress = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;
+      }
+      return (0, _stringify.default)(data);
+    }
+
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "resetConnection",
+    value: function resetConnection() {
+      this.connectionId = _uuid.default.v4();
+      this.shouldSendMetricsOnNextStatsReport = true;
+    }
+
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "sendMetrics",
+    value: function sendMetrics() {
+      this.webex.request({
+        method: 'POST',
+        service: 'unifiedTelemetry',
+        resource: 'metric/v2',
+        headers: {
+          type: 'webrtcMedia',
+          appId: _constants.default.APP_ID
+        },
+        body: {
+          metrics: [{
+            type: 'webrtc',
+            version: '1.1.0',
+            userId: this.webex.internal.device.userId,
+            meetingId: this.meetingId,
+            correlationId: this.correlationId,
+            connectionId: this.connectionId,
+            data: this.metricsQueue
+          }]
+        }
+      });
+    }
+  }]);
+  return RtcMetrics;
+}();
+//# sourceMappingURL=index.js.map

package/dist/rtcMetrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_internalPluginMetrics","require","_uuid","_interopRequireDefault","_constants","parseJsonPayload","payload","JSON","parse","_","RtcMetrics","exports","default","webex","meetingId","correlationId","_classCallCheck2","_defineProperty2","intervalId","window","setInterval","sendMetricsInQueue","bind","resetConnection","_createClass2","key","value","metricsQueue","length","sendMetrics","sendNextMetrics","shouldSendMetricsOnNextStatsReport","addMetrics","data","name","map","anonymizeIp","push","parsedPayload","e","console","error","closeMetrics","clearInterval","stats","type","ip","CallDiagnosticUtils","anonymizeIPAddress","undefined","address","relatedAddress","_stringify","connectionId","uuid","v4","request","method","service","resource","headers","appId","RTC_METRICS","APP_ID","body","metrics","version","userId","internal","device"],"sources":["index.ts"],"sourcesContent":["/* eslint-disable class-methods-use-this */\nimport {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';\nimport uuid from 'uuid';\nimport RTC_METRICS from './constants';\n\nconst parseJsonPayload = (payload: any[]): any | null => {\n  try {\n    if (payload && payload[0]) {\n      return JSON.parse(payload[0]);\n    }\n\n    return null;\n  } catch (_) {\n    return null;\n  }\n};\n\n/**\n * Rtc Metrics\n */\nexport default class RtcMetrics {\n  /**\n   * Array of MetricData items to be sent to the metrics service.\n   */\n  metricsQueue = [];\n\n  intervalId: number;\n\n  webex: any;\n\n  meetingId: string;\n\n  correlationId: string;\n\n  connectionId: string;\n\n  shouldSendMetricsOnNextStatsReport: boolean;\n\n  /**\n   * Initialize the interval.\n   *\n   * @param {object} webex - The main `webex` object.\n   * @param {string} meetingId - The meeting id.\n   * @param {string} correlationId - The correlation id.\n   */\n  constructor(webex, meetingId, correlationId) {\n    // `window` is used to prevent typescript from returning a NodeJS.Timer.\n    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);\n    this.meetingId = meetingId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    this.resetConnection();\n  }\n\n  /**\n   * Check to see if the metrics queue has any items.\n   *\n   * @returns {void}\n   */\n  public sendMetricsInQueue() {\n    if (this.metricsQueue.length) {\n      this.sendMetrics();\n      this.metricsQueue = [];\n    }\n  }\n\n  /**\n   * Forces sending metrics when we get the next stats-report\n   *\n   * This is useful for cases when something important happens that affects the media connection,\n   * for example when we move from lobby into the meeting.\n   *\n   * @returns {void}\n   */\n  public sendNextMetrics() {\n    this.shouldSendMetricsOnNextStatsReport = true;\n  }\n\n  /**\n   * Add metrics items to the metrics queue.\n   *\n   * @param {object} data - An object with a payload array of metrics items.\n   *\n   * @returns {void}\n   */\n  addMetrics(data) {\n    if (data.payload.length) {\n      if (data.name === 'stats-report') {\n        data.payload = data.payload.map(this.anonymizeIp);\n      }\n\n      this.metricsQueue.push(data);\n\n      if (this.shouldSendMetricsOnNextStatsReport && data.name === 'stats-report') {\n        // this is the first useful set of data (WCME gives it to us after 5s), send it out immediately\n        // in case the user is unhappy and closes the browser early\n        this.sendMetricsInQueue();\n        this.shouldSendMetricsOnNextStatsReport = false;\n      }\n\n      try {\n        // If a connection fails, send the rest of the metrics in queue and get a new connection id.\n        const parsedPayload = parseJsonPayload(data.payload);\n        if (\n          data.name === 'onconnectionstatechange' &&\n          parsedPayload &&\n          parsedPayload.value === 'failed'\n        ) {\n          this.sendMetricsInQueue();\n          this.resetConnection();\n        }\n      } catch (e) {\n        console.error(e);\n      }\n    }\n  }\n\n  /**\n   * Clear the metrics interval.\n   *\n   * @returns {void}\n   */\n  closeMetrics() {\n    this.sendMetricsInQueue();\n    clearInterval(this.intervalId);\n  }\n\n  /**\n   * Anonymize IP addresses.\n   *\n   * @param {array} stats - An RTCStatsReport organized into an array of strings.\n   * @returns {string}\n   */\n  anonymizeIp(stats: string): string {\n    const data = JSON.parse(stats);\n    // on local and remote candidates, anonymize the last 4 bits.\n    if (data.type === 'local-candidate' || data.type === 'remote-candidate') {\n      data.ip = CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;\n      data.address = CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;\n      data.relatedAddress =\n        CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;\n    }\n\n    return JSON.stringify(data);\n  }\n\n  /**\n   * Set a new connection id.\n   *\n   * @returns {void}\n   */\n  private resetConnection() {\n    this.connectionId = uuid.v4();\n    this.shouldSendMetricsOnNextStatsReport = true;\n  }\n\n  /**\n   * Send metrics to the metrics service.\n   *\n   * @returns {void}\n   */\n  private sendMetrics() {\n    this.webex.request({\n      method: 'POST',\n      service: 'unifiedTelemetry',\n      resource: 'metric/v2',\n      headers: {\n        type: 'webrtcMedia',\n        appId: RTC_METRICS.APP_ID,\n      },\n      body: {\n        metrics: [\n          {\n            type: 'webrtc',\n            version: '1.1.0',\n            userId: this.webex.internal.device.userId,\n            meetingId: this.meetingId,\n            correlationId: this.correlationId,\n            connectionId: this.connectionId,\n            data: this.metricsQueue,\n          },\n        ],\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;AACA,IAAAA,sBAAA,GAAAC,OAAA;AACA,IAAAC,KAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAD,sBAAA,CAAAF,OAAA;AAHA;;AAKA,IAAMI,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,OAAc,EAAiB;EACvD,IAAI;IACF,IAAIA,OAAO,IAAIA,OAAO,CAAC,CAAC,CAAC,EAAE;MACzB,OAAOC,IAAI,CAACC,KAAK,CAACF,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B;IAEA,OAAO,IAAI;EACb,CAAC,CAAC,OAAOG,CAAC,EAAE;IACV,OAAO,IAAI;EACb;AACF,CAAC;;AAED;AACA;AACA;AAFA,IAGqBC,UAAU,GAAAC,OAAA,CAAAC,OAAA;EAkB7B;AACF;AACA;AACA;AACA;AACA;AACA;EACE,SAAAF,WAAYG,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA,IAAAC,gBAAA,CAAAJ,OAAA,QAAAF,UAAA;IAxB7C;AACF;AACA;IAFE,IAAAO,gBAAA,CAAAL,OAAA,wBAGe,EAAE;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAsBf;IACA,IAAI,CAACM,UAAU,GAAGC,MAAM,CAACC,WAAW,CAAC,IAAI,CAACC,kBAAkB,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IACnF,IAAI,CAACR,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACD,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC,IAAI,CAACQ,eAAe,CAAC,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;EAJE,IAAAC,aAAA,CAAAZ,OAAA,EAAAF,UAAA;IAAAe,GAAA;IAAAC,KAAA,EAKA,SAAAL,mBAAA,EAA4B;MAC1B,IAAI,IAAI,CAACM,YAAY,CAACC,MAAM,EAAE;QAC5B,IAAI,CAACC,WAAW,CAAC,CAAC;QAClB,IAAI,CAACF,YAAY,GAAG,EAAE;MACxB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAF,GAAA;IAAAC,KAAA,EAQA,SAAAI,gBAAA,EAAyB;MACvB,IAAI,CAACC,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAN,GAAA;IAAAC,KAAA,EAOA,SAAAM,WAAWC,IAAI,EAAE;MACf,IAAIA,IAAI,CAAC3B,OAAO,CAACsB,MAAM,EAAE;QACvB,IAAIK,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAChCD,IAAI,CAAC3B,OAAO,GAAG2B,IAAI,CAAC3B,OAAO,CAAC6B,GAAG,CAAC,IAAI,CAACC,WAAW,CAAC;QACnD;QAEA,IAAI,CAACT,YAAY,CAACU,IAAI,CAACJ,IAAI,CAAC;QAE5B,IAAI,IAAI,CAACF,kCAAkC,IAAIE,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAC3E;UACA;UACA,IAAI,CAACb,kBAAkB,CAAC,CAAC;UACzB,IAAI,CAACU,kCAAkC,GAAG,KAAK;QACjD;QAEA,IAAI;UACF;UACA,IAAMO,aAAa,GAAGjC,gBAAgB,CAAC4B,IAAI,CAAC3B,OAAO,CAAC;UACpD,IACE2B,IAAI,CAACC,IAAI,KAAK,yBAAyB,IACvCI,aAAa,IACbA,aAAa,CAACZ,KAAK,KAAK,QAAQ,EAChC;YACA,IAAI,CAACL,kBAAkB,CAAC,CAAC;YACzB,IAAI,CAACE,eAAe,CAAC,CAAC;UACxB;QACF,CAAC,CAAC,OAAOgB,CAAC,EAAE;UACVC,OAAO,CAACC,KAAK,CAACF,CAAC,CAAC;QAClB;MACF;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAd,GAAA;IAAAC,KAAA,EAKA,SAAAgB,aAAA,EAAe;MACb,IAAI,CAACrB,kBAAkB,CAAC,CAAC;MACzBsB,aAAa,CAAC,IAAI,CAACzB,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAO,GAAA;IAAAC,KAAA,EAMA,SAAAU,YAAYQ,KAAa,EAAU;MACjC,IAAMX,IAAI,GAAG1B,IAAI,CAACC,KAAK,CAACoC,KAAK,CAAC;MAC9B;MACA,IAAIX,IAAI,CAACY,IAAI,KAAK,iBAAiB,IAAIZ,IAAI,CAACY,IAAI,KAAK,kBAAkB,EAAE;QACvEZ,IAAI,CAACa,EAAE,GAAGC,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACa,EAAE,CAAC,IAAIG,SAAS;QACtEhB,IAAI,CAACiB,OAAO,GAAGH,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACiB,OAAO,CAAC,IAAID,SAAS;QAChFhB,IAAI,CAACkB,cAAc,GACjBJ,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACkB,cAAc,CAAC,IAAIF,SAAS;MAC5E;MAEA,OAAO,IAAAG,UAAA,CAAAxC,OAAA,EAAeqB,IAAI,CAAC;IAC7B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAR,GAAA;IAAAC,KAAA,EAKA,SAAAH,gBAAA,EAA0B;MACxB,IAAI,CAAC8B,YAAY,GAAGC,aAAI,CAACC,EAAE,CAAC,CAAC;MAC7B,IAAI,CAACxB,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAN,GAAA;IAAAC,KAAA,EAKA,SAAAG,YAAA,EAAsB;MACpB,IAAI,CAAChB,KAAK,CAAC2C,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPf,IAAI,EAAE,aAAa;UACnBgB,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEpB,IAAI,EAAE,QAAQ;YACdqB,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAACtD,KAAK,CAACuD,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzCrD,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCsC,YAAY,EAAE,IAAI,CAACA,YAAY;YAC/BpB,IAAI,EAAE,IAAI,CAACN;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA,OAAAjB,UAAA;AAAA"}

package/dist/statsAnalyzer/global.d.ts

@@ -0,0 +1,36 @@
+declare const STATS_DEFAULT: {
+    encryption: string;
+    bandwidth: {
+        systemBandwidth: number;
+        sentPerSecond: number;
+        encodedPerSecond: number;
+        helper: {
+            audioBytesSent: number;
+            videoBytestSent: number;
+        };
+        speed: number;
+    };
+    results: {};
+    connectionType: {
+        systemNetworkType: string;
+        systemIpAddress: string;
+        local: {
+            candidateType: any[];
+            transport: any[];
+            ipAddress: any[];
+            networkType: any[];
+        };
+        remote: {
+            candidateType: any[];
+            transport: any[];
+            ipAddress: any[];
+            networkType: any[];
+        };
+    };
+    resolutions: {};
+    internal: {
+        remote: {};
+        candidates: {};
+    };
+};
+export default STATS_DEFAULT;

package/dist/statsAnalyzer/global.js

@@ -0,0 +1,126 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var STATS_DEFAULT = {
+  encryption: 'sha-256',
+  audio: {
+    send: {
+      maxPacketLossRatio: 0,
+      availableBandwidth: 0,
+      bytesSent: 0,
+      meanRemoteJitter: [],
+      meanRoundTripTime: []
+    },
+    recv: {
+      availableBandwidth: 0,
+      bytesReceived: 0,
+      meanRtpJitter: [],
+      meanRoundTripTime: []
+    }
+  },
+  video: {
+    send: {
+      maxPacketLossRatio: 0,
+      availableBandwidth: 0,
+      meanRemoteJitter: [],
+      meanRoundTripTime: []
+    },
+    recv: {
+      availableBandwidth: 0,
+      totalPacketsLost: 0,
+      meanRtpJitter: [],
+      meanRoundTripTime: []
+    },
+    latency: 0,
+    packetsLost: 0
+  },
+  share: {
+    send: {
+      maxPacketLossRatio: 0,
+      availableBandwidth: 0,
+      totalPacketsLost: 0,
+      meanRemoteJitter: [],
+      meanRoundTripTime: []
+    },
+    recv: {
+      availableBandwidth: 0,
+      meanRtpJitter: [],
+      meanRoundTripTime: []
+    },
+    latency: 0,
+    packetsLost: 0
+  },
+  bandwidth: {
+    systemBandwidth: 0,
+    sentPerSecond: 0,
+    encodedPerSecond: 0,
+    helper: {
+      audioBytesSent: 0,
+      videoBytestSent: 0
+    },
+    speed: 0
+  },
+  results: {},
+  connectionType: {
+    systemNetworkType: 'unknown',
+    systemIpAddress: '0.0.0.0',
+    local: {
+      candidateType: [],
+      transport: [],
+      ipAddress: [],
+      networkType: []
+    },
+    remote: {
+      candidateType: [],
+      transport: [],
+      ipAddress: [],
+      networkType: []
+    }
+  },
+  resolutions: {
+    video: {
+      send: {
+        width: 0,
+        height: 0,
+        framesSent: 0
+      },
+      recv: {
+        width: 0,
+        height: 0
+      }
+    },
+    share: {
+      send: {
+        width: 0,
+        height: 0,
+        framesSent: 0
+      },
+      recv: {
+        width: 0,
+        height: 0
+      }
+    }
+  },
+  internal: {
+    audio: {
+      send: {},
+      recv: {}
+    },
+    video: {
+      send: {},
+      recv: {}
+    },
+    share: {
+      send: {},
+      recv: {}
+    },
+    remote: {},
+    candidates: {}
+  }
+};
+var _default = exports.default = STATS_DEFAULT;
+//# sourceMappingURL=global.js.map

package/dist/statsAnalyzer/global.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["STATS_DEFAULT","encryption","audio","send","maxPacketLossRatio","availableBandwidth","bytesSent","meanRemoteJitter","meanRoundTripTime","recv","bytesReceived","meanRtpJitter","video","totalPacketsLost","latency","packetsLost","share","bandwidth","systemBandwidth","sentPerSecond","encodedPerSecond","helper","audioBytesSent","videoBytestSent","speed","results","connectionType","systemNetworkType","systemIpAddress","local","candidateType","transport","ipAddress","networkType","remote","resolutions","width","height","framesSent","internal","candidates","_default","exports","default"],"sources":["global.ts"],"sourcesContent":["const STATS_DEFAULT = {\n  encryption: 'sha-256',\n  audio: {\n    send: {\n      maxPacketLossRatio: 0,\n      availableBandwidth: 0,\n      bytesSent: 0,\n      meanRemoteJitter: [],\n      meanRoundTripTime: [],\n    },\n    recv: {\n      availableBandwidth: 0,\n      bytesReceived: 0,\n      meanRtpJitter: [],\n      meanRoundTripTime: [],\n    },\n  },\n  video: {\n    send: {\n      maxPacketLossRatio: 0,\n      availableBandwidth: 0,\n      meanRemoteJitter: [],\n      meanRoundTripTime: [],\n    },\n    recv: {\n      availableBandwidth: 0,\n      totalPacketsLost: 0,\n      meanRtpJitter: [],\n      meanRoundTripTime: [],\n    },\n    latency: 0,\n    packetsLost: 0,\n  },\n  share: {\n    send: {\n      maxPacketLossRatio: 0,\n      availableBandwidth: 0,\n      totalPacketsLost: 0,\n      meanRemoteJitter: [],\n      meanRoundTripTime: [],\n    },\n    recv: {\n      availableBandwidth: 0,\n      meanRtpJitter: [],\n      meanRoundTripTime: [],\n    },\n\n    latency: 0,\n    packetsLost: 0,\n  },\n  bandwidth: {\n    systemBandwidth: 0,\n    sentPerSecond: 0,\n    encodedPerSecond: 0,\n    helper: {\n      audioBytesSent: 0,\n      videoBytestSent: 0,\n    },\n    speed: 0,\n  },\n  results: {},\n  connectionType: {\n    systemNetworkType: 'unknown',\n    systemIpAddress: '0.0.0.0',\n    local: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n    remote: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n  },\n  resolutions: {\n    video: {\n      send: {\n        width: 0,\n        height: 0,\n        framesSent: 0,\n      },\n      recv: {\n        width: 0,\n        height: 0,\n      },\n    },\n    share: {\n      send: {\n        width: 0,\n        height: 0,\n        framesSent: 0,\n      },\n      recv: {\n        width: 0,\n        height: 0,\n      },\n    },\n  },\n  internal: {\n    audio: {\n      send: {},\n      recv: {},\n    },\n    video: {\n      send: {},\n      recv: {},\n    },\n    share: {\n      send: {},\n      recv: {},\n    },\n    remote: {},\n    candidates: {},\n  },\n};\n\nexport default STATS_DEFAULT;\n"],"mappings":";;;;;;;AAAA,IAAMA,aAAa,GAAG;EACpBC,UAAU,EAAE,SAAS;EACrBC,KAAK,EAAE;IACLC,IAAI,EAAE;MACJC,kBAAkB,EAAE,CAAC;MACrBC,kBAAkB,EAAE,CAAC;MACrBC,SAAS,EAAE,CAAC;MACZC,gBAAgB,EAAE,EAAE;MACpBC,iBAAiB,EAAE;IACrB,CAAC;IACDC,IAAI,EAAE;MACJJ,kBAAkB,EAAE,CAAC;MACrBK,aAAa,EAAE,CAAC;MAChBC,aAAa,EAAE,EAAE;MACjBH,iBAAiB,EAAE;IACrB;EACF,CAAC;EACDI,KAAK,EAAE;IACLT,IAAI,EAAE;MACJC,kBAAkB,EAAE,CAAC;MACrBC,kBAAkB,EAAE,CAAC;MACrBE,gBAAgB,EAAE,EAAE;MACpBC,iBAAiB,EAAE;IACrB,CAAC;IACDC,IAAI,EAAE;MACJJ,kBAAkB,EAAE,CAAC;MACrBQ,gBAAgB,EAAE,CAAC;MACnBF,aAAa,EAAE,EAAE;MACjBH,iBAAiB,EAAE;IACrB,CAAC;IACDM,OAAO,EAAE,CAAC;IACVC,WAAW,EAAE;EACf,CAAC;EACDC,KAAK,EAAE;IACLb,IAAI,EAAE;MACJC,kBAAkB,EAAE,CAAC;MACrBC,kBAAkB,EAAE,CAAC;MACrBQ,gBAAgB,EAAE,CAAC;MACnBN,gBAAgB,EAAE,EAAE;MACpBC,iBAAiB,EAAE;IACrB,CAAC;IACDC,IAAI,EAAE;MACJJ,kBAAkB,EAAE,CAAC;MACrBM,aAAa,EAAE,EAAE;MACjBH,iBAAiB,EAAE;IACrB,CAAC;IAEDM,OAAO,EAAE,CAAC;IACVC,WAAW,EAAE;EACf,CAAC;EACDE,SAAS,EAAE;IACTC,eAAe,EAAE,CAAC;IAClBC,aAAa,EAAE,CAAC;IAChBC,gBAAgB,EAAE,CAAC;IACnBC,MAAM,EAAE;MACNC,cAAc,EAAE,CAAC;MACjBC,eAAe,EAAE;IACnB,CAAC;IACDC,KAAK,EAAE;EACT,CAAC;EACDC,OAAO,EAAE,CAAC,CAAC;EACXC,cAAc,EAAE;IACdC,iBAAiB,EAAE,SAAS;IAC5BC,eAAe,EAAE,SAAS;IAC1BC,KAAK,EAAE;MACLC,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf,CAAC;IACDC,MAAM,EAAE;MACNJ,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf;EACF,CAAC;EACDE,WAAW,EAAE;IACXvB,KAAK,EAAE;MACLT,IAAI,EAAE;QACJiC,KAAK,EAAE,CAAC;QACRC,MAAM,EAAE,CAAC;QACTC,UAAU,EAAE;MACd,CAAC;MACD7B,IAAI,EAAE;QACJ2B,KAAK,EAAE,CAAC;QACRC,MAAM,EAAE;MACV;IACF,CAAC;IACDrB,KAAK,EAAE;MACLb,IAAI,EAAE;QACJiC,KAAK,EAAE,CAAC;QACRC,MAAM,EAAE,CAAC;QACTC,UAAU,EAAE;MACd,CAAC;MACD7B,IAAI,EAAE;QACJ2B,KAAK,EAAE,CAAC;QACRC,MAAM,EAAE;MACV;IACF;EACF,CAAC;EACDE,QAAQ,EAAE;IACRrC,KAAK,EAAE;MACLC,IAAI,EAAE,CAAC,CAAC;MACRM,IAAI,EAAE,CAAC;IACT,CAAC;IACDG,KAAK,EAAE;MACLT,IAAI,EAAE,CAAC,CAAC;MACRM,IAAI,EAAE,CAAC;IACT,CAAC;IACDO,KAAK,EAAE;MACLb,IAAI,EAAE,CAAC,CAAC;MACRM,IAAI,EAAE,CAAC;IACT,CAAC;IACDyB,MAAM,EAAE,CAAC,CAAC;IACVM,UAAU,EAAE,CAAC;EACf;AACF,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEa3C,aAAa","ignoreList":[]}

package/dist/statsAnalyzer/index.d.ts

@@ -0,0 +1,217 @@
+/// <reference types="node" />
+import EventsScope from '../common/events/events-scope';
+import { ReceiveSlot } from '../multistream/receiveSlot';
+export declare const EVENTS: {
+    MEDIA_QUALITY: string;
+    LOCAL_MEDIA_STARTED: string;
+    LOCAL_MEDIA_STOPPED: string;
+    REMOTE_MEDIA_STARTED: string;
+    REMOTE_MEDIA_STOPPED: string;
+};
+type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
+type MediaStatus = {
+    actual?: any;
+    expected?: any;
+};
+/**
+ * Stats Analyzer class that will emit events based on detected quality
+ *
+ * @export
+ * @class StatsAnalyzer
+ * @extends {EventsScope}
+ */
+export declare class StatsAnalyzer extends EventsScope {
+    config: any;
+    correlationId: any;
+    lastEmittedStartStopEvent: any;
+    lastMqaDataSent: any;
+    lastStatsResults: any;
+    meetingMediaStatus: any;
+    mqaInterval: NodeJS.Timeout;
+    mqaSentCount: any;
+    networkQualityMonitor: any;
+    mediaConnection: any;
+    statsInterval: NodeJS.Timeout;
+    statsResults: any;
+    statsStarted: any;
+    successfulCandidatePair: any;
+    localIpAddress: string;
+    receiveSlotCallback: ReceiveSlotCallback;
+    /**
+     * Creates a new instance of StatsAnalyzer
+     * @constructor
+     * @public
+     * @param {Object} config SDK Configuration Object
+     * @param {Function} receiveSlotCallback Callback used to access receive slots.
+     * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
+     * @param {Object} statsResults Default properties for stats
+     */
+    constructor(config: any, receiveSlotCallback?: ReceiveSlotCallback, networkQualityMonitor?: object, statsResults?: object);
+    /**
+     * Resets cumulative stats arrays.
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    resetStatsResults(): void;
+    /**
+     * sets mediaStatus status for analyzing metrics
+     *
+     * @public
+     * @param {Object} status for the audio and video
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    updateMediaStatus(status: MediaStatus): void;
+    /**
+     * captures MQA data from media connection
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    sendMqaData(): void;
+    /**
+     * updated the media connection when changed
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @param {RoapMediaConnection} mediaConnection
+     * @returns {void}
+     */
+    updateMediaConnection(mediaConnection: any): void;
+    /**
+     * Returns the local IP address for diagnostics.
+     * this is the local IP of the interface used for the current media connection
+     * a host can have many local Ip Addresses
+     * @returns {string | undefined} The local IP address.
+     */
+    getLocalIpAddress(): string;
+    /**
+     * Starts the stats analyzer on interval
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @param {RoapMediaConnection} mediaConnection
+     * @returns {Promise}
+     */
+    startAnalyzer(mediaConnection: any): any;
+    /**
+     * Cleans up the analyzer when done
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    stopAnalyzer(): any;
+    /**
+     * Parse a single result of get stats
+     *
+     * @private
+     * @param {*} getStatsResult
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private parseGetStatsResult;
+    /**
+     * Filters the get stats results for types
+     * @private
+     * @param {Array} statsItem
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     */
+    filterAndParseGetStatsResults(statsItem: any, type: string, isSender: boolean): void;
+    /**
+     * parse the audio
+     * @param {String} result
+     * @param {boolean} type
+     * @returns {void}
+     */
+    parseAudioSource(result: any, type: any): void;
+    /**
+     * emits started/stopped events for local/remote media by checking
+     * if given values are increasing or not. The previousValue, currentValue
+     * params can be any numerical value like number of receive packets or
+     * decoded frames, etc.
+     *
+     * @private
+     * @param {string} mediaType
+     * @param {number} previousValue - value to compare
+     * @param {number} currentValue - value to compare (must be same type of value as previousValue)
+     * @param {boolean} isLocal - true if stats are for local media being sent out, false for remote media being received
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    emitStartStopEvents: (mediaType: string, previousValue: number, currentValue: number, isLocal: boolean) => void;
+    /**
+     * compares current and previous stats to check if packets are not sent
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    private compareLastStatsResult;
+    /**
+     * Does a `getStats` on all the transceivers and parses the results
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {Promise}
+     */
+    private getStatsAndParse;
+    /**
+     * Processes OutboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     */
+    private processOutboundRTPResult;
+    /**
+     * Processes InboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     */
+    private processInboundRTPResult;
+    /**
+     * extracts the local Ip address from the statsResult object by looking at stats results candidates
+     * and matches that ID with the successful candidate pair. It looks at the type of local candidate it is
+     * and then extracts the IP address from the relatedAddress or address property based on conditions known in webrtc
+     * note, there are known incompatibilities and it is possible for this to set undefined, or for the IP address to be the public IP address
+     * for example, firefox does not set the relayProtocol, and if the user is behind a NAT it might be the public IP
+     * @private
+     * @param {string} successfulCandidatePairId - The ID of the successful candidate pair.
+     * @param {Object} candidates - the stats result candidates
+     * @returns {void}
+     */
+    extractAndSetLocalIpAddressInfoForDiagnostics: (successfulCandidatePairId: string, candidates: {
+        [key: string]: Record<string, unknown>;
+    }) => void;
+    /**
+     * Processes remote and local candidate result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @param {boolean} isSender
+     * @param {boolean} isRemote
+     *
+     * @returns {void}
+     */
+    parseCandidate: (result: any, type: any, isSender: boolean, isRemote: boolean) => void;
+    /**
+     *
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    compareSentAndReceived(result: any, type: any): void;
+}
+export {};