@webex/plugin-meetings 2.60.0-next.9 → 2.60.1

package/src/meeting/effectsState.ts

@@ -0,0 +1,209 @@
+/* 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: any) => {
+  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 {
+  effectType: any;
+  pendingPromiseReject: any;
+  pendingPromiseResolve: any;
+  state: any;
+
+  constructor(type: any) {
+    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?: boolean, meeting?: object) {
+    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(true);
+      }
+      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
+   */
+  public 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
+   */
+  public async enableBNR(meeting: any) {
+    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,
+      });
+
+      return this.rejectPromise(error);
+    }
+
+    return this.resolvePromise();
+  }
+
+  /**
+   * disableBNR API
+   * @param {Object} meeting the meeting object
+   * @returns {Promise<Boolean>}
+   * @public
+   * @memberof EffectsState
+   */
+  public async disableBNR(meeting: any) {
+    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;
+
+      // @ts-ignore - disableBNR does not expect an argument
+      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,
+      });
+
+      return this.rejectPromise(error);
+    }
+
+    return this.resolvePromise();
+  }
+}
+
+export default createEffectsState;

package/src/meeting/in-meeting-actions.ts

@@ -17,11 +17,7 @@ interface IInMeetingActions {
   canUnsetMuteOnEntry?: boolean;
   canSetDisallowUnmute?: boolean;
   canUnsetDisallowUnmute?: boolean;
-  canSetMuted?: boolean;
-  canUnsetMuted?: boolean;
   canAssignHost?: boolean;
-  canSetPresenter?: boolean;
-  canUnsetPresenter?: boolean;
   canStartRecording?: boolean;
   canPauseRecording?: boolean;
   canResumeRecording?: boolean;
@@ -34,51 +30,11 @@ interface IInMeetingActions {
   canStartTranscribing?: boolean;
   canStopTranscribing?: boolean;
   isClosedCaptionActive?: boolean;
-  isSaveTranscriptsEnabled?: boolean;
   isWebexAssistantActive?: boolean;
   canViewCaptionPanel?: boolean;
   isRealTimeTranslationEnabled?: boolean;
   canSelectSpokenLanguages?: boolean;
   waitingForOthersToJoin?: boolean;
-  canSendReactions?: boolean;
-  canManageBreakout?: boolean;
-  canBroadcastMessageToBreakout?: boolean;
-  canAdmitLobbyToBreakout?: boolean;
-  isBreakoutPreassignmentsEnabled?: boolean;
-  canUserAskForHelp?: boolean;
-  canUserRenameSelfAndObserved?: boolean;
-  canUserRenameOthers?: boolean;
-  canMuteAll?: boolean;
-  canUnmuteAll?: boolean;
-  canEnableHardMute?: boolean;
-  canDisableHardMute?: boolean;
-  canEnableMuteOnEntry?: boolean;
-  canDisableMuteOnEntry?: boolean;
-  canEnableReactions?: boolean;
-  canDisableReactions?: boolean;
-  canEnableReactionDisplayNames?: boolean;
-  canDisableReactionDisplayNames?: boolean;
-  canUpdateShareControl?: boolean;
-  canEnableViewTheParticipantsList?: boolean;
-  canDisableViewTheParticipantsList?: boolean;
-  canEnableRaiseHand?: boolean;
-  canDisableRaiseHand?: boolean;
-  canEnableVideo?: boolean;
-  canDisableVideo?: boolean;
-  canShareFile?: boolean;
-  canShareApplication?: boolean;
-  canShareCamera?: boolean;
-  canShareDesktop?: boolean;
-  canShareContent?: boolean;
-  canTransferFile?: boolean;
-  canChat?: boolean;
-  canDoVideo?: boolean;
-  canAnnotate?: boolean;
-  canUseVoip?: boolean;
-  supportHQV?: boolean;
-  supportHDV?: boolean;
-  canShareWhiteBoard?: boolean;
-  enforceVirtualBackground?: boolean;
 }
 
 /**
@@ -107,20 +63,12 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canSetMuteOnEntry = null;
 
-  canSetPresenter = null;
-
-  canUnsetPresenter = null;
-
   canUnsetMuteOnEntry = null;
 
   canSetDisallowUnmute = null;
 
   canUnsetDisallowUnmute = null;
 
-  canSetMuted = null;
-
-  canUnsetMuted = null;
-
   canRaiseHand = null;
 
   canLowerAllHands = null;
@@ -137,8 +85,6 @@ export default class InMeetingActions implements IInMeetingActions {
 
   isClosedCaptionActive = null;
 
-  isSaveTranscriptsEnabled = null;
-
   isWebexAssistantActive = null;
 
   canViewCaptionPanel = null;
@@ -149,84 +95,6 @@ export default class InMeetingActions implements IInMeetingActions {
 
   waitingForOthersToJoin = null;
 
-  canSendReactions = null;
-
-  canManageBreakout = null;
-
-  canBroadcastMessageToBreakout = null;
-
-  canAdmitLobbyToBreakout = null;
-
-  isBreakoutPreassignmentsEnabled = null;
-
-  canUserAskForHelp = null;
-
-  canUserRenameSelfAndObserved = null;
-
-  canUserRenameOthers = null;
-
-  canMuteAll = null;
-
-  canUnmuteAll = null;
-
-  canEnableHardMute = null;
-
-  canDisableHardMute = null;
-
-  canEnableMuteOnEntry = null;
-
-  canDisableMuteOnEntry = null;
-
-  canEnableReactions = null;
-
-  canDisableReactions = null;
-
-  canEnableReactionDisplayNames = null;
-
-  canDisableReactionDisplayNames = null;
-
-  canUpdateShareControl = null;
-
-  canEnableViewTheParticipantsList = null;
-
-  canDisableViewTheParticipantsList = null;
-
-  canEnableRaiseHand = null;
-
-  canDisableRaiseHand = null;
-
-  canEnableVideo = null;
-
-  canDisableVideo = null;
-
-  canShareFile = null;
-
-  canShareApplication = null;
-
-  canShareCamera = null;
-
-  canShareDesktop = null;
-
-  canShareContent = null;
-
-  canTransferFile = null;
-
-  canChat = null;
-
-  canDoVideo = null;
-
-  canAnnotate = null;
-
-  canUseVoip = null;
-
-  supportHQV = null;
-
-  enforceVirtualBackground = null;
-
-  supportHDV = null;
-
-  canShareWhiteBoard = null;
-
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -240,10 +108,6 @@ export default class InMeetingActions implements IInMeetingActions {
     canSetMuteOnEntry: this.canSetMuteOnEntry,
     canUnsetMuteOnEntry: this.canUnsetMuteOnEntry,
     canSetDisallowUnmute: this.canSetDisallowUnmute,
-    canSetMuted: this.canSetMuted,
-    canUnsetMuted: this.canUnsetMuted,
-    canSetPresenter: this.canSetPresenter,
-    canUnsetPresenter: this.canUnsetPresenter,
     canUnsetDisallowUnmute: this.canUnsetDisallowUnmute,
     canStartRecording: this.canStartRecording,
     canPauseRecording: this.canPauseRecording,
@@ -257,51 +121,11 @@ export default class InMeetingActions implements IInMeetingActions {
     canStartTranscribing: this.canStartTranscribing,
     canStopTranscribing: this.canStopTranscribing,
     isClosedCaptionActive: this.isClosedCaptionActive,
-    isSaveTranscriptsEnabled: this.isSaveTranscriptsEnabled,
     isWebexAssistantActive: this.isWebexAssistantActive,
     canViewCaptionPanel: this.canViewCaptionPanel,
     isRealTimeTranslationEnabled: this.isRealTimeTranslationEnabled,
     canSelectSpokenLanguages: this.canSelectSpokenLanguages,
     waitingForOthersToJoin: this.waitingForOthersToJoin,
-    canSendReactions: this.canSendReactions,
-    canManageBreakout: this.canManageBreakout,
-    canBroadcastMessageToBreakout: this.canBroadcastMessageToBreakout,
-    canAdmitLobbyToBreakout: this.canAdmitLobbyToBreakout,
-    isBreakoutPreassignmentsEnabled: this.isBreakoutPreassignmentsEnabled,
-    canUserAskForHelp: this.canUserAskForHelp,
-    canUserRenameSelfAndObserved: this.canUserRenameSelfAndObserved,
-    canUserRenameOthers: this.canUserRenameOthers,
-    canMuteAll: this.canMuteAll,
-    canUnmuteAll: this.canUnmuteAll,
-    canEnableHardMute: this.canEnableHardMute,
-    canDisableHardMute: this.canDisableHardMute,
-    canEnableMuteOnEntry: this.canEnableMuteOnEntry,
-    canDisableMuteOnEntry: this.canDisableMuteOnEntry,
-    canEnableReactions: this.canEnableReactions,
-    canDisableReactions: this.canDisableReactions,
-    canEnableReactionDisplayNames: this.canEnableReactionDisplayNames,
-    canDisableReactionDisplayNames: this.canDisableReactionDisplayNames,
-    canUpdateShareControl: this.canUpdateShareControl,
-    canEnableViewTheParticipantsList: this.canEnableViewTheParticipantsList,
-    canDisableViewTheParticipantsList: this.canDisableViewTheParticipantsList,
-    canEnableRaiseHand: this.canEnableRaiseHand,
-    canDisableRaiseHand: this.canDisableRaiseHand,
-    canEnableVideo: this.canEnableVideo,
-    canDisableVideo: this.canDisableVideo,
-    canShareFile: this.canShareFile,
-    canShareApplication: this.canShareApplication,
-    canShareCamera: this.canShareCamera,
-    canShareDesktop: this.canShareDesktop,
-    canShareContent: this.canShareContent,
-    canTransferFile: this.canTransferFile,
-    canChat: this.canChat,
-    canDoVideo: this.canDoVideo,
-    canAnnotate: this.canAnnotate,
-    canUseVoip: this.canUseVoip,
-    enforceVirtualBackground: this.enforceVirtualBackground,
-    supportHQV: this.supportHQV,
-    supportHDV: this.supportHDV,
-    canShareWhiteBoard: this.canShareWhiteBoard,
   });
 
   /**