@webex/plugin-meetings 2.59.1 → 2.59.3-next.1

package/dist/statsAnalyzer/index.js

@@ -33,24 +33,24 @@ var EVENTS = {
   REMOTE_MEDIA_STOPPED: 'REMOTE_MEDIA_STOPPED'
 };
 
-/**
- * Stats Analyzer class that will emit events based on detected quality
- *
- * @export
- * @class StatsAnalyzer
- * @extends {EventsScope}
+/**
+ * Stats Analyzer class that will emit events based on detected quality
+ *
+ * @export
+ * @class StatsAnalyzer
+ * @extends {EventsScope}
  */
 exports.EVENTS = EVENTS;
 var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   (0, _inherits2.default)(StatsAnalyzer, _EventsScope);
   var _super = _createSuper(StatsAnalyzer);
-  /**
-   * Creates a new instance of StatsAnalyzer
-   * @constructor
-   * @public
-   * @param {Object} config SDK Configuration Object
-   * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
-   * @param {Object} statsResults Default properties for stats
+  /**
+   * Creates a new instance of StatsAnalyzer
+   * @constructor
+   * @public
+   * @param {Object} config SDK Configuration Object
+   * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
+   * @param {Object} statsResults Default properties for stats
    */
   function StatsAnalyzer(config) {
     var _this;
@@ -72,19 +72,19 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "statsInterval", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "statsResults", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "statsStarted", void 0);
-    /**
-     * 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}
+    /**
+     * 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}
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "emitStartStopEvents", function (mediaType, previousValue, currentValue, isLocal) {
       if (mediaType !== 'audio' && mediaType !== 'video' && mediaType !== 'share') {
@@ -116,15 +116,15 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
         });
       }
     });
-    /**
-     * Processes remote and local candidate result and stores
-     * @private
-     * @param {*} result
-     * @param {*} type
-     * @param {boolean} isSender
-     * @param {boolean} isRemote
-     *
-     * @returns {void}
+    /**
+     * Processes remote and local candidate result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @param {boolean} isSender
+     * @param {boolean} isRemote
+     *
+     * @returns {void}
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "parseCandidate", function (result, type, isSender, isRemote) {
       if (!result || !result.id) {
@@ -323,13 +323,13 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       this.statsResults.share.send.meanRoundTripTime = [];
     }
 
-    /**
-     * sets mediaStatus status for analyzing metrics
-     *
-     * @public
-     * @param {Object} status for the audio and video
-     * @memberof StatsAnalyzer
-     * @returns {void}
+    /**
+     * sets mediaStatus status for analyzing metrics
+     *
+     * @public
+     * @param {Object} status for the audio and video
+     * @memberof StatsAnalyzer
+     * @returns {void}
      */
   }, {
     key: "updateMediaStatus",
@@ -337,12 +337,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       this.meetingMediaStatus = status;
     }
 
-    /**
-     * captures MQA data from peerconnection
-     *
-     * @public
-     * @memberof StatsAnalyzer
-     * @returns {void}
+    /**
+     * captures MQA data from peerconnection
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
      */
   }, {
     key: "sendMqaData",
@@ -425,13 +425,13 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       });
     }
 
-    /**
-     * updated the peerconnection when changed
-     *
-     * @private
-     * @memberof updatePeerconnection
-     * @param {PeerConnection} peerConnection
-     * @returns {void}
+    /**
+     * updated the peerconnection when changed
+     *
+     * @private
+     * @memberof updatePeerconnection
+     * @param {PeerConnection} peerConnection
+     * @returns {void}
      */
   }, {
     key: "updatePeerconnection",
@@ -439,13 +439,13 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       this.peerConnection = peerConnection;
     }
 
-    /**
-     * Starts the stats analyzer on interval
-     *
-     * @public
-     * @memberof StatsAnalyzer
-     * @param {PeerConnection} peerConnection
-     * @returns {Promise}
+    /**
+     * Starts the stats analyzer on interval
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @param {PeerConnection} peerConnection
+     * @returns {Promise}
      */
   }, {
     key: "startAnalyzer",
@@ -468,12 +468,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       return _promise.default.resolve();
     }
 
-    /**
-     * Cleans up the analyzer when done
-     *
-     * @public
-     * @memberof StatsAnalyzer
-     * @returns {void}
+    /**
+     * Cleans up the analyzer when done
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
      */
   }, {
     key: "stopAnalyzer",
@@ -497,15 +497,15 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       return _promise.default.resolve();
     }
 
-    /**
-     * Parse a single result of get stats
-     *
-     * @private
-     * @param {*} getStatsResult
-     * @param {String} type
-     * @param {boolean} isSender
-     * @returns {void}
-     * @memberof StatsAnalyzer
+    /**
+     * Parse a single result of get stats
+     *
+     * @private
+     * @param {*} getStatsResult
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     * @memberof StatsAnalyzer
      */
   }, {
     key: "parseGetStatsResult",
@@ -544,13 +544,13 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       }
     }
 
-    /**
-     * Filters the get stats results for types
-     * @private
-     * @param {Array} getStatsResults
-     * @param {String} type
-     * @param {boolean} isSender
-     * @returns {void}
+    /**
+     * Filters the get stats results for types
+     * @private
+     * @param {Array} getStatsResults
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
      */
   }, {
     key: "filterAndParseGetStatsResults",
@@ -564,11 +564,11 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       });
     }
 
-    /**
-     * parse the audio
-     * @param {String} result
-     * @param {boolean} type
-     * @returns {void}
+    /**
+     * parse the audio
+     * @param {String} result
+     * @param {boolean} type
+     * @returns {void}
      */
   }, {
     key: "parseAudioSource",
@@ -584,12 +584,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "compareLastStatsResult",
     value:
-    /**
-     * compares current and previous stats to check if packets are not sent
-     *
-     * @private
-     * @memberof StatsAnalyzer
-     * @returns {void}
+    /**
+     * compares current and previous stats to check if packets are not sent
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {void}
      */
     function compareLastStatsResult() {
       if (this.lastStatsResults !== null && this.meetingMediaStatus) {
@@ -702,12 +702,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       }
     }
 
-    /**
-     * Does a `getStats` on all the transceivers and parses the results
-     *
-     * @private
-     * @memberof StatsAnalyzer
-     * @returns {Promise}
+    /**
+     * Does a `getStats` on all the transceivers and parses the results
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {Promise}
      */
   }, {
     key: "getStatsAndParse",
@@ -749,12 +749,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       });
     }
 
-    /**
-     * Processes OutboundRTP stats result and stores
-     * @private
-     * @param {*} result
-     * @param {*} type
-     * @returns {void}
+    /**
+     * Processes OutboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
      */
   }, {
     key: "processOutboundRTPResult",
@@ -805,12 +805,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       }
     }
 
-    /**
-     * Processes InboundRTP stats result and stores
-     * @private
-     * @param {*} result
-     * @param {*} type
-     * @returns {void}
+    /**
+     * Processes InboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
      */
   }, {
     key: "processInboundRTPResult",
@@ -890,14 +890,14 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "processTrackResult",
     value:
-    /**
-     * Process Track results
-     *
-     * @private
-     * @param {*} result
-     * @param {*} mediaType
-     * @returns {void}
-     * @memberof StatsAnalyzer
+    /**
+     * Process Track results
+     *
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     * @memberof StatsAnalyzer
      */
     function processTrackResult(result, mediaType) {
       if (!result || result.type !== 'track') {
@@ -928,13 +928,13 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       }
     }
 
-    /**
-     *
-     * @private
-     * @param {*} result
-     * @param {*} type
-     * @returns {void}
-     * @memberof StatsAnalyzer
+    /**
+     *
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     * @memberof StatsAnalyzer
      */
   }, {
     key: "compareSentAndReceived",