@webex/plugin-meetings 3.0.0-beta.13 → 3.0.0-beta.15

package/src/media/index.ts

@@ -4,11 +4,7 @@
 /* globals navigator */
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  AUDIO_INPUT,
-  VIDEO_INPUT,
-  MEDIA_TRACK_CONSTRAINT,
-} from '../constants';
+import {AUDIO_INPUT, VIDEO_INPUT, MEDIA_TRACK_CONSTRAINT} from '../constants';
 import Config from '../config';
 import StaticConfig from '../common/config';
 import MediaError from '../common/errors/media';
@@ -77,10 +73,10 @@ Media.generateLocalMedias = (mediaId: string, audioMuted: boolean, videoMuted: b
       {
         localSdp: JSON.stringify({
           audioMuted,
-          videoMuted
+          videoMuted,
         }),
-        mediaId
-      }
+        mediaId,
+      },
     ];
   }
 
@@ -94,9 +90,7 @@ Media.generateLocalMedias = (mediaId: string, audioMuted: boolean, videoMuted: b
  * @returns {Promise}
  */
 Media.getLocalMedia = (options: any, config: object) => {
-  const {
-    sendAudio, sendVideo, sendShare, sharePreferences, isSharing
-  } = options;
+  const {sendAudio, sendVideo, sendShare, sharePreferences, isSharing} = options;
 
   if (sendAudio || sendVideo) {
     return Media.getMedia(sendAudio, sendVideo, config);
@@ -107,7 +101,7 @@ Media.getLocalMedia = (options: any, config: object) => {
       {
         sendAudio: false,
         sendShare: true,
-        sharePreferences
+        sharePreferences,
       },
       config
     );
@@ -136,31 +130,25 @@ Media.createMediaConnection = (
   options: {
     mediaProperties?: {
       mediaDirection?: {
-        receiveAudio: boolean,
-        receiveVideo: boolean,
-        receiveShare: boolean,
-      },
-      audioTrack?: MediaStreamTrack,
-      videoTrack?: MediaStreamTrack,
-      shareTrack?: MediaStreamTrack
-    },
-    remoteQualityLevel?: 'LOW'|'MEDIUM'|'HIGH',
-    enableRtx?: boolean,
-    enableExtmap?: boolean,
+        receiveAudio: boolean;
+        receiveVideo: boolean;
+        receiveShare: boolean;
+      };
+      audioTrack?: MediaStreamTrack;
+      videoTrack?: MediaStreamTrack;
+      shareTrack?: MediaStreamTrack;
+    };
+    remoteQualityLevel?: 'LOW' | 'MEDIUM' | 'HIGH';
+    enableRtx?: boolean;
+    enableExtmap?: boolean;
     turnServerInfo?: {
-      url: string,
-      username: string,
-      password: string
-    }
+      url: string;
+      username: string;
+      password: string;
+    };
   }
 ) => {
-  const {
-    mediaProperties,
-    remoteQualityLevel,
-    enableRtx,
-    enableExtmap,
-    turnServerInfo
-  } = options;
+  const {mediaProperties, remoteQualityLevel, enableRtx, enableExtmap, turnServerInfo} = options;
 
   const iceServers = [];
 
@@ -168,57 +156,58 @@ Media.createMediaConnection = (
     iceServers.push({
       urls: turnServerInfo.url,
       username: turnServerInfo.username || '',
-      credential: turnServerInfo.password || ''
+      credential: turnServerInfo.password || '',
     });
   }
 
   if (isMultistream) {
-    return new MultistreamRoapMediaConnection({
-      iceServers,
-    }, debugId);
+    return new MultistreamRoapMediaConnection(
+      {
+        iceServers,
+      },
+      debugId
+    );
   }
 
   if (!mediaProperties) {
     throw new Error('mediaProperties have to be provided for non-multistream media connections');
   }
 
-  const {
-    mediaDirection,
-    audioTrack,
-    videoTrack,
-    shareTrack
-  } = mediaProperties;
-
-
-  return new RoapMediaConnection({
-    iceServers,
-    skipInactiveTransceivers: false,
-    requireH264: true,
-    sdpMunging: {
-      convertPort9to0: false,
-      addContentSlides: true,
-      bandwidthLimits: {
-        audio: StaticConfig.meetings.bandwidth.audio,
-        video: StaticConfig.meetings.bandwidth.video,
+  const {mediaDirection, audioTrack, videoTrack, shareTrack} = mediaProperties;
+
+  return new RoapMediaConnection(
+    {
+      iceServers,
+      skipInactiveTransceivers: false,
+      requireH264: true,
+      sdpMunging: {
+        convertPort9to0: false,
+        addContentSlides: true,
+        bandwidthLimits: {
+          audio: StaticConfig.meetings.bandwidth.audio,
+          video: StaticConfig.meetings.bandwidth.video,
+        },
+        startBitrate: StaticConfig.meetings.bandwidth.startBitrate,
+        periodicKeyframes: 20, // it's always been hardcoded in SDK so for now keeping it that way
+        disableExtmap: !enableExtmap,
+        disableRtx: !enableRtx, // see https://bugs.chromium.org/p/chromium/issues/detail?id=1020642 why we might want to remove RTX from SDP
       },
-      startBitrate: StaticConfig.meetings.bandwidth.startBitrate,
-      periodicKeyframes: 20, // it's always been hardcoded in SDK so for now keeping it that way
-      disableExtmap: !enableExtmap,
-      disableRtx: !enableRtx, // see https://bugs.chromium.org/p/chromium/issues/detail?id=1020642 why we might want to remove RTX from SDP
-    }
-  }, {
-    send: {
-      audio: audioTrack,
-      video: videoTrack,
-      screenShareVideo: shareTrack
     },
-    receive: {
-      audio: mediaDirection.receiveAudio,
-      video: mediaDirection.receiveVideo,
-      screenShareVideo: mediaDirection.receiveShare,
-      remoteQualityLevel
-    }
-  }, debugId);
+    {
+      send: {
+        audio: audioTrack,
+        video: videoTrack,
+        screenShareVideo: shareTrack,
+      },
+      receive: {
+        audio: mediaDirection.receiveAudio,
+        video: mediaDirection.receiveVideo,
+        screenShareVideo: mediaDirection.receiveShare,
+        remoteQualityLevel,
+      },
+    },
+    debugId
+  );
 };
 
 /**
@@ -252,38 +241,31 @@ Media.getDisplayMedia = (
   const hasSharePreferences = options.sharePreferences;
   const hasCustomConstraints = hasSharePreferences && hasSharePreferences.shareConstraints;
   const hasHighFrameRate = hasSharePreferences && hasSharePreferences.highFrameRate;
-  const {
-    screenResolution,
-    resolution,
-    videoShareFrameRate,
-    screenFrameRate,
-    aspectRatio
-  } = Config.meetings;
+  const {screenResolution, resolution, videoShareFrameRate, screenFrameRate, aspectRatio} =
+    Config.meetings;
 
   let shareConstraints: any = {
     cursor: MEDIA_TRACK_CONSTRAINT.CURSOR.AWLAYS,
-    aspectRatio
+    aspectRatio,
   };
 
   if (hasCustomConstraints) {
     shareConstraints = hasSharePreferences.shareConstraints;
-  }
-  else if (hasHighFrameRate) {
+  } else if (hasHighFrameRate) {
     shareConstraints = {
       ...shareConstraints,
       frameRate: videoShareFrameRate,
       height: resolution.idealHeight,
       width: resolution.idealWidth,
-      ...config.resolution
+      ...config.resolution,
     };
-  }
-  else {
+  } else {
     shareConstraints = {
       ...shareConstraints,
       frameRate: customShareFrameRate || screenFrameRate,
       height: customResolution.idealHeight || screenResolution.idealHeight,
       width: customResolution.idealWidth || screenResolution.idealWidth,
-      ...config.screenResolution
+      ...config.screenResolution,
     };
   }
 
@@ -294,15 +276,14 @@ Media.getDisplayMedia = (
   // to have higher quality, and for developers to control the values
   // eventually we may have to add the same functionality to chrome, OR conversely, get to with firefox
 
-
   if (isBrowser('firefox')) {
     const mediaConfig: any = {
       audio: options.sendAudio,
-      video: options.sendShare
+      video: options.sendShare,
     };
 
-
-    return navigator.mediaDevices.getDisplayMedia({audio: options.sendAudio, video: mediaConfig})
+    return navigator.mediaDevices
+      .getDisplayMedia({audio: options.sendAudio, video: mediaConfig})
       .then((stream) => {
         if (options.sendShare && stream.getVideoTracks().length > 0) {
           // Firefox has a bug with the spec where changing in the height and width only happens
@@ -311,7 +292,6 @@ Media.getDisplayMedia = (
           stream.getVideoTracks()[0].applyConstraints(shareConstraints);
         }
 
-
         return stream;
       });
   }
@@ -341,34 +321,32 @@ Media.getMedia = (audio: any | boolean, video: any | boolean, config: any) => {
     audio,
     // TODO: Remove temporary workaround once Firefox fixes low constraint issues
     // eslint-disable-next-line no-nested-ternary
-    video: video ?
-      isBrowser('firefox') && video.width && video.width.max === 320 ?
-        {
-          deviceId: video.deviceId ? video.deviceId : undefined,
-          width: 320,
-          height: 180,
-          frameRate: video.frameRate ? video.frameRate : undefined,
-          facingMode: video.facingMode ? video.facingMode : undefined,
-        } :
-        {
-          deviceId: video.deviceId ? video.deviceId : undefined,
-          width: video.width ? video.width : defaultWidth,
-          height: video.height ? video.height : defaultHeight,
-          frameRate: video.frameRate ? video.frameRate : undefined,
-          facingMode: video.facingMode ? video.facingMode : undefined,
-        } :
-      false,
-    fake: process.env.NODE_ENV === 'test' // Special case to get fake media for Firefox browser for testing
+    video: video
+      ? isBrowser('firefox') && video.width && video.width.max === 320
+        ? {
+            deviceId: video.deviceId ? video.deviceId : undefined,
+            width: 320,
+            height: 180,
+            frameRate: video.frameRate ? video.frameRate : undefined,
+            facingMode: video.facingMode ? video.facingMode : undefined,
+          }
+        : {
+            deviceId: video.deviceId ? video.deviceId : undefined,
+            width: video.width ? video.width : defaultWidth,
+            height: video.height ? video.height : defaultHeight,
+            frameRate: video.frameRate ? video.frameRate : undefined,
+            facingMode: video.facingMode ? video.facingMode : undefined,
+          }
+      : false,
+    fake: process.env.NODE_ENV === 'test', // Special case to get fake media for Firefox browser for testing
   };
 
-  return navigator.mediaDevices
-    .getUserMedia(mediaConfig)
-    .catch((err) => {
-      const logPath = 'Media:index#getMedia --> navigator.mediaDevices.getUserMedia';
+  return navigator.mediaDevices.getUserMedia(mediaConfig).catch((err) => {
+    const logPath = 'Media:index#getMedia --> navigator.mediaDevices.getUserMedia';
 
-      LoggerProxy.logger.error(`${logPath} failed - ${err} (${err.constraint})`);
-      throw err;
-    });
+    LoggerProxy.logger.error(`${logPath} failed - ${err} (${err.constraint})`);
+    throw err;
+  });
 };
 
 /**
@@ -383,24 +361,24 @@ Media.getMedia = (audio: any | boolean, video: any | boolean, config: any) => {
  *    sendVideo: true/false
  *}
  */
-Media.getSupportedDevice = ({ sendAudio, sendVideo }: { sendAudio: boolean; sendVideo: boolean }) =>
+Media.getSupportedDevice = ({sendAudio, sendVideo}: {sendAudio: boolean; sendVideo: boolean}) =>
   Promise.resolve().then(() => {
     if (!navigator.mediaDevices || navigator.mediaDevices.enumerateDevices === undefined) {
       return {
         sendAudio: false,
-        sendVideo: false
+        sendVideo: false,
       };
     }
 
     return navigator.mediaDevices.enumerateDevices().then((devices) => {
       const supported = {
         audio: devices.filter((device) => device.kind === AUDIO_INPUT).length > 0,
-        video: devices.filter((device) => device.kind === VIDEO_INPUT).length > 0
+        video: devices.filter((device) => device.kind === VIDEO_INPUT).length > 0,
       };
 
       return {
         sendAudio: supported.audio && sendAudio,
-        sendVideo: supported.video && sendVideo
+        sendVideo: supported.video && sendVideo,
       };
     });
   });
@@ -439,9 +417,10 @@ Media.stopTracks = (track: any) => {
     if (track && track.stop) {
       try {
         track.stop();
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Media:index#stopTracks --> Unable to stop the track with state ${track.readyState}, error: ${e}`);
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `Media:index#stopTracks --> Unable to stop the track with state ${track.readyState}, error: ${e}`
+        );
       }
     }
   });
@@ -455,7 +434,9 @@ Media.stopTracks = (track: any) => {
  * @deprecated after v1.89.3
  */
 Media.stopStream = (stream: any) => {
-  LoggerProxy.logger.warn('Media:index#stopStream --> [DEPRECATION WARNING]: stopStream has been deprecated after v1.89.3');
+  LoggerProxy.logger.warn(
+    'Media:index#stopStream --> [DEPRECATION WARNING]: stopStream has been deprecated after v1.89.3'
+  );
   if (!stream) {
     return Promise.resolve();
   }
@@ -470,8 +451,7 @@ Media.stopStream = (stream: any) => {
       stream.getTracks().forEach((track) => {
         track.stop();
       });
-    }
-    else if (stream.stop) {
+    } else if (stream.stop) {
       stream.stop();
     }
   });
@@ -510,13 +490,21 @@ Media.getUserMedia = (
   },
   config: object
 ) =>
-Media.getLocalMedia({
-  sendAudio: mediaSetting.sendAudio ? audioVideo.audio || mediaSetting.sendAudio : false,
-  sendVideo: mediaSetting.sendVideo ? audioVideo.video || mediaSetting.sendVideo : false
-}, config).then((localStream) => Media.getLocalMedia({
-  sendShare: mediaSetting.sendShare,
-  isSharing: mediaSetting.isSharing,
-  sharePreferences
-}, config).then((shareStream) => [localStream, shareStream]));
+  Media.getLocalMedia(
+    {
+      sendAudio: mediaSetting.sendAudio ? audioVideo.audio || mediaSetting.sendAudio : false,
+      sendVideo: mediaSetting.sendVideo ? audioVideo.video || mediaSetting.sendVideo : false,
+    },
+    config
+  ).then((localStream) =>
+    Media.getLocalMedia(
+      {
+        sendShare: mediaSetting.sendShare,
+        isSharing: mediaSetting.isSharing,
+        sharePreferences,
+      },
+      config
+    ).then((shareStream) => [localStream, shareStream])
+  );
 
 export default Media;

package/src/media/internal-media-core-wrapper.ts

@@ -5,5 +5,5 @@ import {MediaConnection as MC} from '@webex/internal-media-core';
  * because they are exported by @webex/internal-media-core as non-writable, non-configurable
  * properties of MediaConnection and sinon doesn't allow spying on them or stubbing them.
  */
-export const RoapMediaConnection = MC.RoapMediaConnection;
-export const MultistreamRoapMediaConnection = MC.MultistreamRoapMediaConnection;
+export const {RoapMediaConnection} = MC;
+export const {MultistreamRoapMediaConnection} = MC;

package/src/media/properties.ts

@@ -1,10 +1,6 @@
 import {MediaConnection as MC} from '@webex/internal-media-core';
 
-import {
-  MEETINGS,
-  PC_BAIL_TIMEOUT,
-  QUALITY_LEVELS
-} from '../constants';
+import {MEETINGS, PC_BAIL_TIMEOUT, QUALITY_LEVELS} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 
 /**
@@ -137,7 +133,9 @@ export default class MediaProperties {
    * @returns {void}
    */
   unsetRemoteStream() {
-    LoggerProxy.logger.warn('Media:properties#unsetRemoteStream --> [DEPRECATION WARNING]: unsetRemoteStream has been deprecated after v1.89.3 (use unsetRemoteTracks instead)');
+    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();
   }
@@ -166,7 +164,9 @@ export default class MediaProperties {
    * @returns {void}
    */
   unsetRemoteStreams() {
-    LoggerProxy.logger.warn('Media:properties#unsetRemoteStreams --> [DEPRECATION WARNING]: unsetRemoteStreams has been deprecated after v1.89.3 (use unsetRemoteTracks instead)');
+    LoggerProxy.logger.warn(
+      'Media:properties#unsetRemoteStreams --> [DEPRECATION WARNING]: unsetRemoteStreams has been deprecated after v1.89.3 (use unsetRemoteTracks instead)'
+    );
     this.unsetRemoteStream();
     this.unsetRemoteShare();
   }
@@ -191,7 +191,9 @@ export default class MediaProperties {
    * @returns {void}
    */
   unsetMediaStreams() {
-    LoggerProxy.logger.warn('Media:properties#unsetMediaStreams --> [DEPRECATION WARNING]: unsetMediaStreams has been deprecated after v1.89.3 (use unsetMediaTracks instead)');
+    LoggerProxy.logger.warn(
+      'Media:properties#unsetMediaStreams --> [DEPRECATION WARNING]: unsetMediaStreams has been deprecated after v1.89.3 (use unsetMediaTracks instead)'
+    );
     this.unsetLocalVideoTrack();
     this.unsetRemoteStream();
   }
@@ -211,9 +213,8 @@ export default class MediaProperties {
    * @returns {Promise<void>}
    */
   waitForMediaConnectionConnected() {
-    const isConnected = () => (
-      this.webrtcMediaConnection.getConnectionState() === MC.ConnectionState.Connected
-    );
+    const isConnected = () =>
+      this.webrtcMediaConnection.getConnectionState() === MC.ConnectionState.Connected;
 
     if (isConnected()) {
       return Promise.resolve();
@@ -223,11 +224,16 @@ export default class MediaProperties {
       let timer;
 
       const connectionStateListener = () => {
-        LoggerProxy.logger.log(`Media:properties#waitForMediaConnectionConnected --> connection state: ${this.webrtcMediaConnection.getConnectionState()}`);
+        LoggerProxy.logger.log(
+          `Media:properties#waitForMediaConnectionConnected --> connection state: ${this.webrtcMediaConnection.getConnectionState()}`
+        );
 
         if (isConnected()) {
           clearTimeout(timer);
-          this.webrtcMediaConnection.off(MC.Event.CONNECTION_STATE_CHANGED, connectionStateListener);
+          this.webrtcMediaConnection.off(
+            MC.Event.CONNECTION_STATE_CHANGED,
+            connectionStateListener
+          );
           resolve();
         }
       };
@@ -257,9 +263,10 @@ export default class MediaProperties {
       const statsResult = await this.webrtcMediaConnection.getStats();
 
       statsResult.forEach((report) => allStatsReports.push(report));
-    }
-    catch (error) {
-      LoggerProxy.logger.warn(`Media:properties#getCurrentConnectionType --> getStats() failed: ${error}`);
+    } catch (error) {
+      LoggerProxy.logger.warn(
+        `Media:properties#getCurrentConnectionType --> getStats() failed: ${error}`
+      );
     }
 
     const successfulCandidatePairs = allStatsReports.filter(
@@ -270,10 +277,14 @@ export default class MediaProperties {
 
     // 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);
+      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`);
+        LoggerProxy.logger.warn(
+          `Media:properties#getCurrentConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`
+        );
 
         return false;
       }
@@ -282,8 +293,7 @@ export default class MediaProperties {
 
       if (localCandidate.relayProtocol) {
         connectionType = `TURN-${localCandidate.relayProtocol.toUpperCase()}`;
-      }
-      else {
+      } else {
         connectionType = localCandidate.protocol?.toUpperCase(); // it will be UDP or TCP
       }
 

package/src/media/util.ts

@@ -6,7 +6,7 @@ const MediaUtil: any = {};
 
 MediaUtil.createMediaStream = (tracks) => {
   if (!tracks) {
-    LoggerProxy.logger.error('Media:util#createMediaStream --> Tracks don\'t exist');
+    LoggerProxy.logger.error("Media:util#createMediaStream --> Tracks don't exist");
   }
   const filtredTracks = tracks.filter((element) => !!element);