@webex/plugin-meetings 2.59.1-next.0 → 2.59.2

package/dist/statsAnalyzer/index.d.ts

@@ -0,0 +1,191 @@
+/// <reference types="node" />
+import EventsScope from '../common/events/events-scope';
+export declare const EVENTS: {
+    MEDIA_QUALITY: string;
+    LOCAL_MEDIA_STARTED: string;
+    LOCAL_MEDIA_STOPPED: string;
+    REMOTE_MEDIA_STARTED: string;
+    REMOTE_MEDIA_STOPPED: string;
+};
+/**
+ * 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;
+    localMQEStats: any;
+    meetingMediaStatus: any;
+    mqaInterval: NodeJS.Timeout;
+    mqaSentCount: any;
+    networkQualityMonitor: any;
+    peerConnection: any;
+    statsInterval: NodeJS.Timeout;
+    statsResults: any;
+    statsStarted: any;
+    /**
+     * 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
+     */
+    constructor(config: any, networkQualityMonitor?: object, statsResults?: object);
+    populateResults(lastMqa: any): void;
+    resetStatsResults(): void;
+    /**
+     * sets mediaStatus status for analyzing metrics
+     *
+     * @public
+     * @param {Object} status for the audio and video
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    updateMediaStatus(status: object): void;
+    /**
+     * captures MQA data from peerconnection
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    sendMqaData(): void;
+    /**
+     * updated the peerconnection when changed
+     *
+     * @private
+     * @memberof updatePeerconnection
+     * @param {PeerConnection} peerConnection
+     * @returns {void}
+     */
+    updatePeerconnection(peerConnection: any): void;
+    /**
+     * Starts the stats analyzer on interval
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @param {PeerConnection} peerConnection
+     * @returns {Promise}
+     */
+    startAnalyzer(peerConnection: any): Promise<void>;
+    /**
+     * Cleans up the analyzer when done
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    stopAnalyzer(): Promise<void>;
+    /**
+     * 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} getStatsResults
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     */
+    private filterAndParseGetStatsResults;
+    /**
+     * 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 {*} type
+     * @returns {void}
+     */
+    private processOutboundRTPResult;
+    /**
+     * Processes InboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     */
+    private processInboundRTPResult;
+    /**
+     * 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;
+    /**
+     * Process Track results
+     *
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @param {*} sendrecvType
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private processTrackResult;
+    /**
+     *
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private compareSentAndReceived;
+}

package/dist/statsAnalyzer/index.js

@@ -16,7 +16,7 @@ var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-var _lodash = require("lodash");
+var _cloneDeep2 = _interopRequireDefault(require("lodash/cloneDeep"));
 var _eventsScope = _interopRequireDefault(require("../common/events/events-scope"));
 var _constants = require("../constants");
 var _config = _interopRequireDefault(require("../mediaQualityMetrics/config"));
@@ -412,7 +412,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       _config.default.intervals[0].intervalNumber = this.mqaSentCount;
 
       // DO Deep copy, for some reason it takes the reference all the time rather then old value set
-      this.lastMqaDataSent = (0, _lodash.cloneDeep)(this.statsResults);
+      this.lastMqaDataSent = (0, _cloneDeep2.default)(this.statsResults);
       this.populateResults(_config.default.intervals[0]);
       this.resetStatsResults();
       this.emit({
@@ -520,9 +520,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
@@ -761,6 +758,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
     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) {
@@ -817,6 +815,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
     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) {
@@ -896,25 +895,28 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
      * @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;