@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/src/mediaQualityMetrics/config.js

@@ -1,382 +0,0 @@
-
-export default {
-  intervals: [
-    {
-      audioReceive: [
-        {
-          common: {
-            common: {
-              direction: 'inactive',
-              isMain: true,
-              mariFecEnabled: false,
-              mariQosEnabled: false,
-              multistreamEnabled: false
-            },
-            dtlsBitrate: 0,
-            dtlsPackets: 0,
-            fecBitrate: 0,
-            fecPackets: 0,
-            maxBitrate: 0,
-            mediaHopByHopLost: 0,
-            rtcpBitrate: 0,
-            rtcpPackets: 0,
-            rtpBitrate: 0,
-            rtpHopByHopLost: 0,
-            rtpPackets: 0,
-            rtpRecovered: 0,
-            rtxBitrate: 0,
-            rtxPackets: 0,
-            srtcpUnprotectErrors: 0,
-            srtpUnprotectErrors: 0,
-            stunBitrate: 0,
-            stunPackets: 0,
-            transportType: 'UDP'
-          },
-          streams: [
-            {
-              common: {
-                codec: 'opus',
-                concealedFrames: 0,
-                csi: [],
-                maxConcealRunLength: 0,
-                optimalBitrate: 0,
-                optimalFrameRate: 0,
-                receivedBitrate: 0,
-                receivedFrameRate: 0,
-                renderedFrameRate: 0,
-                requestedBitrate: 0,
-                requestedFrameRate: 0,
-                rtpEndToEndLost: 0,
-                maxRtpJitter: 0,
-                meanRtpJitter: 0,
-                rtpPackets: 0,
-                ssci: 0
-              }
-            }
-          ]
-        }
-      ],
-      audioTransmit: [
-        {
-          common: {
-            availableBitrate: 0,
-            common: {
-              direction: 'inactive',
-              isMain: true,
-              mariFecEnabled: false,
-              mariQosEnabled: false,
-              multistreamEnabled: false
-            },
-            dtlsBitrate: 0,
-            dtlsPackets: 0,
-            fecBitrate: 0,
-            fecPackets: 0,
-            maxBitrate: 0,
-            queueDelay: 0,
-            remoteJitter: 0,
-            remoteLossRate: 0,
-            remoteReceiveRate: 0,
-            roundTripTime: 0,
-            rtcpBitrate: 0,
-            rtcpPackets: 0,
-            rtpBitrate: 0,
-            rtpPackets: 0,
-            rtxBitrate: 0,
-            rtxPackets: 0,
-            stunBitrate: 0,
-            stunPackets: 0,
-            transportType: 'UDP'
-          },
-          streams: [
-            {
-              common: {
-                codec: 'opus',
-                requestedBitrate: 0,
-                requestedFrames: 0,
-                rtpPackets: 0,
-                ssci: 0,
-                transmittedBitrate: 0,
-                transmittedFrameRate: 0
-              }
-            }
-          ]
-        }
-      ],
-      intervalMetadata: {
-        peerReflexiveIP: '0.0.0.0',
-        peripherals: [],
-        processAverageCPU: 0,
-        processMaximumCPU: 0,
-        systemAverageCPU: 0,
-        systemMaximumCPU: 0
-      },
-      intervalNumber: 0,
-      videoReceive: [
-        {
-          common: {
-            common: {
-              direction: 'inactive',
-              isMain: true, // Not avaliable
-              mariFecEnabled: true, // Not avaliable
-              mariQosEnabled: true, // Not avaliable
-              multistreamEnabled: true// Not avaliable
-            },
-            dtlsBitrate: 0, // Not avaliable
-            dtlsPackets: 0, // Not avaliable
-            fecBitrate: 0, // Not avaliable
-            fecPackets: 0, // Not avaliable
-            maxBitrate: 0,
-            mediaHopByHopLost: 0,
-            rtcpBitrate: 0, // Not avaliable
-            rtcpPackets: 0, // Not avaliable
-            rtpBitrate: 0,
-            rtpHopByHopLost: 0,
-            rtpPackets: 0,
-            rtpRecovered: 0, // Not avaliable
-            rtxBitrate: 0, // Not avaliable
-            rtxPackets: 0, // Not avaliable
-            srtcpUnprotectErrors: 0, // Not avaliable
-            srtpUnprotectErrors: 0, // Not avaliable
-            stunBitrate: 0, // Not avaliable
-            stunPackets: 0, // Not avaliable
-            transportType: 'UDP'
-          },
-          streams: [
-            {
-              common: {
-                codec: 'H264',
-                concealedFrames: 0, // Not avaliable
-                csi: [], // Not avaliable
-                maxConcealRunLength: 0, // Not avaliable
-                optimalBitrate: 0,
-                optimalFrameRate: 0,
-                receivedBitrate: 0,
-                receivedFrameRate: 0,
-                renderedFrameRate: 0, // Not avaliable
-                requestedBitrate: 0,
-                requestedFrameRate: 0,
-                rtpEndToEndLost: 0,
-                rtpJitter: 0,
-                rtpPackets: 0,
-                ssci: 0// Not avaliable
-              },
-              h264CodecProfile: 'BP',
-              isActiveSpeaker: true,
-              optimalFrameSize: 0, // Not avaliable
-              receivedFrameSize: 0,
-              receivedHeight: 0,
-              receivedKeyFrames: 0,
-              receivedKeyFramesForRequest: 0,
-              receivedKeyFramesSourceChange: 0,
-              receivedKeyFramesUnknown: 0,
-              receivedWidth: 0,
-              requestedFrameSize: 0,
-              requestedKeyFrames: 0
-            }
-          ]
-        },
-        {
-          common: {
-            common: {
-              direction: 'inactive',
-              isMain: false, // Not avaliable
-              mariFecEnabled: true, // Not avaliable
-              mariQosEnabled: true, // Not avaliable
-              multistreamEnabled: true// Not avaliable
-            },
-            dtlsBitrate: 0, // Not avaliable
-            dtlsPackets: 0, // Not avaliable
-            fecBitrate: 0, // Not avaliable
-            fecPackets: 0, // Not avaliable
-            maxBitrate: 0,
-            mediaHopByHopLost: 0,
-            rtcpBitrate: 0, // Not avaliable
-            rtcpPackets: 0, // Not avaliable
-            rtpBitrate: 0,
-            rtpHopByHopLost: 0,
-            rtpPackets: 0,
-            rtpRecovered: 0, // Not avaliable
-            rtxBitrate: 0, // Not avaliable
-            rtxPackets: 0, // Not avaliable
-            srtcpUnprotectErrors: 0, // Not avaliable
-            srtpUnprotectErrors: 0, // Not avaliable
-            stunBitrate: 0, // Not avaliable
-            stunPackets: 0, // Not avaliable
-            transportType: 'UDP'
-          },
-          streams: [
-            {
-              common: {
-                codec: 'H264',
-                concealedFrames: 0, // Not avaliable
-                csi: [], // Not avaliable
-                maxConcealRunLength: 0, // Not avaliable
-                optimalBitrate: 0,
-                optimalFrameRate: 0,
-                receivedBitrate: 0,
-                receivedFrameRate: 0,
-                renderedFrameRate: 0, // Not avaliable
-                requestedBitrate: 0,
-                requestedFrameRate: 0,
-                rtpEndToEndLost: 0,
-                rtpJitter: 0,
-                rtpPackets: 0,
-                ssci: 0// Not avaliable
-              },
-              h264CodecProfile: 'BP',
-              isActiveSpeaker: true,
-              optimalFrameSize: 0, // Not avaliable
-              receivedFrameSize: 0,
-              receivedHeight: 0,
-              receivedKeyFrames: 0,
-              receivedKeyFramesForRequest: 0,
-              receivedKeyFramesSourceChange: 0,
-              receivedKeyFramesUnknown: 0,
-              receivedWidth: 0,
-              requestedFrameSize: 0,
-              requestedKeyFrames: 0
-            }
-          ]
-        }
-      ],
-      videoTransmit: [
-        {
-          common: {
-            availableBitrate: 0, // Not avaliable currently hardcoded
-            common: {
-              direction: 'inactive',
-              isMain: true,
-              mariFecEnabled: false, // Not avaliable
-              mariQosEnabled: false, // Not avaliable
-              multistreamEnabled: false// Not avaliable
-            },
-            dtlsBitrate: 0, // Not avaliable
-            dtlsPackets: 0, // Not avaliable
-            fecBitrate: 0, // Not avaliable
-            fecPackets: 0, // TODO: check inbound-rtp// Not avaliable
-            maxBitrate: 0, // Currently hardcoded
-            queueDelay: 0, // outboundRtp.totalPacketSentDelay  // TODO: check if totalInterFrameDelay/ packetSentDelay/ jitterBufferDalay
-            remoteJitter: 0, // remoteInboundRtp.jitter
-            remoteLossRate: 0, // comparedResults.lossRate
-            remoteReceiveRate: 0, // compareResults.packetsLost
-            roundTripTime: 0, // compareResults.roundTripTime
-            rtcpBitrate: 0, // Dont have access to it
-            rtcpPackets: 0, // Dont have access to rtcp
-            rtpBitrate: 0, // Dont have access
-            rtpPackets: 0, // outboundRtp.packetsSent
-            rtxBitrate: 0, // Dont have access to it
-            rtxPackets: 0, // Dont have access to it
-            stunBitrate: 0, // Dont have access to it
-            stunPackets: 0, // Dont have access to it
-            transportType: 'UDP' // TODO: need to calculate
-          },
-          streams: [
-            {
-              common: {
-                codec: 'H264',
-                duplicateSsci: 0, // Not Avaliable
-                requestedBitrate: 0, // TODO: from remote SDP
-                requestedFrames: 0, // TODO: from remote SDP
-                rtpPackets: 0, // same as rtp packets
-                ssci: 0,
-                transmittedBitrate: 0, // TODO: get in the candidate pair
-                transmittedFrameRate: 0 // TODO: from track info
-              },
-              h264CodecProfile: 'BP', // TODO: from localSDP
-              isAvatar: false, // Not Avaliable
-              isHardwareEncoded: false, // Not Avaliable
-              localConfigurationChanges: 2, // Not Avaliable
-              maxFrameQp: 0, // Not Avaliable
-              maxNoiseLevel: 0, // Not Avaliable
-              minRegionQp: 0, // Not Avaliable
-              remoteConfigurationChanges: 0, // Not Avaliable
-              requestedFrameSize: 0, // TODO: from remote SDP
-              requestedKeyFrames: 0, // outbound Fir request
-              transmittedFrameSize: 0, // Not Avaliable
-              transmittedHeight: 0,
-              transmittedKeyFrames: 0, // Key frames encoded
-              transmittedKeyFramesClient: 0, // Not Avaliable
-              transmittedKeyFramesConfigurationChange: 0, // Not Avaliable
-              transmittedKeyFramesFeedback: 0, // Not Avaliable
-              transmittedKeyFramesLocalDrop: 0, // Not Avaliable
-              transmittedKeyFramesOtherLayer: 0, // Not Avaliable
-              transmittedKeyFramesPeriodic: 0, // Not Avaliable
-              transmittedKeyFramesSceneChange: 0, // Not Avaliable
-              transmittedKeyFramesStartup: 0, // Not Avaliable
-              transmittedKeyFramesUnknown: 0, // Not Avaliable
-              transmittedWidth: 0
-            }
-          ]
-        },
-        { // sceen sharing
-          common: {
-            availableBitrate: 0, // Not avaliable currently hardcoded
-            common: {
-              direction: 'inactive',
-              isMain: false,
-              mariFecEnabled: false, // Not avaliable
-              mariQosEnabled: false, // Not avaliable
-              multistreamEnabled: false// Not avaliable
-            },
-            dtlsBitrate: 0, // Not avaliable
-            dtlsPackets: 0, // Not avaliable
-            fecBitrate: 0, // Not avaliable
-            fecPackets: 0, // TODO: check inbound-rtp// Not avaliable
-            maxBitrate: 0, // Currently hardcoded
-            queueDelay: 0, // outboundRtp.totalPacketSentDelay  // TODO: check if totalInterFrameDelay/ packetSentDelay/ jitterBufferDalay
-            remoteJitter: 0, // remoteInboundRtp.jitter
-            remoteLossRate: 0, // comparedResults.lossRate
-            remoteReceiveRate: 0, // compareResults.packetsLost
-            roundTripTime: 0, // compareResults.roundTripTime
-            rtcpBitrate: 0, // Dont have access to it
-            rtcpPackets: 0, // Dont have access to rtcp
-            rtpBitrate: 0, // Dont have access
-            rtpPackets: 0, // outboundRtp.packetsSent
-            rtxBitrate: 0, // Dont have access to it
-            rtxPackets: 0, // Dont have access to it
-            stunBitrate: 0, // Dont have access to it
-            stunPackets: 0, // Dont have access to it
-            transportType: 'UDP' // TODO: need to calculate
-          },
-          streams: [
-            {
-              common: {
-                codec: 'H264',
-                duplicateSsci: 0, // Not Avaliable
-                requestedBitrate: 0, // TODO: from remote SDP
-                requestedFrames: 0, // TODO: from remote SDP
-                rtpPackets: 0, // same as rtp packets
-                ssci: 0,
-                transmittedBitrate: 0, // TODO: get in the candidate pair
-                transmittedFrameRate: 0 // TODO: from track info
-              },
-              h264CodecProfile: 'BP', // TODO: from localSDP
-              isAvatar: false, // Not Avaliable
-              isHardwareEncoded: false, // Not Avaliable
-              localConfigurationChanges: 2, // Not Avaliable
-              maxFrameQp: 0, // Not Avaliable
-              maxNoiseLevel: 0, // Not Avaliable
-              minRegionQp: 0, // Not Avaliable
-              remoteConfigurationChanges: 0, // Not Avaliable
-              requestedFrameSize: 0, // TODO: from remote SDP
-              requestedKeyFrames: 0, // outbound Fir request
-              transmittedFrameSize: 0, // Not Avaliable
-              transmittedHeight: 0,
-              transmittedKeyFrames: 0, // Key frames encoded
-              transmittedKeyFramesClient: 0, // Not Avaliable
-              transmittedKeyFramesConfigurationChange: 0, // Not Avaliable
-              transmittedKeyFramesFeedback: 0, // Not Avaliable
-              transmittedKeyFramesLocalDrop: 0, // Not Avaliable
-              transmittedKeyFramesOtherLayer: 0, // Not Avaliable
-              transmittedKeyFramesPeriodic: 0, // Not Avaliable
-              transmittedKeyFramesSceneChange: 0, // Not Avaliable
-              transmittedKeyFramesStartup: 0, // Not Avaliable
-              transmittedKeyFramesUnknown: 0, // Not Avaliable
-              transmittedWidth: 0
-            }
-          ]
-        }
-      ]
-    }
-  ]
-};

package/src/meeting/effectsState.js

@@ -1,205 +0,0 @@
-/* eslint-disable no-param-reassign */
-import {Media as WebRTCMedia} from '@webex/internal-media-core';
-
-import BEHAVIORAL_METRICS from '../metrics/constants';
-import Metrics from '../metrics';
-import MediaUtil from '../media/util';
-import LoggerProxy from '../common/logs/logger-proxy';
-import {BNR_STATUS} from '../constants';
-
-const createEffectsState = (type) => {
-  LoggerProxy.logger.info(`Meeting:effectState#createEffectsState --> creating effectsState for effect ${type}`);
-
-  return new EffectsState(type);
-};
-
-/* The purpose of this class is to manage the effects state(for eg., BNR).
-*/
-class EffectsState {
-  constructor(type) {
-    this.effectType = type;
-    this.state = {
-      bnr: {
-        enabled: BNR_STATUS.NOT_ENABLED
-      },
-      callToWebrtcBNRInProgress: false
-    };
-    // these 2 hold the resolve, reject methods for the promise we returned to the client in last handleClientRequest() call
-    this.pendingPromiseResolve = null;
-    this.pendingPromiseReject = null;
-  }
-
-  /**
-   * @memberof EffectsState
-   * @param {Boolean} [isEnable] true for enableBNR, false for disableBNR request
-   * @param {Object} [meeting] the meeting object
-   * @returns {Promise}
-   */
-  async handleClientRequest(isEnable, meeting) {
-    return new Promise((resolve, reject) => {
-      if (this.pendingPromiseResolve) {
-        // resolve the last promise we returned to the client as the client has issued a new request that has superseded the previous one
-        this.pendingPromiseResolve();
-      }
-      this.pendingPromiseResolve = resolve;
-      this.pendingPromiseReject = reject;
-
-      if (isEnable) this.enableBNR(meeting);
-      else this.disableBNR(meeting);
-    });
-  }
-
-  /**
-   * Internal API to return status of BNR
-   * @memberof EffectsState
-   * @returns {Boolean}
-   * @public
-   * @memberof Meeting
-   */
-  isBnrEnabled() {
-    return this.state.bnr.enabled === BNR_STATUS.ENABLED;
-  }
-
-  resolvePromise() {
-    if (this.pendingPromiseResolve) {
-      this.pendingPromiseResolve(true);
-    }
-    this.pendingPromiseResolve = null;
-    this.pendingPromiseReject = null;
-  }
-
-  rejectPromise(e) {
-    if (this.pendingPromiseReject) {
-      this.pendingPromiseReject(e);
-    }
-    this.pendingPromiseResolve = null;
-    this.pendingPromiseReject = null;
-  }
-
-  /**
-   * enableBNR API
-   * @param {Object} meeting the meeting object
-   * @returns {Promise<Boolean>}
-   * @public
-   * @memberof EffectsState
-   */
-  async enableBNR(meeting) {
-    LoggerProxy.logger.info('Meeting:effectState#enableBNR. Enable BNR called');
-
-    if (this.isBnrEnabled()) {
-      LoggerProxy.logger.warn('Meeting:index#enableBNR. BNR is already enabled');
-
-      return this.resolvePromise();
-    }
-
-    if (this.state.callToWebrtcBNRInProgress) {
-      LoggerProxy.logger.warn('Meeting:effectState#enableBNR. Call to WebRTC in progress, we need to wait for it to complete');
-
-      return this.resolvePromise();
-    }
-
-    const {bnr} = this.state;
-
-    try {
-      bnr.enabled = BNR_STATUS.SHOULD_ENABLE;
-      this.state.callToWebrtcBNRInProgress = true;
-      const audioStream = MediaUtil.createMediaStream([meeting.mediaProperties.audioTrack]);
-
-      LoggerProxy.logger.info('Meeting:effectState#enableBNR. MediaStream created from meeting & sent to updateAudio');
-      await meeting.updateAudio({
-        sendAudio: true,
-        receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,
-        stream: audioStream
-      });
-
-      LoggerProxy.logger.info('Meeting:effectState#enableBNR. Updated meeting audio with bnr enabled track');
-      bnr.enabled = BNR_STATUS.ENABLED;
-      this.state.callToWebrtcBNRInProgress = false;
-      Metrics.sendBehavioralMetric(
-        BEHAVIORAL_METRICS.ENABLE_BNR_SUCCESS,
-      );
-    }
-    catch (error) {
-      bnr.enabled = BNR_STATUS.NOT_ENABLED;
-      this.state.callToWebrtcBNRInProgress = false;
-      LoggerProxy.logger.error('Meeting:index#enableBNR.', error);
-
-      Metrics.sendBehavioralMetric(
-        BEHAVIORAL_METRICS.ENABLE_BNR_FAILURE,
-        {
-          reason: error.message,
-          stack: error.stack
-        }
-      );
-      this.rejectPromise(error);
-
-      throw error;
-    }
-
-    return this.resolvePromise();
-  }
-
-  /**
-   * disableBNR API
-   * @param {Object} meeting the meeting object
-   * @returns {Promise<Boolean>}
-   * @public
-   * @memberof EffectsState
-   */
-  async disableBNR(meeting) {
-    LoggerProxy.logger.info('Meeting:effectState#disableBNR. Disable BNR called');
-
-    const {bnr} = this.state;
-
-    try {
-      if (this.state.callToWebrtcBNRInProgress) {
-        LoggerProxy.logger.info('Meeting:effectState#disableBNR. Call to WebRTC in progress, we need to wait for it to complete');
-
-        return this.resolvePromise();
-      }
-
-      bnr.enabled = BNR_STATUS.SHOULD_DISABLE;
-      this.state.callToWebrtcBNRInProgress = true;
-
-      const audioTrack = WebRTCMedia.Effects.BNR.disableBNR(meeting.mediaProperties.audioTrack);
-
-      const audioStream = MediaUtil.createMediaStream([audioTrack]);
-
-      LoggerProxy.logger.info('Meeting:effectState#disableBNR. Raw media track obtained from WebRTC & sent to updateAudio');
-
-      await meeting.updateAudio({
-        sendAudio: true,
-        receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,
-        stream: audioStream
-      });
-
-      bnr.enabled = BNR_STATUS.NOT_ENABLED;
-
-      this.state.callToWebrtcBNRInProgress = false;
-
-      Metrics.sendBehavioralMetric(
-        BEHAVIORAL_METRICS.DISABLE_BNR_SUCCESS
-      );
-    }
-    catch (error) {
-      bnr.enabled = BNR_STATUS.ENABLED;
-      this.state.callToWebrtcBNRInProgress = false;
-      LoggerProxy.logger.error(`Meeting:index#disableBNR. ${error}`);
-
-      Metrics.sendBehavioralMetric(
-        BEHAVIORAL_METRICS.DISABLE_BNR_FAILURE,
-        {
-          reason: error.message,
-          stack: error.stack
-        }
-      );
-      this.rejectPromise(error);
-
-      throw error;
-    }
-
-    return this.resolvePromise();
-  }
-}
-
-export default createEffectsState;