@webex/plugin-meetings 3.0.0-beta.11 → 3.0.0-beta.111

package/dist/meeting/muteState.js

@@ -1,122 +1,177 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
-exports.default = void 0;
-
+exports.createMuteState = void 0;
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-
 var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
-
 var _parameter = _interopRequireDefault(require("../common/errors/parameter"));
-
 var _permission = _interopRequireDefault(require("../common/errors/permission"));
-
-var _media = _interopRequireDefault(require("../media"));
-
-var _util = _interopRequireDefault(require("../meeting/util"));
-
+var _util = _interopRequireDefault(require("./util"));
 var _constants = require("../constants");
-
 /* Certain aspects of server interaction for video muting are not implemented as we currently don't support remote muting of video.
    If we ever need to support it, search for REMOTE_MUTE_VIDEO_MISSING_IMPLEMENTATION string to find the places that need updating
 */
-var createMuteState = function createMuteState(type, meeting, mediaDirection) {
+
+// eslint-disable-next-line import/prefer-default-export
+var createMuteState = function createMuteState(type, meeting, mediaDirection, sdkOwnsLocalTrack) {
+  // todo: remove mediaDirection argument (SPARK-399695)
+  // todo: remove the meeting argument  (SPARK-399695)
   if (type === _constants.AUDIO && !mediaDirection.sendAudio) {
     return null;
   }
-
   if (type === _constants.VIDEO && !mediaDirection.sendVideo) {
     return null;
   }
-
   _loggerProxy.default.logger.info("Meeting:muteState#createMuteState --> ".concat(type, ": creating MuteState for meeting id ").concat(meeting === null || meeting === void 0 ? void 0 : meeting.id));
-
-  return new MuteState(type, meeting);
+  var muteState = new MuteState(type, meeting, sdkOwnsLocalTrack);
+  muteState.init(meeting);
+  return muteState;
 };
+
 /** The purpose of this class is to manage the local and remote mute state and make sure that the server state always matches
    the last requested state by the client.
 
    More info about Locus muting API: https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html#
 */
-
-
+exports.createMuteState = createMuteState;
 var MuteState = /*#__PURE__*/function () {
+  // todo: remove this when doing SPARK-399695
+
   /**
    * Constructor
    *
    * @param {String} type - audio or video
    * @param {Object} meeting - the meeting object (used for reading current remote mute status)
+   * @param {boolean} sdkOwnsLocalTrack - if false, then client app owns the local track (for now that's the case only for multistream meetings)
    */
-  function MuteState(type, meeting) {
+  function MuteState(type, meeting, sdkOwnsLocalTrack) {
+    var _meeting$remoteVideoM, _meeting$unmuteVideoA;
     (0, _classCallCheck2.default)(this, MuteState);
     (0, _defineProperty2.default)(this, "pendingPromiseReject", void 0);
     (0, _defineProperty2.default)(this, "pendingPromiseResolve", void 0);
     (0, _defineProperty2.default)(this, "state", void 0);
     (0, _defineProperty2.default)(this, "type", void 0);
-
+    (0, _defineProperty2.default)(this, "sdkOwnsLocalTrack", void 0);
+    (0, _defineProperty2.default)(this, "ignoreMuteStateChange", void 0);
     if (type !== _constants.AUDIO && type !== _constants.VIDEO) {
       throw new _parameter.default('Mute state is designed for handling audio or video only');
     }
-
     this.type = type;
+    this.sdkOwnsLocalTrack = sdkOwnsLocalTrack;
+    this.ignoreMuteStateChange = false;
     this.state = {
       client: {
         localMute: false
       },
       server: {
         localMute: false,
-        // initial values available only for audio (REMOTE_MUTE_VIDEO_MISSING_IMPLEMENTATION)
-        remoteMute: type === _constants.AUDIO ? meeting.remoteMuted : false,
-        unmuteAllowed: type === _constants.AUDIO ? meeting.unmuteAllowed : true
+        // because remoteVideoMuted and unmuteVideoAllowed are updated seperately, they might be undefined
+        remoteMute: type === _constants.AUDIO ? meeting.remoteMuted : (_meeting$remoteVideoM = meeting.remoteVideoMuted) !== null && _meeting$remoteVideoM !== void 0 ? _meeting$remoteVideoM : false,
+        unmuteAllowed: type === _constants.AUDIO ? meeting.unmuteAllowed : (_meeting$unmuteVideoA = meeting.unmuteVideoAllowed) !== null && _meeting$unmuteVideoA !== void 0 ? _meeting$unmuteVideoA : true
       },
       syncToServerInProgress: false
-    }; // these 2 hold the resolve, reject methods for the promise we returned to the client in last handleClientRequest() call
-
+    };
+    // 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;
   }
+
   /**
-   * Handles mute/unmute request from the client/user. Returns a promise that's resolved once the server update is completed or
-   * at the point that this request becomese superseded by another client request.
-   *
-   * The client doesn't have to wait for the returned promise to resolve before calling handleClientRequest() again. If
-   * handleClientRequest() is called again before the previous one resolved, the MuteState class will make sure that eventually
-   * the server state will match the last requested state from the client.
+   * Starts the mute state machine. Needs to be called after a new MuteState instance is created.
    *
-   * @public
-   * @memberof MuteState
-   * @param {Object} [meeting] the meeting object
-   * @param {Boolean} [mute] true for muting, false for unmuting request
-   * @returns {Promise}
+   * @param {Object} meeting - the meeting object
+   * @returns {void}
    */
+  (0, _createClass2.default)(MuteState, [{
+    key: "init",
+    value: function init(meeting) {
+      if (!this.sdkOwnsLocalTrack) {
+        var _meeting$mediaPropert, _meeting$mediaPropert2;
+        this.applyUnmuteAllowedToTrack(meeting);
+
+        // if we are remotely muted, we need to apply that to the local track now (mute on-entry)
+        if (this.state.server.remoteMute) {
+          this.muteLocalTrack(meeting, this.state.server.remoteMute, 'remotelyMuted');
+        }
+        var initialMute = this.type === _constants.AUDIO ? (_meeting$mediaPropert = meeting.mediaProperties.audioTrack) === null || _meeting$mediaPropert === void 0 ? void 0 : _meeting$mediaPropert.muted : (_meeting$mediaPropert2 = meeting.mediaProperties.videoTrack) === null || _meeting$mediaPropert2 === void 0 ? void 0 : _meeting$mediaPropert2.muted;
+        _loggerProxy.default.logger.info("Meeting:muteState#start --> ".concat(this.type, ": local track initial mute state: ").concat(initialMute));
+        if (initialMute !== undefined) {
+          this.state.client.localMute = initialMute;
+          this.applyClientStateToServer(meeting);
+        }
+      }
+    }
 
+    /**
+     * This method needs to be called whenever the local audio/video track has changed.
+     * It reapplies the remote mute state onto the new track and also reads the current
+     * local mute state from the track and updates the internal state machine and sends
+     * any required requests to the server.
+     *
+     * @param {Object} meeting - the meeting object
+     * @returns {void}
+     */
+  }, {
+    key: "handleLocalTrackChange",
+    value: function handleLocalTrackChange(meeting) {
+      return this.init(meeting);
+    }
 
-  (0, _createClass2.default)(MuteState, [{
+    /**
+     * Mutes/unmutes local track
+     *
+     * @param {Object} meeting - the meeting object
+     * @param {Boolean} mute - true to mute the track, false to unmute it
+     * @param {ServerMuteReason} reason - reason for muting/unmuting
+     * @returns {void}
+     */
+  }, {
+    key: "muteLocalTrack",
+    value: function muteLocalTrack(meeting, mute, reason) {
+      this.ignoreMuteStateChange = true;
+      if (this.type === _constants.AUDIO) {
+        var _meeting$mediaPropert3;
+        (_meeting$mediaPropert3 = meeting.mediaProperties.audioTrack) === null || _meeting$mediaPropert3 === void 0 ? void 0 : _meeting$mediaPropert3.setServerMuted(mute, reason);
+      } else {
+        var _meeting$mediaPropert4;
+        (_meeting$mediaPropert4 = meeting.mediaProperties.videoTrack) === null || _meeting$mediaPropert4 === void 0 ? void 0 : _meeting$mediaPropert4.setServerMuted(mute, reason);
+      }
+      this.ignoreMuteStateChange = false;
+    }
+
+    /**
+     * Handles mute/unmute request from the client/user. Returns a promise that's resolved once the server update is completed or
+     * at the point that this request becomese superseded by another client request.
+     *
+     * The client doesn't have to wait for the returned promise to resolve before calling handleClientRequest() again. If
+     * handleClientRequest() is called again before the previous one resolved, the MuteState class will make sure that eventually
+     * the server state will match the last requested state from the client.
+     *
+     * @public
+     * @memberof MuteState
+     * @param {Object} [meeting] the meeting object
+     * @param {Boolean} [mute] true for muting, false for unmuting request
+     * @returns {Promise}
+     */
+  }, {
     key: "handleClientRequest",
     value: function handleClientRequest(meeting, mute) {
       var _this = this;
-
+      // todo: this whole method will be removed in SPARK-399695
       _loggerProxy.default.logger.info("Meeting:muteState#handleClientRequest --> ".concat(this.type, ": user requesting new mute state: ").concat(mute));
-
       if (!mute && !this.state.server.unmuteAllowed) {
         return _promise.default.reject(new _permission.default('User is not allowed to unmute self (hard mute feature is being used)'));
-      } // we don't check if we're already in the same state, because even if we were, we would still have to apply the mute state locally,
-      // because the client may have changed the audio/vidoe tracks
-
+      }
 
+      // we don't check if we're already in the same state, because even if we were, we would still have to apply the mute state locally,
+      // because the client may have changed the audio/video tracks
       this.state.client.localMute = mute;
       this.applyClientStateLocally(meeting);
       return new _promise.default(function (resolve, reject) {
@@ -124,27 +179,59 @@ var MuteState = /*#__PURE__*/function () {
           // 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;
-
         _this.applyClientStateToServer(meeting);
       });
     }
+
+    /**
+     * This method should be called when the local track mute state is changed
+     * @public
+     * @memberof MuteState
+     * @param {Object} [meeting] the meeting object
+     * @param {Boolean} [mute] true for muting, false for unmuting request
+     * @returns {void}
+     */
+  }, {
+    key: "handleLocalTrackMuteStateChange",
+    value: function handleLocalTrackMuteStateChange(meeting, mute) {
+      if (this.ignoreMuteStateChange) {
+        return;
+      }
+      _loggerProxy.default.logger.info("Meeting:muteState#handleLocalTrackMuteStateChange --> ".concat(this.type, ": local track new mute state: ").concat(mute));
+      if (this.pendingPromiseReject) {
+        _loggerProxy.default.logger.error("Meeting:muteState#handleLocalTrackMuteStateChange --> ".concat(this.type, ": Local track mute state change handler called while a client request is handled - this should never happen!, mute state: ").concat(mute));
+      }
+      this.state.client.localMute = mute;
+      this.applyClientStateToServer(meeting);
+    }
+
     /**
      * Applies the current mute state to the local track (by enabling or disabling it accordingly)
      *
      * @public
      * @param {Object} [meeting] the meeting object
+     * @param {ServerMuteReason} reason - reason why we're applying our client state to the local track
      * @memberof MuteState
      * @returns {void}
      */
-
   }, {
     key: "applyClientStateLocally",
-    value: function applyClientStateLocally(meeting) {
-      _media.default.setLocalTrack(!this.state.client.localMute, this.type === _constants.AUDIO ? meeting.mediaProperties.audioTrack : meeting.mediaProperties.videoTrack);
+    value: function applyClientStateLocally(meeting, reason) {
+      if (this.sdkOwnsLocalTrack) {
+        if (this.type === _constants.AUDIO) {
+          var _meeting$mediaPropert5;
+          (_meeting$mediaPropert5 = meeting.mediaProperties.audioTrack) === null || _meeting$mediaPropert5 === void 0 ? void 0 : _meeting$mediaPropert5.setMuted(this.state.client.localMute);
+        } else {
+          var _meeting$mediaPropert6;
+          (_meeting$mediaPropert6 = meeting.mediaProperties.videoTrack) === null || _meeting$mediaPropert6 === void 0 ? void 0 : _meeting$mediaPropert6.setMuted(this.state.client.localMute);
+        }
+      } else {
+        this.muteLocalTrack(meeting, this.state.client.localMute, reason);
+      }
     }
+
     /**
      * Updates the server local and remote mute values so that they match the current client desired state.
      *
@@ -153,62 +240,53 @@ var MuteState = /*#__PURE__*/function () {
      * @memberof MuteState
      * @returns {void}
      */
-
   }, {
     key: "applyClientStateToServer",
     value: function applyClientStateToServer(meeting) {
       var _this2 = this;
-
       if (this.state.syncToServerInProgress) {
         _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(this.type, ": request to server in progress, we need to wait for it to complete"));
-
         return;
       }
-
       var localMuteRequiresSync = this.state.client.localMute !== this.state.server.localMute;
       var remoteMuteRequiresSync = !this.state.client.localMute && this.state.server.remoteMute;
-
       _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(this.type, ": localMuteRequiresSync: ").concat(localMuteRequiresSync, " (").concat(this.state.client.localMute, " ?= ").concat(this.state.server.localMute, ")"));
-
       _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(this.type, ": remoteMuteRequiresSync: ").concat(remoteMuteRequiresSync));
-
       if (!localMuteRequiresSync && !remoteMuteRequiresSync) {
         _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(this.type, ": client state already matching server state, nothing to do"));
-
         if (this.pendingPromiseResolve) {
           this.pendingPromiseResolve();
         }
-
         this.pendingPromiseResolve = null;
         this.pendingPromiseReject = null;
         return;
       }
+      this.state.syncToServerInProgress = true;
 
-      this.state.syncToServerInProgress = true; // first sync local mute with server
-
+      // first sync local mute with server
       var localMuteSyncPromise = localMuteRequiresSync ? this.sendLocalMuteRequestToServer(meeting) : _promise.default.resolve();
       localMuteSyncPromise.then(function () {
-        return (// then follow it up with remote mute sync
+        return (
+          // then follow it up with remote mute sync
           remoteMuteRequiresSync ? _this2.sendRemoteMuteRequestToServer(meeting) : _promise.default.resolve()
         );
       }).then(function () {
         _this2.state.syncToServerInProgress = false;
+        _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(_this2.type, ": sync with server completed"));
 
-        _loggerProxy.default.logger.info("Meeting:muteState#applyClientStateToServer --> ".concat(_this2.type, ": sync with server completed")); // need to check if a new sync is required, because this.state.client may have changed while we were doing the current sync
-
-
+        // need to check if a new sync is required, because this.state.client may have changed while we were doing the current sync
         _this2.applyClientStateToServer(meeting);
       }).catch(function (e) {
         _this2.state.syncToServerInProgress = false;
-
         if (_this2.pendingPromiseReject) {
           _this2.pendingPromiseReject(e);
         }
-
         _this2.pendingPromiseResolve = null;
         _this2.pendingPromiseReject = null;
+        _this2.applyServerMuteToLocalTrack(meeting, 'clientRequestFailed');
       });
     }
+
     /**
      * Sets the local mute value in the server
      *
@@ -217,31 +295,26 @@ var MuteState = /*#__PURE__*/function () {
      * @memberof MuteState
      * @returns {Promise}
      */
-
   }, {
     key: "sendLocalMuteRequestToServer",
     value: function sendLocalMuteRequestToServer(meeting) {
       var _meeting$audio,
-          _meeting$video,
-          _this3 = this;
-
+        _meeting$video,
+        _this3 = this;
       var audioMuted = this.type === _constants.AUDIO ? this.state.client.localMute : (_meeting$audio = meeting.audio) === null || _meeting$audio === void 0 ? void 0 : _meeting$audio.state.client.localMute;
       var videoMuted = this.type === _constants.VIDEO ? this.state.client.localMute : (_meeting$video = meeting.video) === null || _meeting$video === void 0 ? void 0 : _meeting$video.state.client.localMute;
-
       _loggerProxy.default.logger.info("Meeting:muteState#sendLocalMuteRequestToServer --> ".concat(this.type, ": sending local mute (audio=").concat(audioMuted, ", video=").concat(videoMuted, ") to server"));
-
       return _util.default.remoteUpdateAudioVideo(audioMuted, videoMuted, meeting).then(function (locus) {
         _loggerProxy.default.logger.info("Meeting:muteState#sendLocalMuteRequestToServer --> ".concat(_this3.type, ": local mute (audio=").concat(audioMuted, ", video=").concat(videoMuted, ") applied to server"));
-
         _this3.state.server.localMute = _this3.type === _constants.AUDIO ? audioMuted : videoMuted;
         meeting.locusInfo.onFullLocus(locus);
         return locus;
       }).catch(function (remoteUpdateError) {
         _loggerProxy.default.logger.warn("Meeting:muteState#sendLocalMuteRequestToServer --> ".concat(_this3.type, ": failed to apply local mute (audio=").concat(audioMuted, ", video=").concat(videoMuted, ") to server: ").concat(remoteUpdateError));
-
         return _promise.default.reject(remoteUpdateError);
       });
     }
+
     /**
      * Sets the remote mute value in the server
      *
@@ -250,50 +323,80 @@ var MuteState = /*#__PURE__*/function () {
      * @memberof MuteState
      * @returns {Promise}
      */
-
   }, {
     key: "sendRemoteMuteRequestToServer",
     value: function sendRemoteMuteRequestToServer(meeting) {
       var _this4 = this;
+      var remoteMute = this.state.client.localMute;
+      _loggerProxy.default.logger.info("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(this.type, ": sending remote mute:").concat(remoteMute, " to server"));
+      return meeting.members.muteMember(meeting.members.selfId, remoteMute, this.type === _constants.AUDIO).then(function () {
+        _loggerProxy.default.logger.info("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(_this4.type, ": remote mute:").concat(remoteMute, " applied to server"));
+        _this4.state.server.remoteMute = remoteMute;
+      }).catch(function (remoteUpdateError) {
+        _loggerProxy.default.logger.warn("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(_this4.type, ": failed to apply remote mute ").concat(remoteMute, " to server: ").concat(remoteUpdateError));
+        return _promise.default.reject(remoteUpdateError);
+      });
+    }
 
-      if (this.type === _constants.AUDIO) {
-        var remoteMute = this.state.client.localMute;
-
-        _loggerProxy.default.logger.info("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(this.type, ": sending remote mute:").concat(remoteMute, " to server"));
-
-        return meeting.members.muteMember(meeting.members.selfId, remoteMute).then(function () {
-          _loggerProxy.default.logger.info("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(_this4.type, ": remote mute:").concat(remoteMute, " applied to server"));
-
-          _this4.state.server.remoteMute = remoteMute;
-        }).catch(function (remoteUpdateError) {
-          _loggerProxy.default.logger.warn("Meeting:muteState#sendRemoteMuteRequestToServer --> ".concat(_this4.type, ": failed to apply remote mute ").concat(remoteMute, " to server: ").concat(remoteUpdateError));
-
-          return _promise.default.reject(remoteUpdateError);
-        });
-      } // for now we don't need to support remote muting of video (REMOTE_MUTE_VIDEO_MISSING_IMPLEMENTATION)
+    /** Sets the mute state of the local track according to what server thinks is our state
+     * @param {Object} meeting - the meeting object
+     * @param {ServerMuteReason} serverMuteReason - reason why we're applying server mute to the local track
+     * @returns {void}
+     */
+  }, {
+    key: "applyServerMuteToLocalTrack",
+    value: function applyServerMuteToLocalTrack(meeting, serverMuteReason) {
+      if (!this.sdkOwnsLocalTrack) {
+        var muted = this.state.server.localMute || this.state.server.remoteMute;
 
+        // update the local track mute state, but not this.state.client.localMute
+        this.muteLocalTrack(meeting, muted, serverMuteReason);
+      }
+    }
 
-      this.state.server.remoteMute = this.state.client.localMute;
-      return _promise.default.resolve();
+    /** Applies the current value for unmute allowed to the underlying track
+     *
+     * @param {Meeting} meeting
+     * @returns {void}
+     */
+  }, {
+    key: "applyUnmuteAllowedToTrack",
+    value: function applyUnmuteAllowedToTrack(meeting) {
+      if (!this.sdkOwnsLocalTrack) {
+        if (this.type === _constants.AUDIO) {
+          var _meeting$mediaPropert7;
+          (_meeting$mediaPropert7 = meeting.mediaProperties.audioTrack) === null || _meeting$mediaPropert7 === void 0 ? void 0 : _meeting$mediaPropert7.setUnmuteAllowed(this.state.server.unmuteAllowed);
+        } else {
+          var _meeting$mediaPropert8;
+          (_meeting$mediaPropert8 = meeting.mediaProperties.videoTrack) === null || _meeting$mediaPropert8 === void 0 ? void 0 : _meeting$mediaPropert8.setUnmuteAllowed(this.state.server.unmuteAllowed);
+        }
+      }
     }
+
     /**
      * This method should be called whenever the server remote mute state is changed
      *
      * @public
      * @memberof MuteState
+     * @param {Meeting} meeting
      * @param {Boolean} [muted] true if user is remotely muted, false otherwise
      * @param {Boolean} [unmuteAllowed] indicates if user is allowed to unmute self (false when "hard mute" feature is used)
      * @returns {undefined}
      */
-
   }, {
     key: "handleServerRemoteMuteUpdate",
-    value: function handleServerRemoteMuteUpdate(muted, unmuteAllowed) {
+    value: function handleServerRemoteMuteUpdate(meeting, muted, unmuteAllowed) {
       _loggerProxy.default.logger.info("Meeting:muteState#handleServerRemoteMuteUpdate --> ".concat(this.type, ": updating server remoteMute to (").concat(muted, ")"));
-
-      this.state.server.remoteMute = muted;
-      this.state.server.unmuteAllowed = unmuteAllowed;
+      if (unmuteAllowed !== undefined) {
+        this.state.server.unmuteAllowed = unmuteAllowed;
+        this.applyUnmuteAllowedToTrack(meeting);
+      }
+      if (muted !== undefined) {
+        this.state.server.remoteMute = muted;
+        this.applyServerMuteToLocalTrack(meeting, 'remotelyMuted');
+      }
     }
+
     /**
      * This method should be called whenever we receive from the server a requirement to locally unmute
      *
@@ -302,24 +405,23 @@ var MuteState = /*#__PURE__*/function () {
      * @param {Object} [meeting] the meeting object
      * @returns {undefined}
      */
-
   }, {
     key: "handleServerLocalUnmuteRequired",
     value: function handleServerLocalUnmuteRequired(meeting) {
       _loggerProxy.default.logger.info("Meeting:muteState#handleServerLocalUnmuteRequired --> ".concat(this.type, ": localAudioUnmuteRequired received -> doing local unmute"));
 
+      // todo: I'm seeing "you can now unmute yourself " popup  when this happens - but same thing happens on web.w.c so we can ignore for now
       this.state.server.remoteMute = false;
       this.state.client.localMute = false;
-
       if (this.pendingPromiseReject) {
         this.pendingPromiseReject(new Error('Server requested local unmute - this overrides any client request in progress'));
         this.pendingPromiseResolve = null;
         this.pendingPromiseReject = null;
       }
-
-      this.applyClientStateLocally(meeting);
+      this.applyClientStateLocally(meeting, 'localUnmuteRequired');
       this.applyClientStateToServer(meeting);
     }
+
     /**
      * Returns true if the user is locally or remotely muted
      *
@@ -327,32 +429,72 @@ var MuteState = /*#__PURE__*/function () {
      * @memberof MuteState
      * @returns {Boolean}
      */
-
   }, {
     key: "isMuted",
     value: function isMuted() {
       return this.state.client.localMute || this.state.server.localMute || this.state.server.remoteMute;
     }
+
     /**
-     * Returns true if the user is muted as a result of the client request (and not remotely muted)
+     * Returns true if the user is remotely muted
+     *
+     * @public
+     * @memberof MuteState
+     * @returns {Boolean}
+     */
+  }, {
+    key: "isRemotelyMuted",
+    value: function isRemotelyMuted() {
+      return this.state.server.remoteMute;
+    }
+
+    /**
+     * Returns true if unmute is allowed
      *
      * @public
      * @memberof MuteState
      * @returns {Boolean}
      */
+  }, {
+    key: "isUnmuteAllowed",
+    value: function isUnmuteAllowed() {
+      return this.state.server.unmuteAllowed;
+    }
 
+    /**
+     * Returns true if the user is locally muted
+     *
+     * @public
+     * @memberof MuteState
+     * @returns {Boolean}
+     */
+  }, {
+    key: "isLocallyMuted",
+    value: function isLocallyMuted() {
+      return this.state.client.localMute || this.state.server.localMute;
+    }
+
+    /**
+     * Returns true if the user is muted as a result of the client request (and not remotely muted)
+     *
+     * @public
+     * @memberof MuteState
+     * @returns {Boolean}
+     */
   }, {
     key: "isSelf",
     value: function isSelf() {
       return this.state.client.localMute && !this.state.server.remoteMute;
-    } // defined for backwards compatibility with the old AudioStateMachine/VideoStateMachine classes
+    }
 
+    // defined for backwards compatibility with the old AudioStateMachine/VideoStateMachine classes
   }, {
     key: "muted",
     get: function get() {
       return this.isMuted();
-    } // defined for backwards compatibility with the old AudioStateMachine/VideoStateMachine classes
+    }
 
+    // defined for backwards compatibility with the old AudioStateMachine/VideoStateMachine classes
   }, {
     key: "self",
     get: function get() {
@@ -361,7 +503,4 @@ var MuteState = /*#__PURE__*/function () {
   }]);
   return MuteState;
 }();
-
-var _default = createMuteState;
-exports.default = _default;
 //# sourceMappingURL=muteState.js.map