@webex/plugin-meetings 3.3.1 → 3.4.0-next.2

package/dist/types/statsAnalyzer/mqaUtil.d.ts

@@ -1,48 +0,0 @@
-export declare const getAudioReceiverMqa: ({ audioReceiver, statsResults, lastMqaDataSent, baseMediaType, }: {
-    audioReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getAudioReceiverStreamMqa: ({ audioReceiverStream, statsResults, lastMqaDataSent, mediaType, }: {
-    audioReceiverStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getAudioSenderMqa: ({ audioSender, statsResults, lastMqaDataSent, baseMediaType }: {
-    audioSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getAudioSenderStreamMqa: ({ audioSenderStream, statsResults, lastMqaDataSent, mediaType, }: {
-    audioSenderStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoReceiverMqa: ({ videoReceiver, statsResults, lastMqaDataSent, baseMediaType, }: {
-    videoReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getVideoReceiverStreamMqa: ({ videoReceiverStream, statsResults, lastMqaDataSent, mediaType, }: {
-    videoReceiverStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoSenderMqa: ({ videoSender, statsResults, lastMqaDataSent, baseMediaType }: {
-    videoSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getVideoSenderStreamMqa: ({ videoSenderStream, statsResults, lastMqaDataSent, mediaType, }: {
-    videoSenderStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;

package/src/mediaQualityMetrics/config.ts

@@ -1,255 +0,0 @@
-export const emptyMqaInterval = {
-  audioReceive: [],
-  audioTransmit: [],
-  intervalMetadata: {
-    peerReflexiveIP: '0.0.0.0',
-    peripherals: [],
-    processAverageCPU: 0,
-    processMaximumCPU: 0,
-    systemAverageCPU: 0,
-    systemMaximumCPU: 0,
-  },
-  networkType: '',
-  intervalNumber: 0,
-  videoReceive: [],
-  videoTransmit: [],
-};
-
-export const emptyAudioReceive = {
-  common: {
-    common: {
-      direction: 'inactive',
-      isMain: true,
-      mariFecEnabled: false,
-      mariRtxEnabled: false,
-      mariQosEnabled: false,
-      mariLiteEnabled: 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: [],
-};
-
-export const emptyAudioReceiveStream = {
-  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,
-  },
-};
-
-export const emptyAudioTransmit = {
-  common: {
-    availableBitrate: 0,
-    common: {
-      direction: 'inactive',
-      isMain: true,
-      mariFecEnabled: false,
-      mariRtxEnabled: false,
-      mariQosEnabled: false,
-      mariLiteEnabled: false,
-      multistreamEnabled: false,
-    },
-    dtlsBitrate: 0,
-    dtlsPackets: 0,
-    fecBitrate: 0,
-    fecPackets: 0,
-    maxBitrate: 0,
-    queueDelay: 0,
-    remoteJitter: 0,
-    remoteLossRate: 0,
-    roundTripTime: 0,
-    rtcpBitrate: 0,
-    rtcpPackets: 0,
-    rtpBitrate: 0,
-    rtpPackets: 0,
-    rtxBitrate: 0,
-    rtxPackets: 0,
-    stunBitrate: 0,
-    stunPackets: 0,
-    transportType: 'UDP',
-  },
-  streams: [],
-};
-
-export const emptyAudioTransmitStream = {
-  common: {
-    codec: 'opus',
-    csi: [],
-    requestedBitrate: 0,
-    requestedFrames: 0,
-    rtpPackets: 0,
-    ssci: 0,
-    transmittedBitrate: 0,
-    transmittedFrameRate: 0,
-  },
-};
-
-export const emptyVideoReceive = {
-  common: {
-    common: {
-      direction: 'inactive',
-      isMain: true, // Not avaliable
-      mariFecEnabled: false,
-      mariRtxEnabled: false,
-      mariQosEnabled: false,
-      mariLiteEnabled: false,
-      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: [],
-};
-
-export const emptyVideoReceiveStream = {
-  common: {
-    codec: 'H264',
-    concealedFrames: 0, // Not avaliable
-    csi: [],
-    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,
-};
-
-export const emptyVideoTransmit = {
-  common: {
-    availableBitrate: 0, // Not avaliable currently hardcoded
-    common: {
-      direction: 'inactive',
-      isMain: true,
-      mariFecEnabled: false,
-      mariRtxEnabled: false,
-      mariQosEnabled: false,
-      mariLiteEnabled: false,
-      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,
-    remoteJitter: 0, // remoteInboundRtp.jitter
-    remoteLossRate: 0, // comparedResults.lossRate
-    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: [],
-};
-
-export const emptyVideoTransmitStream = {
-  common: {
-    codec: 'H264',
-    csi: [],
-    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/networkQualityMonitor/index.ts

@@ -1,211 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-import {EVENT_TRIGGERS} from '../constants';
-
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-export default class NetworkQualityMonitor extends EventsScope {
-  config: any;
-  frequencyTypes: any;
-  indicatorTypes: any;
-  mediaType: any;
-  networkQualityScore: any;
-  networkQualityStatus: any;
-
-  /**
-   * Creates a new instance of NetworkQualityMonitor
-   * @constructor
-   * @public
-   * @param {Object} config
-   * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-   * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-   * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-   * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-   * @property {string} mediaType - audio|video
-   */
-  constructor(config: any) {
-    super();
-    this.config = config;
-    this.indicatorTypes = Object.freeze({
-      PACKETLOSS: 'packetLoss',
-      LATENCY: 'latency',
-      JITTER: 'jitter',
-    });
-    this.frequencyTypes = Object.freeze({
-      UPLINK: 'uplink',
-      DOWNLINK: 'downlink',
-    });
-    this.networkQualityScore = 1;
-    this.networkQualityStatus = {
-      [this.frequencyTypes.UPLINK]: {},
-    };
-    this.mediaType = null;
-  }
-
-  /**
-   * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-   *
-   * @memberof NetworkQualityMonitor
-   * @returns {void}
-   */
-  emitNetworkQuality() {
-    this.emit(
-      {
-        file: 'networkQualityMonitor',
-        function: 'emitNetworkQuality',
-      },
-      EVENT_TRIGGERS.NETWORK_QUALITY,
-      {
-        mediaType: this.mediaType,
-        networkQualityScore: this.networkQualityScore,
-      }
-    );
-  }
-
-  /**
-   * invokes emitNetworkQuality method resets values back to default
-   * @returns {void}
-   * @memberof NetworkQualityMonitor
-   */
-  updateNetworkQualityStatus() {
-    this.emitNetworkQuality();
-
-    // reset values
-    this.networkQualityScore = 1;
-    this.mediaType = null;
-  }
-
-  /**
-   * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-   * @param {Object} configObj
-   * @param {string} configObj.mediaType {audio|video}
-   * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-   * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-   * @returns {void}
-   * @public
-   * @memberof NetworkQualityMonitor
-   */
-  public determineUplinkNetworkQuality({
-    mediaType,
-    remoteRtpResults,
-    statsAnalyzerCurrentStats,
-  }: {
-    mediaType: string;
-    remoteRtpResults: any;
-    statsAnalyzerCurrentStats: object;
-  }) {
-    const roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;
-    const jitterInMilliseconds = remoteRtpResults.jitter * 1000;
-    const {currentPacketLossRatio} = statsAnalyzerCurrentStats[mediaType].send;
-
-    this.mediaType = mediaType;
-
-    const {JITTER, PACKETLOSS, LATENCY} = this.indicatorTypes;
-    const {UPLINK} = this.frequencyTypes;
-
-    /**
-     * determines if packetLoss ratio is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determinePacketLoss = () => {
-      if (currentPacketLossRatio > this.config.videoPacketLossRatioThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if round trip time value is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determineLatency = () => {
-      if (roundTripTimeInMilliseconds > this.config.rttThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if jitter value is over threshold in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const deterMineJitter = () => {
-      if (jitterInMilliseconds > this.config.jitterThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * returns null if val is specifically undefined
-     * @param {(number|undefined)} value
-     * @returns {(number|null)}
-     */
-    const determineIfUndefined = (value: number | undefined) =>
-      typeof value === 'undefined' ? null : value;
-
-    if (!this.networkQualityStatus[UPLINK][mediaType]) {
-      this.networkQualityStatus[UPLINK][mediaType] = {};
-    }
-
-    /**
-     * Values for some browsers specifically Safari will be undefined we explicitly set to null
-     * https://bugs.webkit.org/show_bug.cgi?id=206645
-     * https://bugs.webkit.org/show_bug.cgi?id=212668
-     */
-    // PACKET LOSS
-    this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {
-      acceptable: determinePacketLoss(),
-      value: determineIfUndefined(currentPacketLossRatio),
-    };
-
-    // LATENCY measured in Round trip time
-    this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {
-      acceptable: determineLatency(),
-      value: determineIfUndefined(remoteRtpResults.roundTripTime),
-    };
-
-    // JITTER
-    this.networkQualityStatus[UPLINK][mediaType][JITTER] = {
-      acceptable: deterMineJitter(),
-      value: determineIfUndefined(remoteRtpResults.jitter),
-    };
-
-    this.updateNetworkQualityStatus();
-  }
-
-  /**
-   * Get the current status of network quaility object - networkQualityStatus
-   * @returns {Object}
-   * @public
-   */
-  get networkQualityStats() {
-    const {UPLINK} = this.frequencyTypes;
-
-    return this.networkQualityStatus[UPLINK];
-  }
-}

package/src/statsAnalyzer/global.ts

@@ -1,37 +0,0 @@
-const STATS_DEFAULT = {
-  encryption: 'sha-256',
-  bandwidth: {
-    systemBandwidth: 0,
-    sentPerSecond: 0,
-    encodedPerSecond: 0,
-    helper: {
-      audioBytesSent: 0,
-      videoBytestSent: 0,
-    },
-    speed: 0,
-  },
-  results: {},
-  connectionType: {
-    systemNetworkType: 'unknown',
-    systemIpAddress: '0.0.0.0',
-    local: {
-      candidateType: [],
-      transport: [],
-      ipAddress: [],
-      networkType: [],
-    },
-    remote: {
-      candidateType: [],
-      transport: [],
-      ipAddress: [],
-      networkType: [],
-    },
-  },
-  resolutions: {},
-  internal: {
-    remote: {},
-    candidates: {},
-  },
-};
-
-export default STATS_DEFAULT;