@webex/plugin-meetings 3.0.0 → 3.1.0

package/dist/multistream/remoteMediaManager.js

@@ -28,6 +28,7 @@ var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy")
 var _eventsScope = _interopRequireDefault(require("../common/events/events-scope"));
 var _remoteMedia = require("./remoteMedia");
 var _remoteMediaGroup = require("./remoteMediaGroup");
+var _constants = require("../constants");
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /* eslint-disable valid-jsdoc */
 /* Predefined layouts: */ // An "all equal" grid, with size up to 3 x 3 = 9:
@@ -146,6 +147,7 @@ var DefaultConfiguration = exports.DefaultConfiguration = {
 };
 var Event = exports.Event = /*#__PURE__*/function (Event) {
   Event["AudioCreated"] = "AudioCreated";
+  Event["InterpretationAudioCreated"] = "InterpretationAudioCreated";
   Event["ScreenShareAudioCreated"] = "ScreenShareAudioCreated";
   Event["VideoLayoutChanged"] = "VideoLayoutChanged";
   return Event;
@@ -187,7 +189,10 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
     _this.receiveSlotManager = receiveSlotManager;
     _this.mediaRequestManagers = mediaRequestManagers;
     _this.media = {
-      audio: undefined,
+      audio: {
+        main: undefined,
+        si: undefined
+      },
       video: {
         activeSpeakerGroups: {},
         memberPanes: {}
@@ -199,7 +204,10 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
     };
     _this.checkConfigValidity();
     _this.slots = {
-      audio: [],
+      audio: {
+        main: [],
+        si: undefined
+      },
       screenShare: {
         audio: [],
         video: undefined
@@ -316,10 +324,13 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
       });
 
       // release all audio receive slots
-      this.slots.audio.forEach(function (slot) {
+      this.slots.audio.main.forEach(function (slot) {
         return _this2.receiveSlotManager.releaseSlot(slot);
       });
-      this.slots.audio.length = 0;
+      this.slots.audio.main.length = 0;
+      if (this.slots.audio.si) {
+        this.receiveSlotManager.releaseSlot(this.slots.audio.si);
+      }
 
       // release screen share slots
       this.slots.screenShare.audio.forEach(function (slot) {
@@ -500,50 +511,148 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
       this.mediaRequestManagers.video.commit();
     }
 
+    /**
+     * Sets which named media group need receiving
+     * @param {MediaType} mediaType of the stream
+     * @param {number} languageCode of the stream. If the languageId is 0, the named media group request will be canceled,
+     * and only receive the main audio stream.
+     * @returns {void}
+     */
+  }, {
+    key: "setReceiveNamedMediaGroup",
+    value: (function () {
+      var _setReceiveNamedMediaGroup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(mediaType, languageId) {
+        var _this$config$namedMed;
+        var value;
+        return _regenerator.default.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              if (!(mediaType !== _internalMediaCore.MediaType.AudioMain)) {
+                _context4.next = 2;
+                break;
+              }
+              throw new Error("cannot set receive named media group which media type is ".concat(mediaType));
+            case 2:
+              value = languageId;
+              if (!(value === ((_this$config$namedMed = this.config.namedMediaGroup) === null || _this$config$namedMed === void 0 ? void 0 : _this$config$namedMed.value))) {
+                _context4.next = 5;
+                break;
+              }
+              return _context4.abrupt("return");
+            case 5:
+              this.config.namedMediaGroup = {
+                type: _constants.NAMED_MEDIA_GROUP_TYPE_AUDIO,
+                value: value
+              };
+              if (this.media.audio.si) {
+                _context4.next = 11;
+                break;
+              }
+              _context4.next = 9;
+              return this.createInterpretationAudioMedia(true);
+            case 9:
+              _context4.next = 12;
+              break;
+            case 11:
+              this.media.audio.si.setNamedMediaGroup(this.config.namedMediaGroup, true);
+            case 12:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this);
+      }));
+      function setReceiveNamedMediaGroup(_x2, _x3) {
+        return _setReceiveNamedMediaGroup.apply(this, arguments);
+      }
+      return setReceiveNamedMediaGroup;
+    }()
     /**
      * Creates the audio slots
      */
+    )
   }, {
     key: "createAudioMedia",
     value: (function () {
-      var _createAudioMedia = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+      var _createAudioMedia = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
         var i, slot;
-        return _regenerator.default.wrap(function _callee4$(_context4) {
-          while (1) switch (_context4.prev = _context4.next) {
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
             case 0:
+              _context5.next = 2;
+              return this.createInterpretationAudioMedia(false);
+            case 2:
               i = 0;
-            case 1:
+            case 3:
               if (!(i < this.config.audio.numOfActiveSpeakerStreams)) {
-                _context4.next = 9;
+                _context5.next = 11;
                 break;
               }
-              _context4.next = 4;
+              _context5.next = 6;
               return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.AudioMain);
-            case 4:
-              slot = _context4.sent;
-              this.slots.audio.push(slot);
             case 6:
+              slot = _context5.sent;
+              this.slots.audio.main.push(slot);
+            case 8:
               i += 1;
-              _context4.next = 1;
+              _context5.next = 3;
               break;
-            case 9:
-              // create a remote media group
-              this.media.audio = new _remoteMediaGroup.RemoteMediaGroup(this.mediaRequestManagers.audio, this.slots.audio, 255, true);
+            case 11:
+              // create a remote media group for main audio
+              this.media.audio.main = new _remoteMediaGroup.RemoteMediaGroup(this.mediaRequestManagers.audio, this.slots.audio.main, 255, true);
               this.emit({
                 file: 'multistream/remoteMediaManager',
                 function: 'createAudioMedia'
-              }, Event.AudioCreated, this.media.audio);
-            case 11:
+              }, Event.AudioCreated, this.media.audio.main);
+            case 13:
             case "end":
-              return _context4.stop();
+              return _context5.stop();
           }
-        }, _callee4, this);
+        }, _callee5, this);
       }));
       function createAudioMedia() {
         return _createAudioMedia.apply(this, arguments);
       }
       return createAudioMedia;
     }()
+    /**
+     * Creates the audio slots for named media
+     */
+    )
+  }, {
+    key: "createInterpretationAudioMedia",
+    value: (function () {
+      var _createInterpretationAudioMedia = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(commitRequest) {
+        var _this$config$namedMed2, _this$config$namedMed3;
+        return _regenerator.default.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
+            case 0:
+              if (!(((_this$config$namedMed2 = this.config.namedMediaGroup) === null || _this$config$namedMed2 === void 0 ? void 0 : _this$config$namedMed2.type) === _constants.NAMED_MEDIA_GROUP_TYPE_AUDIO && (_this$config$namedMed3 = this.config.namedMediaGroup) !== null && _this$config$namedMed3 !== void 0 && _this$config$namedMed3.value)) {
+                _context6.next = 6;
+                break;
+              }
+              _context6.next = 3;
+              return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.AudioMain);
+            case 3:
+              this.slots.audio.si = _context6.sent;
+              // create a remote media group for si audio
+              this.media.audio.si = new _remoteMediaGroup.RemoteMediaGroup(this.mediaRequestManagers.audio, [this.slots.audio.si], 255, commitRequest, {
+                namedMediaGroup: this.config.namedMediaGroup
+              });
+              this.emit({
+                file: 'multistream/remoteMediaManager',
+                function: 'createInterpretationAudioMedia'
+              }, Event.InterpretationAudioCreated, this.media.audio.si);
+            case 6:
+            case "end":
+              return _context6.stop();
+          }
+        }, _callee6, this);
+      }));
+      function createInterpretationAudioMedia(_x4) {
+        return _createInterpretationAudioMedia.apply(this, arguments);
+      }
+      return createInterpretationAudioMedia;
+    }()
     /**
      * Creates receive slots required for receiving screen share audio and video
      */
@@ -551,25 +660,25 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
   }, {
     key: "createScreenShareReceiveSlots",
     value: (function () {
-      var _createScreenShareReceiveSlots = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
+      var _createScreenShareReceiveSlots = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
         var i, slot, isAnyLayoutContainingScreenShareVideo;
-        return _regenerator.default.wrap(function _callee5$(_context5) {
-          while (1) switch (_context5.prev = _context5.next) {
+        return _regenerator.default.wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
             case 0:
               i = 0;
             case 1:
               if (!(i < this.config.audio.numOfScreenShareStreams)) {
-                _context5.next = 9;
+                _context7.next = 9;
                 break;
               }
-              _context5.next = 4;
+              _context7.next = 4;
               return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.AudioSlides);
             case 4:
-              slot = _context5.sent;
+              slot = _context7.sent;
               this.slots.screenShare.audio.push(slot);
             case 6:
               i += 1;
-              _context5.next = 1;
+              _context7.next = 1;
               break;
             case 9:
               // video
@@ -577,18 +686,18 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
                 return !!layout.screenShareVideo;
               });
               if (!isAnyLayoutContainingScreenShareVideo) {
-                _context5.next = 14;
+                _context7.next = 14;
                 break;
               }
-              _context5.next = 13;
+              _context7.next = 13;
               return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.VideoSlides);
             case 13:
-              this.slots.screenShare.video = _context5.sent;
+              this.slots.screenShare.video = _context7.sent;
             case 14:
             case "end":
-              return _context5.stop();
+              return _context7.stop();
           }
-        }, _callee5, this);
+        }, _callee7, this);
       }));
       function createScreenShareReceiveSlots() {
         return _createScreenShareReceiveSlots.apply(this, arguments);
@@ -724,37 +833,37 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
   }, {
     key: "refillRequiredSlotsIfNeeded",
     value: (function () {
-      var _refillRequiredSlotsIfNeeded = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
+      var _refillRequiredSlotsIfNeeded = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8() {
         var requiredNumSlots, totalNumSlots, numSlotsToCreate;
-        return _regenerator.default.wrap(function _callee6$(_context6) {
-          while (1) switch (_context6.prev = _context6.next) {
+        return _regenerator.default.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
             case 0:
               requiredNumSlots = this.getRequiredNumVideoSlotsForLayout(this.currentLayout);
               totalNumSlots = this.slots.video.unused.length + this.slots.video.activeSpeaker.length + this.slots.video.receiverSelected.length;
               if (!(totalNumSlots < requiredNumSlots)) {
-                _context6.next = 13;
+                _context8.next = 13;
                 break;
               }
               numSlotsToCreate = requiredNumSlots - totalNumSlots;
             case 4:
               if (!(numSlotsToCreate > 0)) {
-                _context6.next = 13;
+                _context8.next = 13;
                 break;
               }
-              _context6.t0 = this.slots.video.unused;
-              _context6.next = 8;
+              _context8.t0 = this.slots.video.unused;
+              _context8.next = 8;
               return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.VideoMain);
             case 8:
-              _context6.t1 = _context6.sent;
-              _context6.t0.push.call(_context6.t0, _context6.t1);
+              _context8.t1 = _context8.sent;
+              _context8.t0.push.call(_context8.t0, _context8.t1);
               numSlotsToCreate -= 1;
-              _context6.next = 4;
+              _context8.next = 4;
               break;
             case 13:
             case "end":
-              return _context6.stop();
+              return _context8.stop();
           }
-        }, _callee6, this);
+        }, _callee8, this);
       }));
       function refillRequiredSlotsIfNeeded() {
         return _refillRequiredSlotsIfNeeded.apply(this, arguments);
@@ -796,7 +905,7 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
   }, {
     key: "logMainAudioReceiveSlots",
     value: function logMainAudioReceiveSlots() {
-      _loggerProxy.default.logger.log("RemoteMediaManager#logMainAudioReceiveSlots --> MAIN AUDIO receive slots: ".concat(this.slots.audio.map(function (slot) {
+      _loggerProxy.default.logger.log("RemoteMediaManager#logMainAudioReceiveSlots --> MAIN AUDIO receive slots: ".concat(this.slots.audio.main.map(function (slot) {
         return slot.logString;
       }).join(', ')));
     }
@@ -837,9 +946,9 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
   }, {
     key: "updateVideoReceiveSlots",
     value: (function () {
-      var _updateVideoReceiveSlots = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
-        return _regenerator.default.wrap(function _callee7$(_context7) {
-          while (1) switch (_context7.prev = _context7.next) {
+      var _updateVideoReceiveSlots = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9() {
+        return _regenerator.default.wrap(function _callee9$(_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
             case 0:
               // move all active speaker slots to "unused"
               this.trimActiveSpeakerSlots();
@@ -848,7 +957,7 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
               this.trimReceiverSelectedSlots();
 
               // ensure we have enough total slots for current layout
-              _context7.next = 4;
+              _context9.next = 4;
               return this.refillRequiredSlotsIfNeeded();
             case 4:
               // allocate the slots to the right panes / pane groups
@@ -868,9 +977,9 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
               this.releaseUnusedVideoSlots();
             case 9:
             case "end":
-              return _context7.stop();
+              return _context9.stop();
           }
-        }, _callee7, this);
+        }, _callee9, this);
       }));
       function updateVideoReceiveSlots() {
         return _updateVideoReceiveSlots.apply(this, arguments);
@@ -988,8 +1097,13 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
         screenShareAudio = options.screenShareAudio,
         screenShareVideo = options.screenShareVideo,
         commit = options.commit;
-      if (audio && this.media.audio) {
-        this.media.audio.stop(commit);
+      if (audio) {
+        if (this.media.audio.main) {
+          this.media.audio.main.stop(commit);
+        }
+        if (this.media.audio.si) {
+          this.media.audio.si.stop(commit);
+        }
       }
       if (video) {
         (0, _values.default)(this.media.video.activeSpeakerGroups).forEach(function (remoteMediaGroup) {
@@ -1061,14 +1175,14 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
   }, {
     key: "addMemberVideoPane",
     value: (function () {
-      var _addMemberVideoPane = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(newPane) {
+      var _addMemberVideoPane = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(newPane) {
         var _this$currentLayout5;
         var receiveSlot, remoteMedia;
-        return _regenerator.default.wrap(function _callee8$(_context8) {
-          while (1) switch (_context8.prev = _context8.next) {
+        return _regenerator.default.wrap(function _callee10$(_context10) {
+          while (1) switch (_context10.prev = _context10.next) {
             case 0:
               if (this.currentLayout) {
-                _context8.next = 2;
+                _context10.next = 2;
                 break;
               }
               throw new Error('There is no current layout selected, call start() first');
@@ -1077,16 +1191,16 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
                 this.currentLayout.memberVideoPanes = [];
               }
               if (!(newPane.id in this.currentLayout.memberVideoPanes)) {
-                _context8.next = 5;
+                _context10.next = 5;
                 break;
               }
               throw new Error("duplicate pane id ".concat(newPane.id, " - this pane already exists in current layout's memberVideoPanes"));
             case 5:
               this.currentLayout.memberVideoPanes.push(newPane);
-              _context8.next = 8;
+              _context10.next = 8;
               return this.receiveSlotManager.allocateSlot(_internalMediaCore.MediaType.VideoMain);
             case 8:
-              receiveSlot = _context8.sent;
+              receiveSlot = _context10.sent;
               this.slots.video.receiverSelected.push(receiveSlot);
               remoteMedia = new _remoteMedia.RemoteMedia(receiveSlot, this.mediaRequestManagers.video, {
                 resolution: newPane.size
@@ -1095,14 +1209,14 @@ var RemoteMediaManager = exports.RemoteMediaManager = /*#__PURE__*/function (_Ev
                 remoteMedia.sendMediaRequest(newPane.csi, true);
               }
               this.media.video.memberPanes[newPane.id] = remoteMedia;
-              return _context8.abrupt("return", remoteMedia);
+              return _context10.abrupt("return", remoteMedia);
             case 14:
             case "end":
-              return _context8.stop();
+              return _context10.stop();
           }
-        }, _callee8, this);
+        }, _callee10, this);
       }));
-      function addMemberVideoPane(_x2) {
+      function addMemberVideoPane(_x5) {
         return _addMemberVideoPane.apply(this, arguments);
       }
       return addMemberVideoPane;