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

package/dist/statsAnalyzer/index.js

@@ -27,30 +27,32 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 var EVENTS = {
   MEDIA_QUALITY: 'MEDIA_QUALITY',
+  NO_FRAMES_SENT: 'NO_FRAMES_SENT',
+  NO_VIDEO_ENCODED: 'NO_VIDEO_ENCODED',
   LOCAL_MEDIA_STARTED: 'LOCAL_MEDIA_STARTED',
   LOCAL_MEDIA_STOPPED: 'LOCAL_MEDIA_STOPPED',
   REMOTE_MEDIA_STARTED: 'REMOTE_MEDIA_STARTED',
   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 +74,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') {
@@ -99,7 +101,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       var newEvent;
       if (currentValue - previousValue > 0) {
         newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STARTED : EVENTS.REMOTE_MEDIA_STARTED;
-      } else if (currentValue === previousValue && currentValue > 0) {
+      } else if (currentValue === previousValue && currentValue >= 0) {
         newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STOPPED : EVENTS.REMOTE_MEDIA_STOPPED;
       }
       if (newEvent && lastEmittedEvent !== newEvent) {
@@ -116,15 +118,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 +325,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 +339,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 +427,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 +441,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 +470,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 +499,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",
@@ -520,9 +522,6 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
         case 'inbound-rtp':
           this.processInboundRTPResult(getStatsResult, type);
           break;
-        case 'track':
-          this.processTrackResult(getStatsResult, type);
-          break;
         case 'remote-inbound-rtp':
         case 'remote-outbound-rtp':
           // @ts-ignore
@@ -544,13 +543,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 +563,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 +583,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) {
@@ -630,13 +629,32 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
           previousStats = this.lastStatsResults[mediaType].send;
           if (currentStats.totalPacketsSent === previousStats.totalPacketsSent || currentStats.totalPacketsSent === 0) {
             _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " RTP packets sent"));
-          } else {
+          } else if (this.lastEmittedStartStopEvent[mediaType].local !== EVENTS.LOCAL_MEDIA_STOPPED) {
             if (currentStats.framesEncoded === previousStats.framesEncoded || currentStats.framesEncoded === 0) {
+              this.lastEmittedStartStopEvent[mediaType].local = EVENTS.NO_VIDEO_ENCODED;
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " Frames Encoded"));
+              this.emit({
+                file: 'statsAnalyzer',
+                function: 'compareLastStatsResult'
+              }, EVENTS.NO_VIDEO_ENCODED, {
+                mediaType: mediaType
+              });
             }
             if (this.statsResults.resolutions[mediaType].send.framesSent === this.lastStatsResults.resolutions[mediaType].send.framesSent || this.statsResults.resolutions[mediaType].send.framesSent === 0) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " Frames sent"));
             }
+
+            // Video is encoded but frames are not sent
+            if (currentStats.framesEncoded !== previousStats.framesEncoded && (currentStats.framesSent === previousStats.framesSent || currentStats.framesSent === 0)) {
+              this.lastEmittedStartStopEvent[mediaType].local = EVENTS.NO_FRAMES_SENT;
+              _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames sent even though frames are encoded"));
+              this.emit({
+                file: 'statsAnalyzer',
+                function: 'compareLastStatsResult'
+              }, EVENTS.NO_FRAMES_SENT, {
+                mediaType: mediaType
+              });
+            }
           }
           this.emitStartStopEvents(mediaType, previousStats.framesSent, currentStats.framesSent, true);
         }
@@ -668,13 +686,32 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
           previousStats = this.lastStatsResults[mediaType].send;
           if (currentStats.totalPacketsSent === previousStats.totalPacketsSent || currentStats.totalPacketsSent === 0) {
             _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " RTP packets sent"));
-          } else {
+          } else if (this.lastEmittedStartStopEvent[mediaType].local !== EVENTS.LOCAL_MEDIA_STOPPED) {
             if (currentStats.framesEncoded === previousStats.framesEncoded || currentStats.framesEncoded === 0) {
+              this.lastEmittedStartStopEvent[mediaType].local = EVENTS.NO_VIDEO_ENCODED;
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames getting encoded"));
+              this.emit({
+                file: 'statsAnalyzer',
+                function: 'compareLastStatsResult'
+              }, EVENTS.NO_VIDEO_ENCODED, {
+                mediaType: mediaType
+              });
             }
             if (this.statsResults.resolutions[mediaType].send.framesSent === this.lastStatsResults.resolutions[mediaType].send.framesSent || this.statsResults.resolutions[mediaType].send.framesSent === 0) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames sent"));
             }
+
+            // Share video is encoded but frames are not sent
+            if (currentStats.framesEncoded !== previousStats.framesEncoded && (currentStats.framesSent === previousStats.framesSent || currentStats.framesSent === 0)) {
+              this.lastEmittedStartStopEvent[mediaType].local = EVENTS.NO_FRAMES_SENT;
+              _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " Frames sent even though frames are being encoded"));
+              this.emit({
+                file: 'statsAnalyzer',
+                function: 'compareLastStatsResult'
+              }, EVENTS.NO_FRAMES_SENT, {
+                mediaType: mediaType
+              });
+            }
           }
 
           // TODO:need to check receive share value
@@ -702,12 +739,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,18 +786,19 @@ 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",
     value: function processOutboundRTPResult(result, type) {
       var mediaType = type || _constants.STATS.AUDIO_CORRELATE;
       var sendrecvType = _constants.STATS.SEND_DIRECTION;
+      this.processTrackResult(result, type, sendrecvType);
       if (result.bytesSent) {
         var kilobytes = 0;
         if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesSent) {
@@ -805,18 +843,19 @@ 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",
     value: function processInboundRTPResult(result, type) {
       var mediaType = type || _constants.STATS.AUDIO_CORRELATE;
       var sendrecvType = _constants.STATS.RECEIVE_DIRECTION;
+      this.processTrackResult(result, type, sendrecvType);
       if (result.bytesReceived) {
         var kilobytes = 0;
         if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived) {
@@ -890,31 +929,34 @@ 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
+     * @param {*} sendrecvType
+     * @returns {void}
+     * @memberof StatsAnalyzer
      */
-    function processTrackResult(result, mediaType) {
-      if (!result || result.type !== 'track') {
+    function processTrackResult(result, mediaType, sendrecvType) {
+      if (!result || mediaType === _constants.STATS.AUDIO_CORRELATE) {
+        return;
+      }
+      if (result.type !== 'inbound-rtp' && result.type !== 'outbound-rtp') {
         return;
       }
-      if (result.type !== 'track') return;
-      var sendrecvType = result.remoteSource === true ? _constants.STATS.RECEIVE_DIRECTION : _constants.STATS.SEND_DIRECTION;
       if (result.frameWidth && result.frameHeight) {
         this.statsResults.resolutions[mediaType][sendrecvType].width = result.frameWidth;
         this.statsResults.resolutions[mediaType][sendrecvType].height = result.frameHeight;
-        this.statsResults.resolutions[mediaType][sendrecvType].framesSent = result.framesSent;
-        this.statsResults.resolutions[mediaType][sendrecvType].hugeFramesSent = result.hugeFramesSent;
       }
       if (sendrecvType === _constants.STATS.RECEIVE_DIRECTION) {
         this.statsResults.resolutions[mediaType][sendrecvType].framesReceived = result.framesReceived;
         this.statsResults.resolutions[mediaType][sendrecvType].framesDecoded = result.framesDecoded;
         this.statsResults.resolutions[mediaType][sendrecvType].framesDropped = result.framesDropped;
+      } else if (sendrecvType === _constants.STATS.SEND_DIRECTION) {
+        this.statsResults.resolutions[mediaType][sendrecvType].framesSent = result.framesSent;
+        this.statsResults.resolutions[mediaType][sendrecvType].hugeFramesSent = result.hugeFramesSent;
       }
       if (result.trackIdentifier && mediaType !== _constants.STATS.AUDIO_CORRELATE) {
         this.statsResults.resolutions[mediaType][sendrecvType].trackIdentifier = result.trackIdentifier;
@@ -928,13 +970,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",