fcr-ui-scene 3.7.7 → 3.7.8-rc.1

package/lib/providers/screen-share/stream-state-sync.js

@@ -1,7 +1,39 @@
 "use strict";
 
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.symbol.to-primitive.js");
+require("core-js/modules/es.array.is-array.js");
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.date.to-primitive.js");
+require("core-js/modules/es.function.bind.js");
+require("core-js/modules/es.function.name.js");
+require("core-js/modules/es.map.js");
+require("core-js/modules/es.number.constructor.js");
+require("core-js/modules/es.object.create.js");
 require("core-js/modules/es.object.define-property.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/esnext.function.metadata.js");
+require("core-js/modules/esnext.map.delete-all.js");
+require("core-js/modules/esnext.map.emplace.js");
+require("core-js/modules/esnext.map.every.js");
+require("core-js/modules/esnext.map.filter.js");
+require("core-js/modules/esnext.map.find.js");
+require("core-js/modules/esnext.map.find-key.js");
+require("core-js/modules/esnext.map.includes.js");
+require("core-js/modules/esnext.map.key-of.js");
+require("core-js/modules/esnext.map.map-keys.js");
+require("core-js/modules/esnext.map.map-values.js");
+require("core-js/modules/esnext.map.merge.js");
+require("core-js/modules/esnext.map.reduce.js");
+require("core-js/modules/esnext.map.some.js");
+require("core-js/modules/esnext.map.update.js");
+require("core-js/modules/esnext.symbol.metadata.js");
+require("core-js/modules/web.dom-collections.iterator.js");
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,9 +41,13 @@ exports.FcrUIScreenStreamSync = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.error.to-string.js");
+require("core-js/modules/es.array.find.js");
 require("core-js/modules/es.object.to-string.js");
 require("core-js/modules/es.promise.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.find.js");
 require("core-js/modules/web.timers.js");
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -19,17 +55,27 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _type = require("fcr-core/lib/type");
 var _objectManager = require("../../object-manager");
 var _logger = require("../../utilities/logger");
+var _decorator = require("agora-foundation/lib/decorator");
+var _FcrUIScreenStreamSync;
+var _initProto;
+function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function set(e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O["static"] = l, O["private"] = f, f ? 2 === o ? k = function k(e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function k(e) { return e[n]; }, (o < 2 || 4 === o) && (F = function F(e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == _typeof(P) && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol["for"]("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol["for"]("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function s(t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _setFunctionName(e, t, n) { "symbol" == _typeof(t) && (t = (t = t.description) ? "[" + t + "]" : ""); try { Object.defineProperty(e, "name", { configurable: !0, value: n ? n + " " + t : t }); } catch (e) {} return e; }
+function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? _typeof(e) : "null")); return e; }
 var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/function () {
   function FcrUIScreenStreamSync(objectManager) {
     var _this = this;
     (0, _classCallCheck2["default"])(this, FcrUIScreenStreamSync);
-    (0, _defineProperty2["default"])(this, "logger", (0, _logger.createLogger)({
+    (0, _defineProperty2["default"])(this, "logger", (_initProto(this), (0, _logger.createLogger)({
       prefix: 'FcrUIScreenStreamSync'
-    }));
+    })));
     // 我的屏幕共享流id
     (0, _defineProperty2["default"])(this, "_myCurrentScreenShareStreamId", null);
     (0, _defineProperty2["default"])(this, "_released", false);
+    (0, _defineProperty2["default"])(this, "_isStopped", false);
     var sharedConfigDataSource = objectManager.getObject(_objectManager.FcrUIObjectKeys.S_SHARED_CONFIG_DATA_SOURCE);
+    this._videoWindowDataSource = objectManager.getObject(_objectManager.FcrUIObjectKeys.S_SHARED_VIDEO_WINDOW_DATA_SOURCE);
     var roomProvider = objectManager.getObject(_objectManager.FcrUIObjectKeys.P_ROOM_PROVIDER);
     var userId = sharedConfigDataSource.creatorConfig.userId;
     this._sharingControl = roomProvider.currentRoomControl.getSharingControl();
@@ -59,7 +105,7 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
   }, {
     key: "checkIfMyScreenShareStreamExists",
     value: function checkIfMyScreenShareStreamExists() {
-      return this._myCurrentScreenShareStreamId;
+      return !!this._myCurrentScreenShareStreamId;
     }
   }, {
     key: "startScreenStream",
@@ -76,23 +122,24 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
               }
               throw new Error("there's already a screen share stream owned by me");
             case 1:
-              _context.prev = 1;
-              _context.next = 2;
+              this._isStopped = false;
+              _context.prev = 2;
+              _context.next = 3;
               return this._sharingControl.startScreenSharing(createConfig, encoderConfig.dimensions);
-            case 2:
+            case 3:
               screenStreamId = _context.sent;
               this._streamControl.setVideoEncoderConfig(screenStreamId, encoderConfig, _type.FcrVideoStreamType.HIGH_STREAM);
-              _context.next = 4;
+              _context.next = 5;
               break;
-            case 3:
-              _context.prev = 3;
-              _t = _context["catch"](1);
-              throw new Error("failed to start screen share stream, error: ".concat(_t));
             case 4:
+              _context.prev = 4;
+              _t = _context["catch"](2);
+              throw new Error("failed to start screen share stream, error: ".concat(_t));
+            case 5:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[1, 3]]);
+        }, _callee, this, [[2, 4]]);
       }));
       function startScreenStream(_x, _x2) {
         return _startScreenStream.apply(this, arguments);
@@ -103,7 +150,7 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
     key: "stopScreenStream",
     value: function () {
       var _stopScreenStream = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-        var _t2;
+        var screenVideoWindowData, screenStream, _t2;
         return _regenerator["default"].wrap(function (_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -114,55 +161,96 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
               this.logger.warn('no screen share stream owned by me, cannot stop screen share stream');
               return _context2.abrupt("return");
             case 1:
+              if (!this._isStopped) {
+                _context2.next = 2;
+                break;
+              }
+              this.logger.warn('the screen share stream is stopped, no need to stop again');
+              return _context2.abrupt("return");
+            case 2:
+              this._isStopped = true;
+              this._myCurrentScreenShareStreamId = null;
+            case 3:
               if (!true) {
-                _context2.next = 9;
+                _context2.next = 12;
                 break;
               }
               if (!this._released) {
-                _context2.next = 2;
+                _context2.next = 4;
                 break;
               }
               return _context2.abrupt("return");
-            case 2:
-              _context2.prev = 2;
-              _context2.next = 3;
-              return this._sharingControl.stop();
-            case 3:
-              return _context2.abrupt("continue", 9);
             case 4:
               _context2.prev = 4;
-              _t2 = _context2["catch"](2);
+              _context2.next = 5;
+              return this._sharingControl.stop();
+            case 5:
+              return _context2.abrupt("continue", 12);
+            case 6:
+              _context2.prev = 6;
+              _t2 = _context2["catch"](4);
               if (!(_t2 instanceof _type.FcrError && _t2.code === 720404300)) {
-                _context2.next = 5;
+                _context2.next = 8;
                 break;
               }
-              this.logger.error("the screen share stream does not exist,");
-              return _context2.abrupt("continue", 9);
-            case 5:
-              this.logger.error("failed to stop screen share stream, error: ".concat(_t2, ", retry in 1000ms"), _t2);
-              _context2.next = 6;
-              return new Promise(function (resolve) {
-                return setTimeout(resolve, 1000);
+              this.logger.error("the screen share stream does not exist");
+
+              /**
+               * TODO: 这里加删除 videoWindowData 的逻辑是因为，如果在屏幕共享时主持人结束了房间，在用户点击确认离开房间前，可以看到窗口上显示 “你正在屏幕共享” 的标识。
+               * TODO: 主持人在结束会议后，在点击确认离开房间前，窗口保留着最后的操作画面应该是正常的情况，那还是否有必要加这段逻辑，或者有更好的处理方式？
+               *
+               * 有 3 种场景会调用到 stopScreenStream。
+               * 1. 用户主动停止屏幕共享
+               * 2. 用户的屏幕共享被其他人抢占
+               * 3. 主持人结束房间
+               *
+               * 场景 2 的流程：
+               * 其他人抢占屏幕共享 > 当前共享用户会收到 FcrStreamControl 的 onStreamsRemoved 事件 > 调用 screenTrack.stop() > SourceMnager.stopScreenCapture
+               * > RtcEngine 发出 onLocalVideoStateChanged 事件 > ... > 这里的 stopScreenStream
+               *
+               * 场景 3 的流程：
+               * 主持人结束房间 > RtcEngine 发出 onLocalVideoStateChanged 事件 > ... > 这里的 stopScreenStream
+               *
+               * 在主持人结束房间的场景下，服务端已经不存在这条流，所以调用 stop 接口会报流不存在的错，所以这里把流对应的 videoWindowData 删除掉。
+               *
+               */
+              screenVideoWindowData = this._videoWindowDataSource.mainList.find(function (stream) {
+                return stream.videoSourceType === _type.FcrVideoSourceType.SCREEN;
               });
-            case 6:
-              _context2.prev = 6;
-              if (this._myCurrentScreenShareStreamId) {
+              if (screenVideoWindowData) {
                 _context2.next = 7;
                 break;
               }
-              return _context2.abrupt("continue", 9);
+              return _context2.abrupt("continue", 12);
             case 7:
-              return _context2.finish(6);
+              screenStream = screenVideoWindowData.getVideoStream();
+              if (screenStream) {
+                this._videoWindowDataSource["delete"](screenStream);
+              }
+              return _context2.abrupt("continue", 12);
             case 8:
-              _context2.next = 1;
-              break;
+              this.logger.error("failed to stop screen share stream, error: ".concat(_t2, ", retry in 1000ms"), _t2);
+              _context2.next = 9;
+              return new Promise(function (resolve) {
+                return setTimeout(resolve, 1000);
+              });
             case 9:
-              this._myCurrentScreenShareStreamId = null;
+              _context2.prev = 9;
+              if (this._myCurrentScreenShareStreamId) {
+                _context2.next = 10;
+                break;
+              }
+              return _context2.abrupt("continue", 12);
             case 10:
+              return _context2.finish(9);
+            case 11:
+              _context2.next = 3;
+              break;
+            case 12:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[2, 4, 6, 8]]);
+        }, _callee2, this, [[4, 6, 9, 11]]);
       }));
       function stopScreenStream() {
         return _stopScreenStream.apply(this, arguments);
@@ -221,4 +309,9 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
       return this._myCurrentScreenShareStreamId !== null;
     }
   }]);
-}();
+}();
+_FcrUIScreenStreamSync = FcrUIScreenStreamSync;
+var _applyDecs$e = _applyDecs(_FcrUIScreenStreamSync, [[_decorator.trace, 2, "checkIfMyScreenShareStreamExists"], [_decorator.trace, 2, "startScreenStream"], [_decorator.trace, 2, "stopScreenStream"], [_decorator.trace, 2, "updateStream"], [_decorator.trace, 2, "isLocalScreenStreamCreated"]], []).e;
+var _applyDecs$e2 = (0, _slicedToArray2["default"])(_applyDecs$e, 1);
+_initProto = _applyDecs$e2[0];
+_applyDecs$e;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fcr-ui-scene",
-  "version": "3.7.7",
+  "version": "3.7.8-rc.1",
   "main": "lib/index.js",
   "repository": "ssh://git@git.agoralab.co/aduc/fcr-ui-scene-desktop.git",
   "author": "agora.io",
@@ -22,13 +22,13 @@
     "@react-spring/web": "^9.7.3",
     "@use-gesture/react": "^10.3.1",
     "agora-electron-sdk": "4.3.2-build.156-rc.1",
-    "agora-foundation": "~3.7.7",
-    "agora-ui-foundation": "~3.7.7",
+    "agora-foundation": "~3.7.8-rc.1",
+    "agora-ui-foundation": "~3.7.8-rc.1",
     "classnames": "^2.5.1",
     "core-js": "^3.33.3",
     "dayjs": "^1.10.4",
     "electron-screenshots": "^0.5.26",
-    "fcr-core": "~3.7.7",
+    "fcr-core": "~3.7.8-rc.1",
     "js-md5": "^0.8.3",
     "jszip": "^3.10.1",
     "lodash": "^4.17.21",
@@ -59,7 +59,7 @@
     "@types/react-dom": "^17.0.11",
     "@types/react-virtualized": "^9.21.30",
     "@types/tinycolor2": "^1.4.6",
-    "agora-toolchain": "~3.7.7",
+    "agora-toolchain": "~3.7.8-rc.1",
     "core-js": "^3.33.3",
     "electron": "22.3.27",
     "husky": "^9.0.11",

package/lib/creator.d.ts

@@ -1,36 +0,0 @@
-import { FcrUISceneCancelCallback, FcrUISceneConfig, FcrUISceneCreatorConfig, FcrUISceneFailureCallback, FcrUISceneSuccessCallback, FcrUISettingConfig, FcrUIWebWidgetConfig } from './type';
-import { FcrUIDefaultScene } from './ui-scene';
-import SettingStore from './modules/setting/store';
-export interface FcrObservableSettingStore {
-    value: SettingStore | null;
-}
-export declare class FcrUISceneCreator {
-    private _config;
-    accessor observableSettingStore: FcrObservableSettingStore;
-    protected logger: import("agora-foundation/lib/logger").Logger;
-    private _userSettingStorageProvider;
-    private _registeredWidgetConfigs;
-    private _released;
-    private _scene;
-    private _microphoneKeepRecording;
-    private _sceneObserver;
-    constructor(_config: FcrUISceneCreatorConfig);
-    private _initProviders;
-    launch(config: FcrUISceneConfig, onCancel: FcrUISceneCancelCallback, onSuccess: FcrUISceneSuccessCallback, onFailure: FcrUISceneFailureCallback, dom: HTMLElement): FcrUIDefaultScene;
-    getSettingConfig(): FcrUISettingConfig;
-    registerWidget(config: FcrUIWebWidgetConfig): void;
-    unregisterWidget(widgetId: string): void;
-    renewUserToken(token: string): void;
-    setParameters(parameters: Record<string, unknown>): void;
-    getVersion(): string;
-    getDependencyVersions(): Record<string, string>;
-    openSetting(): void;
-    closeSetting(): void;
-    private _releaseProviders;
-    release(): void;
-    private _resetScene;
-    private _precheckState;
-    private _filterKeepRecordingValueFromParameters;
-    private _setKeepRecordingValueFromParameters;
-    private _createSettingStore;
-}