@webex/plugin-meetings 3.3.1-next.1 → 3.3.1-next.10

package/src/statsAnalyzer/index.ts

@@ -35,6 +35,7 @@ import {
   getAudioReceiverStreamMqa,
   getVideoSenderStreamMqa,
   getVideoReceiverStreamMqa,
+  isStreamRequested,
 } from './mqaUtil';
 import {ReceiveSlot} from '../multistream/receiveSlot';
 
@@ -91,22 +92,31 @@ export class StatsAnalyzer extends EventsScope {
   successfulCandidatePair: any;
   localIpAddress: string; // 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
   receiveSlotCallback: ReceiveSlotCallback;
+  isMultistream: boolean;
 
   /**
    * 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
+   * @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
+   * @param {boolean | undefined} isMultistream - Param indicating if the media connection is multistream or not
    */
-  constructor(
-    config: any,
-    receiveSlotCallback: ReceiveSlotCallback = () => undefined,
-    networkQualityMonitor: object = {},
-    statsResults: object = defaultStats
-  ) {
+  constructor({
+    config,
+    receiveSlotCallback = () => undefined,
+    networkQualityMonitor = {},
+    statsResults = defaultStats,
+    isMultistream = false,
+  }: {
+    config: any;
+    receiveSlotCallback: ReceiveSlotCallback;
+    networkQualityMonitor: any;
+    statsResults?: any;
+    isMultistream?: boolean;
+  }) {
     super();
     this.statsStarted = false;
     this.statsResults = statsResults;
@@ -120,6 +130,7 @@ export class StatsAnalyzer extends EventsScope {
     this.receiveSlotCallback = receiveSlotCallback;
     this.successfulCandidatePair = {};
     this.localIpAddress = '';
+    this.isMultistream = isMultistream;
   }
 
   /**
@@ -203,6 +214,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'audio-send',
+      isMultistream: this.isMultistream,
     });
     newMqa.audioTransmit.push(audioSender);
 
@@ -211,6 +223,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'audio-share-send',
+      isMultistream: this.isMultistream,
     });
     newMqa.audioTransmit.push(audioShareSender);
 
@@ -219,6 +232,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'audio-recv',
+      isMultistream: this.isMultistream,
     });
     newMqa.audioReceive.push(audioReceiver);
 
@@ -227,6 +241,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'audio-share-recv',
+      isMultistream: this.isMultistream,
     });
     newMqa.audioReceive.push(audioShareReceiver);
 
@@ -235,6 +250,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'video-send',
+      isMultistream: this.isMultistream,
     });
     newMqa.videoTransmit.push(videoSender);
 
@@ -243,6 +259,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'video-share-send',
+      isMultistream: this.isMultistream,
     });
     newMqa.videoTransmit.push(videoShareSender);
 
@@ -251,6 +268,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'video-recv',
+      isMultistream: this.isMultistream,
     });
     newMqa.videoReceive.push(videoReceiver);
 
@@ -259,6 +277,7 @@ export class StatsAnalyzer extends EventsScope {
       statsResults: this.statsResults,
       lastMqaDataSent: this.lastMqaDataSent,
       baseMediaType: 'video-share-recv',
+      isMultistream: this.isMultistream,
     });
     newMqa.videoReceive.push(videoShareReceiver);
 
@@ -273,7 +292,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.audioTransmit[0].streams.push(audioSenderStream);
+        if (isStreamRequested(this.statsResults, mediaType, STATS.SEND_DIRECTION)) {
+          newMqa.audioTransmit[0].streams.push(audioSenderStream);
+        }
 
         this.lastMqaDataSent[mediaType].send = cloneDeep(this.statsResults[mediaType].send);
       } else if (mediaType.startsWith('audio-share-send')) {
@@ -285,7 +306,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.audioTransmit[1].streams.push(audioSenderStream);
+        if (isStreamRequested(this.statsResults, mediaType, STATS.SEND_DIRECTION)) {
+          newMqa.audioTransmit[1].streams.push(audioSenderStream);
+        }
 
         this.lastMqaDataSent[mediaType].send = cloneDeep(this.statsResults[mediaType].send);
       } else if (mediaType.startsWith('audio-recv')) {
@@ -297,7 +320,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.audioReceive[0].streams.push(audioReceiverStream);
+        if (isStreamRequested(this.statsResults, mediaType, STATS.RECEIVE_DIRECTION)) {
+          newMqa.audioReceive[0].streams.push(audioReceiverStream);
+        }
 
         this.lastMqaDataSent[mediaType].recv = cloneDeep(this.statsResults[mediaType].recv);
       } else if (mediaType.startsWith('audio-share-recv')) {
@@ -309,8 +334,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.audioReceive[1].streams.push(audioReceiverStream);
-
+        if (isStreamRequested(this.statsResults, mediaType, STATS.RECEIVE_DIRECTION)) {
+          newMqa.audioReceive[1].streams.push(audioReceiverStream);
+        }
         this.lastMqaDataSent[mediaType].recv = cloneDeep(this.statsResults[mediaType].recv);
       } else if (mediaType.startsWith('video-send-layer')) {
         // We only want the stream-specific stats we get with video-send-layer-0, video-send-layer-1, etc.
@@ -322,8 +348,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.videoTransmit[0].streams.push(videoSenderStream);
-
+        if (isStreamRequested(this.statsResults, mediaType, STATS.SEND_DIRECTION)) {
+          newMqa.videoTransmit[0].streams.push(videoSenderStream);
+        }
         this.lastMqaDataSent[mediaType].send = cloneDeep(this.statsResults[mediaType].send);
       } else if (mediaType.startsWith('video-share-send')) {
         const videoSenderStream = cloneDeep(emptyVideoTransmitStream);
@@ -334,7 +361,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.videoTransmit[1].streams.push(videoSenderStream);
+        if (isStreamRequested(this.statsResults, mediaType, STATS.SEND_DIRECTION)) {
+          newMqa.videoTransmit[1].streams.push(videoSenderStream);
+        }
 
         this.lastMqaDataSent[mediaType].send = cloneDeep(this.statsResults[mediaType].send);
       } else if (mediaType.startsWith('video-recv')) {
@@ -346,7 +375,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.videoReceive[0].streams.push(videoReceiverStream);
+        if (isStreamRequested(this.statsResults, mediaType, STATS.RECEIVE_DIRECTION)) {
+          newMqa.videoReceive[0].streams.push(videoReceiverStream);
+        }
 
         this.lastMqaDataSent[mediaType].recv = cloneDeep(this.statsResults[mediaType].recv);
       } else if (mediaType.startsWith('video-share-recv')) {
@@ -358,8 +389,9 @@ export class StatsAnalyzer extends EventsScope {
           lastMqaDataSent: this.lastMqaDataSent,
           mediaType,
         });
-        newMqa.videoReceive[1].streams.push(videoReceiverStream);
-
+        if (isStreamRequested(this.statsResults, mediaType, STATS.RECEIVE_DIRECTION)) {
+          newMqa.videoReceive[1].streams.push(videoReceiverStream);
+        }
         this.lastMqaDataSent[mediaType].recv = cloneDeep(this.statsResults[mediaType].recv);
       }
     });
@@ -388,6 +420,17 @@ export class StatsAnalyzer extends EventsScope {
 
     newMqa.networkType = this.statsResults.connectionType.local.networkType;
 
+    newMqa.intervalMetadata.screenWidth = window.screen.width;
+    newMqa.intervalMetadata.screenHeight = window.screen.height;
+    newMqa.intervalMetadata.screenResolution = Math.round(
+      (window.screen.width * window.screen.height) / 256
+    );
+    newMqa.intervalMetadata.appWindowWidth = window.innerWidth;
+    newMqa.intervalMetadata.appWindowHeight = window.innerHeight;
+    newMqa.intervalMetadata.appWindowSize = Math.round(
+      (window.innerWidth * window.innerHeight) / 256
+    );
+
     this.mqaSentCount += 1;
 
     newMqa.intervalNumber = this.mqaSentCount;
@@ -1003,6 +1046,11 @@ export class StatsAnalyzer extends EventsScope {
       this.statsResults[mediaType][sendrecvType].totalRtxBytesSent = result.retransmittedBytesSent;
       this.statsResults[mediaType][sendrecvType].totalBytesSent = result.bytesSent;
       this.statsResults[mediaType][sendrecvType].headerBytesSent = result.headerBytesSent;
+      this.statsResults[mediaType][sendrecvType].retransmittedBytesSent =
+        result.retransmittedBytesSent;
+      this.statsResults[mediaType][sendrecvType].isRequested = result.isRequested;
+      this.statsResults[mediaType][sendrecvType].lastRequestedUpdateTimestamp =
+        result.lastRequestedUpdateTimestamp;
       this.statsResults[mediaType][sendrecvType].requestedBitrate = result.requestedBitrate;
       this.statsResults[mediaType][sendrecvType].requestedFrameSize = result.requestedFrameSize;
     }
@@ -1088,6 +1136,12 @@ export class StatsAnalyzer extends EventsScope {
         }
       }
 
+      if (mediaType.startsWith('video-recv')) {
+        this.statsResults[mediaType][sendrecvType].isActiveSpeaker = result.isActiveSpeaker;
+        this.statsResults[mediaType][sendrecvType].lastActiveSpeakerTimestamp =
+          result.lastActiveSpeakerUpdateTimestamp;
+      }
+
       //  Check the over all packet Lost ratio
       this.statsResults[mediaType][sendrecvType].currentPacketLossRatio =
         currentPacketsLost > 0
@@ -1151,6 +1205,9 @@ export class StatsAnalyzer extends EventsScope {
       this.statsResults[mediaType][sendrecvType].totalSamplesDecoded =
         result.totalSamplesDecoded || 0;
       this.statsResults[mediaType][sendrecvType].concealedSamples = result.concealedSamples || 0;
+      this.statsResults[mediaType][sendrecvType].isRequested = result.isRequested;
+      this.statsResults[mediaType][sendrecvType].lastRequestedUpdateTimestamp =
+        result.lastRequestedUpdateTimestamp;
     }
   }
 

package/src/statsAnalyzer/mqaUtil.ts

@@ -2,7 +2,7 @@
 
 import {mean, max} from 'lodash';
 
-import {STATS} from '../constants';
+import {MQA_INTERVAL, STATS} from '../constants';
 
 /**
  * Get the totals of a certain value from a certain media type.
@@ -28,6 +28,7 @@ export const getAudioReceiverMqa = ({
   statsResults,
   lastMqaDataSent,
   baseMediaType,
+  isMultistream,
 }) => {
   const sendrecvType = STATS.RECEIVE_DIRECTION;
 
@@ -52,6 +53,7 @@ export const getAudioReceiverMqa = ({
     statsResults[Object.keys(statsResults).find((mediaType) => mediaType.includes(baseMediaType))]
       ?.direction || 'inactive';
   audioReceiver.common.common.isMain = !baseMediaType.includes('-share');
+  audioReceiver.common.common.multistreamEnabled = isMultistream;
   audioReceiver.common.transportType = statsResults.connectionType.local.transport;
 
   // add rtpPacket info inside common as also for call analyzer
@@ -127,7 +129,13 @@ export const getAudioReceiverStreamMqa = ({
     ((statsResults[mediaType][sendrecvType].totalBytesReceived - lastBytesReceived) * 8) / 60 || 0;
 };
 
-export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent, baseMediaType}) => {
+export const getAudioSenderMqa = ({
+  audioSender,
+  statsResults,
+  lastMqaDataSent,
+  baseMediaType,
+  isMultistream,
+}) => {
   const sendrecvType = STATS.SEND_DIRECTION;
 
   const getLastTotalValue = (value: string) =>
@@ -152,6 +160,7 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent, b
     statsResults[Object.keys(statsResults).find((mediaType) => mediaType.includes(baseMediaType))]
       ?.direction || 'inactive';
   audioSender.common.common.isMain = !baseMediaType.includes('-share');
+  audioSender.common.common.multistreamEnabled = isMultistream;
   audioSender.common.transportType = statsResults.connectionType.local.transport;
 
   audioSender.common.maxRemoteJitter = max(meanRemoteJitter) * 1000 || 0;
@@ -166,8 +175,8 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent, b
     baseMediaType,
     'availableOutgoingBitrate'
   );
-  // Calculate based on how much packets lost of received compated to how to the client sent
 
+  // Calculate based on how much packets lost of received compated to how to the client sent
   const totalPacketsLostForaMin = totalPacketsLostOnReceiver - lastPacketsLostTotal;
   audioSender.common.remoteLossRate =
     totalPacketsSent - lastPacketsSent > 0
@@ -225,6 +234,7 @@ export const getVideoReceiverMqa = ({
   statsResults,
   lastMqaDataSent,
   baseMediaType,
+  isMultistream,
 }) => {
   const sendrecvType = STATS.RECEIVE_DIRECTION;
 
@@ -254,6 +264,7 @@ export const getVideoReceiverMqa = ({
   videoReceiver.common.common.direction =
     statsResults[Object.keys(statsResults).find((mediaType) => mediaType.includes(baseMediaType))]
       ?.direction || 'inactive';
+  videoReceiver.common.common.multistreamEnabled = isMultistream;
   videoReceiver.common.common.isMain = !baseMediaType.includes('-share');
   videoReceiver.common.transportType = statsResults.connectionType.local.transport;
 
@@ -347,9 +358,23 @@ export const getVideoReceiverStreamMqa = ({
     statsResults[mediaType][sendrecvType].keyFramesDecoded - lastKeyFramesDecoded || 0;
   videoReceiverStream.requestedKeyFrames =
     statsResults[mediaType][sendrecvType].totalPliCount - lastPliCount || 0;
+
+  videoReceiverStream.isActiveSpeaker =
+    statsResults[mediaType][sendrecvType].isActiveSpeaker ||
+    ((statsResults[mediaType][sendrecvType].lastActiveSpeakerTimestamp ?? 0) > 0 &&
+      performance.now() +
+        performance.timeOrigin -
+        (statsResults[mediaType][sendrecvType].lastActiveSpeakerTimestamp ?? 0) <
+        MQA_INTERVAL);
 };
 
-export const getVideoSenderMqa = ({videoSender, statsResults, lastMqaDataSent, baseMediaType}) => {
+export const getVideoSenderMqa = ({
+  videoSender,
+  statsResults,
+  lastMqaDataSent,
+  baseMediaType,
+  isMultistream,
+}) => {
   const sendrecvType = STATS.SEND_DIRECTION;
 
   const getLastTotalValue = (value: string) =>
@@ -373,6 +398,7 @@ export const getVideoSenderMqa = ({videoSender, statsResults, lastMqaDataSent, b
   videoSender.common.common.direction =
     statsResults[Object.keys(statsResults).find((mediaType) => mediaType.includes(baseMediaType))]
       ?.direction || 'inactive';
+  videoSender.common.common.multistreamEnabled = isMultistream;
   videoSender.common.common.isMain = !baseMediaType.includes('-share');
   videoSender.common.transportType = statsResults.connectionType.local.transport;
 
@@ -461,3 +487,23 @@ export const getVideoSenderStreamMqa = ({
   videoSenderStream.requestedFrameSize =
     statsResults[mediaType][sendrecvType].requestedFrameSize || 0;
 };
+
+/**
+ * Checks if stream stats should be updated based on request status and elapsed time.
+ *
+ * @param {Object} statsResults - Stats results object.
+ * @param {string} mediaType - Media type (e.g., 'audio', 'video').
+ * @param {string} direction - Stats direction (e.g., 'send', 'receive').
+ * @returns {boolean} Whether stats should be updated.
+ */
+export const isStreamRequested = (
+  statsResults: any,
+  mediaType: string,
+  direction: string
+): boolean => {
+  const now = performance.timeOrigin + performance.now();
+  const lastUpdateTimestamp = statsResults[mediaType][direction]?.lastRequestedUpdateTimestamp;
+  const isRequested = statsResults[mediaType][direction]?.isRequested;
+
+  return isRequested || (lastUpdateTimestamp && now - lastUpdateTimestamp < MQA_INTERVAL);
+};