@webex/plugin-meetings 3.0.0-beta.3 → 3.0.0-beta.300

package/src/media/properties.js

@@ -1,289 +0,0 @@
-import {MediaConnection as MC} from '@webex/internal-media-core';
-
-import {
-  MEETINGS,
-  PC_BAIL_TIMEOUT,
-  QUALITY_LEVELS
-} from '../constants';
-import LoggerProxy from '../common/logs/logger-proxy';
-
-/**
- * @class MediaProperties
- */
-export default class MediaProperties {
-  namespace = MEETINGS;
-
-  /**
-   * @param {Object} [options] -- to auto construct
-   * @returns {MediaProperties}
-   */
-  constructor(options = {}) {
-    this.webrtcMediaConnection = null;
-    this.mediaDirection = options.mediaDirection;
-    this.videoTrack = options.videoTrack;
-    this.audioTrack = options.audioTrack;
-    this.shareTrack = options.shareTrack;
-    this.remoteShare = options.remoteShare;
-    this.remoteAudioTrack = options.remoteAudioTrack;
-    this.remoteVideoTrack = options.remoteVideoTrack;
-    this.localQualityLevel = options.localQualityLevel || QUALITY_LEVELS['720p'];
-    this.remoteQualityLevel = options.remoteQualityLevel || QUALITY_LEVELS.HIGH;
-    this.mediaSettings = {};
-    this.videoDeviceId = null;
-  }
-
-  /**
-   * Retrieves the preferred video input device
-   * @returns {Object|null}
-   */
-  getVideoDeviceId() {
-    return this.videoDeviceId || null;
-  }
-
-  setMediaDirection(mediaDirection) {
-    this.mediaDirection = mediaDirection;
-  }
-
-  setMediaSettings(type, values) {
-    this.mediaSettings[type] = values;
-  }
-
-  setMediaPeerConnection(mediaPeerConnection) {
-    this.webrtcMediaConnection = mediaPeerConnection;
-  }
-
-  setLocalVideoTrack(videoTrack) {
-    this.videoTrack = videoTrack;
-  }
-
-  setLocalAudioTrack(audioTrack) {
-    this.audioTrack = audioTrack;
-  }
-
-  setLocalQualityLevel(localQualityLevel) {
-    this.localQualityLevel = localQualityLevel;
-  }
-
-  setLocalShareTrack(shareTrack) {
-    this.shareTrack = shareTrack;
-  }
-
-  setRemoteQualityLevel(remoteQualityLevel) {
-    this.remoteQualityLevel = remoteQualityLevel;
-  }
-
-  setRemoteShare(remoteShare) {
-    this.remoteShare = remoteShare;
-  }
-
-  /**
-   * Sets the remote audio track
-   * @param {MediaTrack} remoteAudioTrack MediaTrack to save
-   * @returns {void}
-   */
-  setRemoteAudioTrack(remoteAudioTrack) {
-    this.remoteAudioTrack = remoteAudioTrack;
-  }
-
-  /**
-   * Sets the remote video track
-   * @param {MediaTrack} remoteVideoTrack MediaTrack to save
-   * @returns {void}
-   */
-  setRemoteVideoTrack(remoteVideoTrack) {
-    this.remoteVideoTrack = remoteVideoTrack;
-  }
-
-  /**
-   * Stores the preferred video input device
-   * @param {string} deviceId Preferred video input device
-   * @returns {void}
-   */
-  setVideoDeviceId(deviceId) {
-    this.videoDeviceId = deviceId;
-  }
-
-  unsetPeerConnection() {
-    this.webrtcMediaConnection = null;
-  }
-
-  unsetLocalVideoTrack() {
-    this.videoTrack = null;
-  }
-
-  unsetLocalShareTrack() {
-    this.shareTrack = null;
-  }
-
-  unsetLocalAudioTrack() {
-    this.audioTrack = null;
-  }
-
-  /**
-   * Removes remote stream from class instance
-   * @deprecated after v1.89.3
-   * @returns {void}
-   */
-  unsetRemoteStream() {
-    LoggerProxy.logger.warn('Media:properties#unsetRemoteStream --> [DEPRECATION WARNING]: unsetRemoteStream has been deprecated after v1.89.3 (use unsetRemoteTracks instead)');
-    // unsets audio and video only
-    this.unsetRemoteMedia();
-  }
-
-  /**
-   * Removes both remote audio and video from class instance
-   * @returns {void}
-   */
-  unsetRemoteMedia() {
-    this.remoteAudioTrack = null;
-    this.remoteVideoTrack = null;
-  }
-
-  unsetRemoteShare() {
-    this.remoteShare = null;
-  }
-
-  unsetLocalVideoTracks() {
-    this.unsetLocalVideoTrack();
-    this.unsetLocalShareTrack();
-  }
-
-  /**
-   * Removes remote stream and remote share from class instance
-   * @deprecated after v1.89.3
-   * @returns {void}
-   */
-  unsetRemoteStreams() {
-    LoggerProxy.logger.warn('Media:properties#unsetRemoteStreams --> [DEPRECATION WARNING]: unsetRemoteStreams has been deprecated after v1.89.3 (use unsetRemoteTracks instead)');
-    this.unsetRemoteStream();
-    this.unsetRemoteShare();
-  }
-
-  /**
-   * Unsets all remote tracks
-   * @returns {void}
-   */
-  unsetRemoteTracks() {
-    this.unsetRemoteMedia();
-    this.unsetRemoteShare();
-  }
-
-  unsetShareStreams() {
-    this.unsetLocalShareTrack();
-    this.unsetRemoteShare();
-  }
-
-  /**
-   * Removes both local and remote video stream from class instance
-   * @deprecated after v1.89.3
-   * @returns {void}
-   */
-  unsetMediaStreams() {
-    LoggerProxy.logger.warn('Media:properties#unsetMediaStreams --> [DEPRECATION WARNING]: unsetMediaStreams has been deprecated after v1.89.3 (use unsetMediaTracks instead)');
-    this.unsetLocalVideoTrack();
-    this.unsetRemoteStream();
-  }
-
-  /**
-   * Removes both local and remote video stream from class instance
-   * @returns {void}
-   */
-  unsetMediaTracks() {
-    this.unsetLocalVideoTrack();
-    this.unsetRemoteMedia();
-  }
-
-  /**
-   * Waits for the webrtc media connection to be connected.
-   *
-   * @returns {Promise<void>}
-   */
-  waitForMediaConnectionConnected() {
-    const isConnected = () => (
-      this.webrtcMediaConnection.getConnectionState() === MC.ConnectionState.Connected
-    );
-
-    if (isConnected()) {
-      return Promise.resolve();
-    }
-
-    return new Promise((resolve, reject) => {
-      let timer;
-
-      const connectionStateListener = () => {
-        LoggerProxy.logger.log(`Media:properties#waitForMediaConnectionConnected --> connection state: ${this.webrtcMediaConnection.getConnectionState()}`);
-
-        if (isConnected()) {
-          clearTimeout(timer);
-          this.webrtcMediaConnection.off(MC.Event.CONNECTION_STATE_CHANGED, connectionStateListener);
-          resolve();
-        }
-      };
-
-      timer = setTimeout(() => {
-        this.webrtcMediaConnection.off(MC.Event.CONNECTION_STATE_CHANGED, connectionStateListener);
-        reject();
-      }, PC_BAIL_TIMEOUT);
-
-      this.webrtcMediaConnection.on(MC.Event.CONNECTION_STATE_CHANGED, connectionStateListener);
-    });
-  }
-
-  /**
-   * Returns the type of a connection that has been established
-   *
-   * @returns {Promise<'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'>}
-   */
-  async getCurrentConnectionType() {
-    // we can only get the connection type after ICE connection has been established
-    await this.waitForMediaConnectionConnected();
-
-    const allStatsReports = [];
-
-    try {
-      // eslint-disable-next-line no-await-in-loop
-      const statsResult = await this.webrtcMediaConnection.getStats();
-
-      statsResult.forEach((report) => allStatsReports.push(report));
-    }
-    catch (error) {
-      LoggerProxy.logger.warn(`Media:properties#getCurrentConnectionType --> getStats() failed: ${error}`);
-    }
-
-    const successfulCandidatePairs = allStatsReports.filter(
-      (report) => report.type === 'candidate-pair' && report.state?.toLowerCase() === 'succeeded'
-    );
-
-    let foundConnectionType = 'unknown';
-
-    // all of the successful pairs should have the same connection type, so just return the type for the first one
-    successfulCandidatePairs.some((pair) => {
-      const localCandidate = allStatsReports.find((report) => report.type === 'local-candidate' && report.id === pair.localCandidateId);
-
-      if (localCandidate === undefined) {
-        LoggerProxy.logger.warn(`Media:properties#getCurrentConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`);
-
-        return false;
-      }
-
-      let connectionType;
-
-      if (localCandidate.relayProtocol) {
-        connectionType = `TURN-${localCandidate.relayProtocol.toUpperCase()}`;
-      }
-      else {
-        connectionType = localCandidate.protocol?.toUpperCase(); // it will be UDP or TCP
-      }
-
-      if (connectionType) {
-        foundConnectionType = connectionType;
-
-        return true;
-      }
-
-      return false;
-    });
-
-    return foundConnectionType;
-  }
-}

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
-            }
-          ]
-        }
-      ]
-    }
-  ]
-};