@webex/plugin-meetings 2.12.1 → 2.13.0

package/dist/meeting/index.js

@@ -1203,6 +1203,14 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
      */
 
     _this.meetingInfoFailureReason = undefined;
+    /**
+     * Indicates the current status of BNR in the meeting
+     * @type {BNR_STATUS}
+     * @private
+     * @memberof Meeting
+     */
+
+    _this.bnrStatus = _constants.BNR_STATUS.NOT_ENABLED;
 
     _this.setUpLocusInfoListeners();
 
@@ -4812,61 +4820,100 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
 
   }, {
     key: "updateAudio",
-    value: function updateAudio(options) {
-      var _this42 = this;
+    value: function () {
+      var _updateAudio = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(options) {
+        var _this42 = this;
 
-      if (!this.canUpdateMedia()) {
-        return this.enqueueMediaUpdate(MEDIA_UPDATE_TYPE.AUDIO, options);
-      }
+        var sendAudio, receiveAudio, stream, audioTransceiver, track;
+        return _regenerator.default.wrap(function _callee4$(_context4) {
+          while (1) {
+            switch (_context4.prev = _context4.next) {
+              case 0:
+                if (this.canUpdateMedia()) {
+                  _context4.next = 2;
+                  break;
+                }
 
-      var sendAudio = options.sendAudio,
-          receiveAudio = options.receiveAudio,
-          stream = options.stream;
-      var audioTransceiver = this.mediaProperties.peerConnection.audioTransceiver;
+                return _context4.abrupt("return", this.enqueueMediaUpdate(MEDIA_UPDATE_TYPE.AUDIO, options));
 
-      var track = _util.default.getTrack(stream).audioTrack;
+              case 2:
+                sendAudio = options.sendAudio, receiveAudio = options.receiveAudio, stream = options.stream;
+                audioTransceiver = this.mediaProperties.peerConnection.audioTransceiver;
+                track = _util.default.getTrack(stream).audioTrack;
 
-      if (typeof sendAudio !== 'boolean' || typeof receiveAudio !== 'boolean') {
-        return _promise.default.reject(new _parameter.default('Pass sendAudio and receiveAudio parameter'));
-      }
+                if (!(typeof sendAudio !== 'boolean' || typeof receiveAudio !== 'boolean')) {
+                  _context4.next = 7;
+                  break;
+                }
 
-      return _util.default.validateOptions({
-        sendAudio: sendAudio,
-        localStream: stream
-      }).then(function () {
-        var previousMediaDirection = {};
+                return _context4.abrupt("return", _promise.default.reject(new _parameter.default('Pass sendAudio and receiveAudio parameter')));
 
-        if (_this42.mediaProperties.mediaDirection) {
-          previousMediaDirection = {
-            sendTrack: _this42.mediaProperties.mediaDirection.sendAudio,
-            receiveTrack: _this42.mediaProperties.mediaDirection.receiveAudio
-          };
-        } else {
-          _this42.mediaProperties.mediaDirection = {};
-        }
+              case 7:
+                if (!(sendAudio && !this.isAudioMuted() && (this.bnrStatus === _constants.BNR_STATUS.ENABLED || this.bnrStatus === _constants.BNR_STATUS.SHOULD_ENABLE))) {
+                  _context4.next = 12;
+                  break;
+                }
 
-        return _util.default.updateTransceiver({
-          type: 'audio',
-          sendTrack: options.sendAudio,
-          receiveTrack: options.receiveAudio,
-          track: track,
-          transceiver: audioTransceiver,
-          peerConnection: _this42.mediaProperties.peerConnection,
-          previousMediaDirection: previousMediaDirection
-        }, {
-          mediaProperties: _this42.mediaProperties,
-          meeting: _this42,
-          id: _this42.id
-        });
-      }).then(function () {
-        _this42.setLocalAudioTrack(track);
+                _context4.next = 10;
+                return this.internal_enableBNR(track);
 
-        _this42.mediaProperties.mediaDirection.sendAudio = sendAudio;
-        _this42.mediaProperties.mediaDirection.receiveAudio = receiveAudio; // audio state could be undefined if you have not sent audio before
+              case 10:
+                track = _context4.sent;
+                this.bnrStatus = _constants.BNR_STATUS.ENABLED;
 
-        _this42.audio = _this42.audio || (0, _muteState.default)(_constants.AUDIO, _this42, _this42.mediaProperties.mediaDirection);
-      });
-    }
+              case 12:
+                return _context4.abrupt("return", _util.default.validateOptions({
+                  sendAudio: sendAudio,
+                  localStream: stream
+                }).then(function () {
+                  var previousMediaDirection = {};
+
+                  if (_this42.mediaProperties.mediaDirection) {
+                    previousMediaDirection = {
+                      sendTrack: _this42.mediaProperties.mediaDirection.sendAudio,
+                      receiveTrack: _this42.mediaProperties.mediaDirection.receiveAudio
+                    };
+                  } else {
+                    _this42.mediaProperties.mediaDirection = {};
+                  }
+
+                  return _util.default.updateTransceiver({
+                    type: 'audio',
+                    sendTrack: options.sendAudio,
+                    receiveTrack: options.receiveAudio,
+                    track: track,
+                    transceiver: audioTransceiver,
+                    peerConnection: _this42.mediaProperties.peerConnection,
+                    previousMediaDirection: previousMediaDirection
+                  }, {
+                    mediaProperties: _this42.mediaProperties,
+                    meeting: _this42,
+                    id: _this42.id
+                  });
+                }).then(function () {
+                  _this42.setLocalAudioTrack(track);
+
+                  _this42.mediaProperties.mediaDirection.sendAudio = sendAudio;
+                  _this42.mediaProperties.mediaDirection.receiveAudio = receiveAudio; // audio state could be undefined if you have not sent audio before
+
+                  // audio state could be undefined if you have not sent audio before
+                  _this42.audio = _this42.audio || (0, _muteState.default)(_constants.AUDIO, _this42, _this42.mediaProperties.mediaDirection);
+                }));
+
+              case 13:
+              case "end":
+                return _context4.stop();
+            }
+          }
+        }, _callee4, this);
+      }));
+
+      function updateAudio(_x3) {
+        return _updateAudio.apply(this, arguments);
+      }
+
+      return updateAudio;
+    }()
     /**
      * Update the main video track with new parameters
      * @param {Object} options
@@ -6162,81 +6209,151 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
      */
 
   }, {
-    key: "enableBNR",
+    key: "isBnrEnabled",
     value:
+    /**
+     * Internal API to return status of BNR
+     * @returns {Boolean}
+     * @public
+     * @memberof Meeting
+     */
+    function isBnrEnabled() {
+      return this.bnrStatus === _constants.BNR_STATUS.ENABLED;
+    }
+    /**
+     * Internal API to obtain BNR enabled MediaStream
+     * @returns {Promise<MediaStreamTrack>}
+     * @private
+     * @param {MedaiStreamTrack} audioTrack from updateAudio
+     * @memberof Meeting
+     */
+
+  }, {
+    key: "internal_enableBNR",
+    value: function () {
+      var _internal_enableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(audioTrack) {
+        var bnrAudioTrack;
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) {
+            switch (_context5.prev = _context5.next) {
+              case 0:
+                _context5.prev = 0;
+
+                _loggerProxy.default.logger.info('Meeting:index#internal_enableBNR. Internal enable BNR called');
+
+                _context5.next = 4;
+                return _internalMediaCore.Media.Effects.BNR.enableBNR(audioTrack);
+
+              case 4:
+                bnrAudioTrack = _context5.sent;
+
+                _loggerProxy.default.logger.info('Meeting:index#internal_enableBNR. BNR enabled track obtained from WebRTC & returned as stream');
+
+                return _context5.abrupt("return", bnrAudioTrack);
+
+              case 9:
+                _context5.prev = 9;
+                _context5.t0 = _context5["catch"](0);
+
+                _loggerProxy.default.logger.error('Meeting:index#internal_enableBNR.', _context5.t0);
+
+                throw _context5.t0;
+
+              case 13:
+              case "end":
+                return _context5.stop();
+            }
+          }
+        }, _callee5, null, [[0, 9]]);
+      }));
+
+      function internal_enableBNR(_x4) {
+        return _internal_enableBNR.apply(this, arguments);
+      }
+
+      return internal_enableBNR;
+    }()
     /**
      * enableBNR API
      * @returns {Promise<Boolean>}
      * @public
      * @memberof Meeting
      */
-    function () {
-      var _enableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+
+  }, {
+    key: "enableBNR",
+    value: function () {
+      var _enableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
         var isSuccess, audioStream;
-        return _regenerator.default.wrap(function _callee4$(_context4) {
+        return _regenerator.default.wrap(function _callee6$(_context6) {
           while (1) {
-            switch (_context4.prev = _context4.next) {
+            switch (_context6.prev = _context6.next) {
               case 0:
                 _loggerProxy.default.logger.info('Meeting:index#enableBNR. Enable BNR called');
 
                 isSuccess = false;
-                _context4.prev = 2;
+                _context6.prev = 2;
 
                 if (!(typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined')) {
-                  _context4.next = 5;
+                  _context6.next = 7;
                   break;
                 }
 
                 throw new Error("Meeting doesn't have an audioTrack attached");
 
-              case 5:
-                _context4.next = 7;
-                return _internalMediaCore.Media.Effects.BNR.enableBNR(this.mediaProperties.audioTrack);
-
               case 7:
-                this.mediaProperties.audioTrack = _context4.sent;
+                if (!this.isAudioMuted()) {
+                  _context6.next = 9;
+                  break;
+                }
+
+                throw new Error('Cannot enable BNR while meeting is muted');
+
+              case 9:
+                this.bnrStatus = _constants.BNR_STATUS.SHOULD_ENABLE;
                 audioStream = _util2.default.createMediaStream([this.mediaProperties.audioTrack]);
 
-                _loggerProxy.default.logger.info('Meeting:index#enableBNR. BNR enabled track obtained from WebRTC & sent to updateAudio');
+                _loggerProxy.default.logger.info('Meeting:index#enableBNR. MediaStream created from meeting & sent to updateAudio');
 
-                _context4.next = 12;
+                _context6.next = 14;
                 return this.updateAudio({
                   sendAudio: true,
-                  receiveAudio: true,
+                  receiveAudio: this.mediaProperties.mediaDirection.receiveAudio,
                   stream: audioStream
                 });
 
-              case 12:
-                this.isBnrEnabled = true;
+              case 14:
+                this.bnrStatus = _constants.BNR_STATUS.ENABLED;
                 isSuccess = true;
 
                 _metrics.default.sendBehavioralMetric(_constants2.default.ENABLE_BNR_SUCCESS);
 
-                _context4.next = 22;
+                _context6.next = 25;
                 break;
 
-              case 17:
-                _context4.prev = 17;
-                _context4.t0 = _context4["catch"](2);
-
-                _loggerProxy.default.logger.error("Meeting:index#enableBNR. ".concat(_context4.t0));
+              case 19:
+                _context6.prev = 19;
+                _context6.t0 = _context6["catch"](2);
+                this.bnrStatus = _constants.BNR_STATUS.NOT_ENABLED;
 
                 _metrics.default.sendBehavioralMetric(_constants2.default.ENABLE_BNR_FAILURE, {
-                  reason: _context4.t0.message,
-                  stack: _context4.t0.stack
+                  reason: _context6.t0.message,
+                  stack: _context6.t0.stack
                 });
 
-                throw _context4.t0;
+                _loggerProxy.default.logger.error('Meeting:index#enableBNR.', _context6.t0);
 
-              case 22:
-                return _context4.abrupt("return", isSuccess);
+                throw _context6.t0;
 
-              case 23:
+              case 25:
+                return _context6.abrupt("return", isSuccess);
+
+              case 26:
               case "end":
-                return _context4.stop();
+                return _context6.stop();
             }
           }
-        }, _callee4, this, [[2, 17]]);
+        }, _callee6, this, [[2, 19]]);
       }));
 
       function enableBNR() {
@@ -6255,68 +6372,78 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
   }, {
     key: "disableBNR",
     value: function () {
-      var _disableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
-        var isSuccess, audioStream;
-        return _regenerator.default.wrap(function _callee5$(_context5) {
+      var _disableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
+        var isSuccess, audioTrack, audioStream;
+        return _regenerator.default.wrap(function _callee7$(_context7) {
           while (1) {
-            switch (_context5.prev = _context5.next) {
+            switch (_context7.prev = _context7.next) {
               case 0:
                 _loggerProxy.default.logger.info('Meeting:index#disableBNR. Disable BNR called');
 
                 isSuccess = false;
-                _context5.prev = 2;
+                _context7.prev = 2;
+
+                if (this.isBnrEnabled()) {
+                  _context7.next = 7;
+                  break;
+                }
 
+                throw new Error('Can not disable as BNR is not enabled');
+
+              case 7:
                 if (!(typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined')) {
-                  _context5.next = 5;
+                  _context7.next = 9;
                   break;
                 }
 
                 throw new Error("Meeting doesn't have an audioTrack attached");
 
-              case 5:
-                this.mediaProperties.audioTrack = _internalMediaCore.Media.Effects.BNR.disableBNR(this.mediaProperties.audioTrack);
-                audioStream = _util2.default.createMediaStream([this.mediaProperties.audioTrack]);
+              case 9:
+                audioTrack = _internalMediaCore.Media.Effects.BNR.disableBNR(this.mediaProperties.audioTrack);
+                audioStream = _util2.default.createMediaStream([audioTrack]);
 
                 _loggerProxy.default.logger.info('Meeting:index#disableBNR. Raw media track obtained from WebRTC & sent to updateAudio');
 
-                _context5.next = 10;
+                this.bnrStatus = _constants.BNR_STATUS.SHOULD_DISABLE;
+                _context7.next = 15;
                 return this.updateAudio({
                   sendAudio: true,
-                  receiveAudio: true,
+                  receiveAudio: this.mediaProperties.mediaDirection.receiveAudio,
                   stream: audioStream
                 });
 
-              case 10:
-                this.isBnrEnabled = false;
+              case 15:
+                this.bnrStatus = _constants.BNR_STATUS.NOT_ENABLED;
                 isSuccess = true;
 
                 _metrics.default.sendBehavioralMetric(_constants2.default.DISABLE_BNR_SUCCESS);
 
-                _context5.next = 20;
+                _context7.next = 26;
                 break;
 
-              case 15:
-                _context5.prev = 15;
-                _context5.t0 = _context5["catch"](2);
+              case 20:
+                _context7.prev = 20;
+                _context7.t0 = _context7["catch"](2);
+                this.bnrStatus = _constants.BNR_STATUS.ENABLED;
 
-                _loggerProxy.default.logger.error("Meeting:index#disableBNR. ".concat(_context5.t0));
+                _loggerProxy.default.logger.error("Meeting:index#disableBNR. ".concat(_context7.t0));
 
                 _metrics.default.sendBehavioralMetric(_constants2.default.DISABLE_BNR_FAILURE, {
-                  reason: _context5.t0.message,
-                  stack: _context5.t0.stack
+                  reason: _context7.t0.message,
+                  stack: _context7.t0.stack
                 });
 
-                throw _context5.t0;
+                throw _context7.t0;
 
-              case 20:
-                return _context5.abrupt("return", isSuccess);
+              case 26:
+                return _context7.abrupt("return", isSuccess);
 
-              case 21:
+              case 27:
               case "end":
-                return _context5.stop();
+                return _context7.stop();
             }
           }
-        }, _callee5, this, [[2, 15]]);
+        }, _callee7, this, [[2, 20]]);
       }));
 
       function disableBNR() {