@webex/plugin-meetings 2.12.0 → 2.14.0

package/dist/meeting/index.js

@@ -86,6 +86,8 @@ var _state = _interopRequireDefault(require("../meeting/state"));
 
 var _muteState = _interopRequireDefault(require("../meeting/muteState"));
 
+var _effectsState = _interopRequireDefault(require("../meeting/effectsState"));
+
 var _locusInfo = _interopRequireDefault(require("../locus-info"));
 
 var _peerConnectionManager = _interopRequireDefault(require("../peer-connection-manager"));
@@ -780,6 +782,15 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
      */
 
     _this.video = null;
+    /**
+     * created later
+     * @instance
+     * @type {EffectsState}
+     * @private
+     * @memberof Meeting
+     */
+
+    _this.effects = null;
     /**
      * @instance
      * @type {MeetingStateMachine}
@@ -4812,61 +4823,103 @@ 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, bnrEnabled, 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, bnrEnabled = options.bnrEnabled;
+                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() && (bnrEnabled === _constants.BNR_STATUS.ENABLED || bnrEnabled === _constants.BNR_STATUS.SHOULD_ENABLE))) {
+                  _context4.next = 13;
+                  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);
+                _loggerProxy.default.logger.info('Meeting:index#updateAudio. Calling WebRTC enable bnr method');
 
-        _this42.mediaProperties.mediaDirection.sendAudio = sendAudio;
-        _this42.mediaProperties.mediaDirection.receiveAudio = receiveAudio; // audio state could be undefined if you have not sent audio before
+                _context4.next = 11;
+                return this.internal_enableBNR(track);
 
-        _this42.audio = _this42.audio || (0, _muteState.default)(_constants.AUDIO, _this42, _this42.mediaProperties.mediaDirection);
-      });
-    }
+              case 11:
+                track = _context4.sent;
+
+                _loggerProxy.default.logger.info('Meeting:index#updateAudio. WebRTC enable bnr request completed');
+
+              case 13:
+                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 14:
+              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,169 +6215,134 @@ var Meeting = /*#__PURE__*/function (_StatelessWebexPlugin) {
      */
 
   }, {
-    key: "enableBNR",
+    key: "isBnrEnabled",
     value:
     /**
-     * enableBNR API
-     * @returns {Promise<Boolean>}
+     * Internal API to return status of BNR
+     * @returns {Boolean}
      * @public
      * @memberof Meeting
      */
-    function () {
-      var _enableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-        var isSuccess, audioStream;
-        return _regenerator.default.wrap(function _callee4$(_context4) {
+    function isBnrEnabled() {
+      return this.effects && this.effects.isBnrEnabled();
+    }
+    /**
+     * 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 (_context4.prev = _context4.next) {
+            switch (_context5.prev = _context5.next) {
               case 0:
-                _loggerProxy.default.logger.info('Meeting:index#enableBNR. Enable BNR called');
-
-                isSuccess = false;
-                _context4.prev = 2;
+                _context5.prev = 0;
 
-                if (!(typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined')) {
-                  _context4.next = 5;
-                  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;
-                audioStream = _util2.default.createMediaStream([this.mediaProperties.audioTrack]);
-
-                _loggerProxy.default.logger.info('Meeting:index#enableBNR. BNR enabled track obtained from WebRTC & sent to updateAudio');
-
-                _context4.next = 12;
-                return this.updateAudio({
-                  sendAudio: true,
-                  receiveAudio: true,
-                  stream: audioStream
-                });
-
-              case 12:
-                this.isBnrEnabled = true;
-                isSuccess = true;
+                _loggerProxy.default.logger.info('Meeting:index#internal_enableBNR. Internal enable BNR called');
 
-                _metrics.default.sendBehavioralMetric(_constants2.default.ENABLE_BNR_SUCCESS);
+                _context5.next = 4;
+                return _internalMediaCore.Media.Effects.BNR.enableBNR(audioTrack);
 
-                _context4.next = 22;
-                break;
+              case 4:
+                bnrAudioTrack = _context5.sent;
 
-              case 17:
-                _context4.prev = 17;
-                _context4.t0 = _context4["catch"](2);
+                _loggerProxy.default.logger.info('Meeting:index#internal_enableBNR. BNR enabled track obtained from WebRTC & returned as stream');
 
-                _loggerProxy.default.logger.error("Meeting:index#enableBNR. ".concat(_context4.t0));
+                return _context5.abrupt("return", bnrAudioTrack);
 
-                _metrics.default.sendBehavioralMetric(_constants2.default.ENABLE_BNR_FAILURE, {
-                  reason: _context4.t0.message,
-                  stack: _context4.t0.stack
-                });
+              case 9:
+                _context5.prev = 9;
+                _context5.t0 = _context5["catch"](0);
 
-                throw _context4.t0;
+                _loggerProxy.default.logger.error('Meeting:index#internal_enableBNR.', _context5.t0);
 
-              case 22:
-                return _context4.abrupt("return", isSuccess);
+                throw _context5.t0;
 
-              case 23:
+              case 13:
               case "end":
-                return _context4.stop();
+                return _context5.stop();
             }
           }
-        }, _callee4, this, [[2, 17]]);
+        }, _callee5, null, [[0, 9]]);
       }));
 
-      function enableBNR() {
-        return _enableBNR.apply(this, arguments);
+      function internal_enableBNR(_x4) {
+        return _internal_enableBNR.apply(this, arguments);
       }
 
-      return enableBNR;
+      return internal_enableBNR;
     }()
     /**
-     * disableBNR API
-     * @returns {Promise<Boolean>}
+     * Enable the audio track with BNR for a meeting
+     * @returns {Promise} resolves the data from enable bnr or rejects if there is no audio or audio is muted
      * @public
      * @memberof Meeting
      */
 
   }, {
-    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) {
-          while (1) {
-            switch (_context5.prev = _context5.next) {
-              case 0:
-                _loggerProxy.default.logger.info('Meeting:index#disableBNR. Disable BNR called');
-
-                isSuccess = false;
-                _context5.prev = 2;
-
-                if (!(typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined')) {
-                  _context5.next = 5;
-                  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]);
-
-                _loggerProxy.default.logger.info('Meeting:index#disableBNR. Raw media track obtained from WebRTC & sent to updateAudio');
-
-                _context5.next = 10;
-                return this.updateAudio({
-                  sendAudio: true,
-                  receiveAudio: true,
-                  stream: audioStream
-                });
-
-              case 10:
-                this.isBnrEnabled = false;
-                isSuccess = true;
-
-                _metrics.default.sendBehavioralMetric(_constants2.default.DISABLE_BNR_SUCCESS);
-
-                _context5.next = 20;
-                break;
-
-              case 15:
-                _context5.prev = 15;
-                _context5.t0 = _context5["catch"](2);
-
-                _loggerProxy.default.logger.error("Meeting:index#disableBNR. ".concat(_context5.t0));
+    key: "enableBNR",
+    value: function enableBNR() {
+      if (typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined') {
+        return _promise.default.reject(new Error("Meeting doesn't have an audioTrack attached"));
+      }
 
-                _metrics.default.sendBehavioralMetric(_constants2.default.DISABLE_BNR_FAILURE, {
-                  reason: _context5.t0.message,
-                  stack: _context5.t0.stack
-                });
+      if (this.isAudioMuted()) {
+        return _promise.default.reject(new Error('Cannot enable BNR while meeting is muted'));
+      }
 
-                throw _context5.t0;
+      this.effects = this.effects || (0, _effectsState.default)('BNR');
+      var LOG_HEADER = 'Meeting:index#enableBNR -->';
+      return logRequest(this.effects.handleClientRequest(true, this).then(function (res) {
+        _loggerProxy.default.logger.info('Meeting:index#enableBNR. Enable bnr completed');
 
-              case 20:
-                return _context5.abrupt("return", isSuccess);
+        return res;
+      }).catch(function (error) {
+        throw error;
+      }), {
+        header: "".concat(LOG_HEADER, " enable bnr"),
+        success: "".concat(LOG_HEADER, " enable bnr success"),
+        failure: "".concat(LOG_HEADER, " enable bnr failure, ")
+      });
+    }
+    /**
+     * Disable the BNR for an audio track
+     * @returns {Promise} resolves the data from disable bnr or rejects if there is no audio set
+     * @public
+     * @memberof Meeting
+     */
 
-              case 21:
-              case "end":
-                return _context5.stop();
-            }
-          }
-        }, _callee5, this, [[2, 15]]);
-      }));
+  }, {
+    key: "disableBNR",
+    value: function disableBNR() {
+      if (typeof this.mediaProperties === 'undefined' || typeof this.mediaProperties.audioTrack === 'undefined') {
+        return _promise.default.reject(new Error("Meeting doesn't have an audioTrack attached"));
+      }
 
-      function disableBNR() {
-        return _disableBNR.apply(this, arguments);
+      if (!this.isBnrEnabled()) {
+        return _promise.default.reject(new Error('Can not disable as BNR is not enabled'));
       }
 
-      return disableBNR;
-    }()
+      this.effects = this.effects || (0, _effectsState.default)('BNR');
+      var LOG_HEADER = 'Meeting:index#disableBNR -->';
+      return logRequest(this.effects.handleClientRequest(false, this).then(function (res) {
+        _loggerProxy.default.logger.info('Meeting:index#disableBNR. Disable bnr completed');
+
+        return res;
+      }).catch(function (error) {
+        throw error;
+      }), {
+        header: "".concat(LOG_HEADER, " disable bnr"),
+        success: "".concat(LOG_HEADER, " disable bnr success"),
+        failure: "".concat(LOG_HEADER, " disable bnr failure, ")
+      });
+    }
   }]);
   return Meeting;
 }(_webexCore.StatelessWebexPlugin);