fcr-ui-scene 3.8.0-alpha → 3.8.1-alpha

package/lib/providers/screen-share/provider.base.js

@@ -87,29 +87,29 @@ var _E = /*#__PURE__*/new WeakMap();
 var _F = /*#__PURE__*/new WeakMap();
 var _G = /*#__PURE__*/new WeakMap();
 _ref = (_enableScreenShareAudioDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _disableScreenShareAudioDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _enableSmoothModeDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _disableSmoothModeDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _enableStereoAudioModeDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _disableStereoAudioModeDecs = [void 0, _decorator.trace, _mobx.action, _mobx.action.bound], _findSharingUserDecs = [_mobx.action, _mobx.action.bound], "logger");
-/**
- * startShare
- *    - callback: share started
- *    - callback: share error occurred
- *    - callback error:
- *        1. cannot publish
- *        2. screen recording permission denied
- *        3. error occurred during screen recording
- *            - remove screen stream, keep screen stream in sync
- * stopShare
- *    - callback: share stopped
- * replaceShare
- *    no callbacks
- * Listen to stream events:
- *  local stream removed
- *    - callback: share stopped
- *
- * Error handle:
- *  1. error occurred during screen recording
- *    - remove screen stream
- * Track events handle:
- *  1. track stopped
- *    - keep screen stream in sync
+/**
+ * startShare
+ *    - callback: share started
+ *    - callback: share error occurred
+ *    - callback error:
+ *        1. cannot publish
+ *        2. screen recording permission denied
+ *        3. error occurred during screen recording
+ *            - remove screen stream, keep screen stream in sync
+ * stopShare
+ *    - callback: share stopped
+ * replaceShare
+ *    no callbacks
+ * Listen to stream events:
+ *  local stream removed
+ *    - callback: share stopped
+ *
+ * Error handle:
+ *  1. error occurred during screen recording
+ *    - remove screen stream
+ * Track events handle:
+ *  1. track stopped
+ *    - keep screen stream in sync
  */
 var FcrUIScreenShareProviderBase = exports.FcrUIScreenShareProviderBase = /*#__PURE__*/function () {
   function FcrUIScreenShareProviderBase(objectManager) {
@@ -122,11 +122,11 @@ var FcrUIScreenShareProviderBase = exports.FcrUIScreenShareProviderBase = /*#__P
     (0, _defineProperty2["default"])(this, "_isScreenShareStarted", false);
     (0, _defineProperty2["default"])(this, "_windowList", []);
     (0, _defineProperty2["default"])(this, "_displayList", []);
-    (0, _defineProperty2["default"])(this, "_selectionIdAndType", null);
     (0, _defineProperty2["default"])(this, "_selectionBounds", null);
     (0, _defineProperty2["default"])(this, "_sharingDisplayBounds", null);
     (0, _defineProperty2["default"])(this, "_closeByOther", false);
     (0, _defineProperty2["default"])(this, "_closeOperator", null);
+    (0, _defineProperty2["default"])(this, "_abortController", null);
     _classPrivateFieldInitSpec(this, _A, _init__isLocalUserScreenSharing(this, false));
     _classPrivateFieldInitSpec(this, _B, _init__isRemoteUserScreenSharing(this, false));
     _classPrivateFieldInitSpec(this, _C, _init__isSharingWithAudio(this, false));
@@ -246,14 +246,6 @@ var FcrUIScreenShareProviderBase = exports.FcrUIScreenShareProviderBase = /*#__P
       }
       throw new Error('cannot get selection bounds while no selection made');
     }
-  }, {
-    key: "selectionIdAndType",
-    get: function get() {
-      if (this._selectionIdAndType) {
-        return this._selectionIdAndType;
-      }
-      throw new Error('can not get selection id and type while no selection made');
-    }
   }, {
     key: "sharingDisplayBounds",
     get: function get() {
@@ -313,9 +305,6 @@ var FcrUIScreenShareProviderBase = exports.FcrUIScreenShareProviderBase = /*#__P
     value: function removeObserver(observer) {
       this.observable.removeObserver(observer);
     }
-  }, {
-    key: "setSelectionIdAndType",
-    value: function setSelectionIdAndType(idAndType) {}
   }, {
     key: "setSelectionBounds",
     value: function setSelectionBounds(bounds) {}
@@ -457,6 +446,10 @@ var FcrUIScreenShareProviderBase = exports.FcrUIScreenShareProviderBase = /*#__P
   }, {
     key: "_stopDeviceCapture",
     value: function _stopDeviceCapture() {
+      if (this._abortController) {
+        this._abortController.abort();
+        this._abortController = null;
+      }
       this.strategy.stopScreenCapture();
       this.strategy.stopLoopbackCapture();
     }

package/lib/providers/screen-share/provider.electron.d.ts

@@ -1,4 +1,3 @@
-import { FcrScreenCaptureType } from 'fcr-core/lib/type';
 import { FcrUIObjectManager } from '../../object-manager';
 import { FcrUIScreenShareProviderBase } from './provider.base';
 import { FcrUIScreenShareStrategy } from './strategy/type';
@@ -15,10 +14,6 @@ export declare class FcrUIScreenShareProviderImpl extends FcrUIScreenShareProvid
     replaceShare({ videoSourceId, captureType }: FcrUIScreenShareReplaceParams): Promise<void>;
     findSharingDisplayBounds(): Electron.Rectangle;
     createStrategy(): FcrUIScreenShareStrategy;
-    setSelectionIdAndType(idAndType: {
-        id: string;
-        type: FcrScreenCaptureType;
-    } | null): void;
     setSelectionBounds(bounds: FcrUI.FcrUIRectangle | null): void;
     changeSelectionBounds(bounds: FcrUI.FcrUIRectangle, reason: FcrUISelectionBoundsChangeReason): void;
     private _getExcludeWindows;

package/lib/providers/screen-share/provider.electron.js

@@ -169,7 +169,7 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
     key: "startShare",
     value: function () {
       var _startShare = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee3(_ref) {
-        var videoSourceId, _ref$captureType, captureType, createConfig, screenTrack, isScreenRecordingGranted, isScreenSharingPermitted, audioSourceId, encoderConfig, excludeWindows, dimensions, frameRate, bitrate, _t, _t2;
+        var videoSourceId, _ref$captureType, captureType, createConfig, screenTrack, isScreenRecordingGranted, isScreenSharingPermitted, audioSourceId, encoderConfig, aborted, abortController, excludeWindows, dimensions, frameRate, bitrate, _t, _t2;
         return _regenerator["default"].wrap(function (_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
@@ -217,7 +217,15 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
               }
               this._sharingDisplayBounds = this.findSharingDisplayBounds();
               this.observable.notifyObservers('onPrepreScreenCapture');
-              encoderConfig = this._getEncoderConfig(); // create screen stream
+              encoderConfig = this._getEncoderConfig();
+              aborted = false;
+              abortController = new AbortController();
+              this._abortController = abortController;
+              abortController.signal.addEventListener('abort', function () {
+                aborted = true;
+              });
+
+              // create screen stream
               _context3.prev = 5;
               _context3.next = 6;
               return this._screenStreamSync.startScreenStream(createConfig, encoderConfig);
@@ -236,7 +244,13 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
             case 9:
               excludeWindows = _context3.sent;
               dimensions = encoderConfig.dimensions, frameRate = encoderConfig.frameRate, bitrate = encoderConfig.bitrate;
-              _context3.next = 10;
+              if (!aborted) {
+                _context3.next = 10;
+                break;
+              }
+              throw new Error(_constant2.ERROR_MESSAGE_ABORTED);
+            case 10:
+              _context3.next = 11;
               return this.strategy.startScreenCapture({
                 sourceId: videoSourceId,
                 captureType: captureType,
@@ -245,11 +259,11 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
                 frameRate: frameRate,
                 bitrate: bitrate
               });
-            case 10:
-              _context3.next = 12;
-              break;
             case 11:
-              _context3.prev = 11;
+              _context3.next = 13;
+              break;
+            case 12:
+              _context3.prev = 12;
               _t2 = _context3["catch"](8);
               if (_t2 instanceof Error && _t2.message === _constant2.ERROR_MESSAGE_ABORTED) {
                 this.observable.notifyObservers('onScreenShareErrorOccurred', _struct.FcrUIScreenShareErrorCode.ABORT_START_SCREEN_CAPTURE);
@@ -257,18 +271,18 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
                 this.observable.notifyObservers('onScreenShareErrorOccurred', _struct.FcrUIScreenShareErrorCode.CANNOT_START_SCREEN_CAPTURE);
               }
               throw new Error("cannot start screen capture, error: ".concat(_t2));
-            case 12:
+            case 13:
               if (!this._isSharingWithAudio) {
-                _context3.next = 13;
+                _context3.next = 14;
                 break;
               }
-              _context3.next = 13;
+              _context3.next = 14;
               return this.strategy.startLoopbackCapture({});
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[5, 7], [8, 11]]);
+        }, _callee3, this, [[5, 7], [8, 12]]);
       }));
       function startShare(_x) {
         return _startShare.apply(this, arguments);
@@ -282,6 +296,10 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
         return _regenerator["default"].wrap(function (_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
+              if (this._abortController) {
+                this._abortController.abort();
+                this._abortController = null;
+              }
               this.strategy.stopScreenCapture();
               this.strategy.stopLoopbackCapture();
               _context4.next = 1;
@@ -383,11 +401,6 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
     value: function createStrategy() {
       return new _electron.FcrUIElectronScreenShareStrategy(this.objectManager);
     }
-  }, {
-    key: "setSelectionIdAndType",
-    value: function setSelectionIdAndType(idAndType) {
-      this._selectionIdAndType = idAndType;
-    }
   }, {
     key: "setSelectionBounds",
     value: function setSelectionBounds(bounds) {
@@ -474,7 +487,7 @@ var FcrUIScreenShareProviderImpl = exports.FcrUIScreenShareProviderImpl = /*#__P
   }]);
 }(_provider.FcrUIScreenShareProviderBase);
 _FcrUIScreenShareProviderImpl = FcrUIScreenShareProviderImpl;
-var _applyDecs$e = _applyDecs(_FcrUIScreenShareProviderImpl, [[_decorator.trace, 2, "getDisplayList"], [_decorator.trace, 2, "getWindowList"], [_decorator.trace, 2, "startShare"], [_decorator.trace, 2, "stopShare"], [_decorator.trace, 2, "replaceShare"], [_decorator.trace, 2, "setSelectionIdAndType"], [[_decorator.trace, _mobx.action], 2, "setSelectionBounds"], [[_decorator.trace, _mobx.action], 2, "changeSelectionBounds"]], [], 0, void 0, _provider.FcrUIScreenShareProviderBase).e;
+var _applyDecs$e = _applyDecs(_FcrUIScreenShareProviderImpl, [[_decorator.trace, 2, "getDisplayList"], [_decorator.trace, 2, "getWindowList"], [_decorator.trace, 2, "startShare"], [_decorator.trace, 2, "stopShare"], [_decorator.trace, 2, "replaceShare"], [[_decorator.trace, _mobx.action], 2, "setSelectionBounds"], [[_decorator.trace, _mobx.action], 2, "changeSelectionBounds"]], [], 0, void 0, _provider.FcrUIScreenShareProviderBase).e;
 var _applyDecs$e2 = (0, _slicedToArray2["default"])(_applyDecs$e, 1);
 _initProto = _applyDecs$e2[0];
 _applyDecs$e;

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

@@ -196,24 +196,24 @@ var FcrUIScreenStreamSync = exports.FcrUIScreenStreamSync = /*#__PURE__*/functio
               }
               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 删除掉。
-               *
+              /**
+               * 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;

package/lib/providers/screen-share/struct.js

@@ -6,61 +6,61 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FcrUISelectionBoundsChangeReason = exports.FcrUIScreenShareStopReason = exports.FcrUIScreenShareErrorCode = exports.FcrUIAudioShareErrorCode = void 0;
 var FcrUIScreenShareErrorCode = exports.FcrUIScreenShareErrorCode = /*#__PURE__*/function (FcrUIScreenShareErrorCode) {
-  /**
-   * 当前已经在共享了，不能开启共享
+  /**
+   * 当前已经在共享了，不能开启共享
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["CONFLICT"] = 1] = "CONFLICT";
-  /**
-   * 无法创建视频流
+  /**
+   * 无法创建视频流
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["CANNOT_CREATE_STREAM"] = 2] = "CANNOT_CREATE_STREAM";
-  /**
-   * 无法更新视频流
+  /**
+   * 无法更新视频流
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["CANNOT_UPDATE_STREAM"] = 3] = "CANNOT_UPDATE_STREAM";
-  /**
-   * 无法开始屏幕采集
+  /**
+   * 无法开始屏幕采集
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["CANNOT_START_SCREEN_CAPTURE"] = 4] = "CANNOT_START_SCREEN_CAPTURE";
-  /**
-   * 用户取消了屏幕采集启动
+  /**
+   * 用户取消了屏幕采集启动
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["ABORT_START_SCREEN_CAPTURE"] = 5] = "ABORT_START_SCREEN_CAPTURE";
-  /**
-   * 无发流权限
+  /**
+   * 无发流权限
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["NO_PUBLISH_PRIVILIGE"] = 6] = "NO_PUBLISH_PRIVILIGE";
-  /**
-   * 无屏幕采集权限
+  /**
+   * 无屏幕采集权限
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["NO_SCREEN_RECORDING_PERMISSION"] = 7] = "NO_SCREEN_RECORDING_PERMISSION";
-  /**
-   * 网络未连接
+  /**
+   * 网络未连接
    */
   FcrUIScreenShareErrorCode[FcrUIScreenShareErrorCode["NETWORK_DISCONNECTED"] = 8] = "NETWORK_DISCONNECTED";
   return FcrUIScreenShareErrorCode;
 }({});
 var FcrUIAudioShareErrorCode = exports.FcrUIAudioShareErrorCode = /*#__PURE__*/function (FcrUIAudioShareErrorCode) {
-  /**
-   * 无法更新音频流
+  /**
+   * 无法更新音频流
    */
   FcrUIAudioShareErrorCode[FcrUIAudioShareErrorCode["CANNOT_UPDATE_STREAM"] = 1] = "CANNOT_UPDATE_STREAM";
   return FcrUIAudioShareErrorCode;
 }({});
 var FcrUIScreenShareStopReason = exports.FcrUIScreenShareStopReason = /*#__PURE__*/function (FcrUIScreenShareStopReason) {
-  /**
-   * 正常停止
+  /**
+   * 正常停止
    */
   FcrUIScreenShareStopReason[FcrUIScreenShareStopReason["NORMAL_STOP"] = 1] = "NORMAL_STOP";
-  /**
-   * 被其他用户停止
+  /**
+   * 被其他用户停止
    */
   FcrUIScreenShareStopReason[FcrUIScreenShareStopReason["STOPPED_BY_OTHER"] = 3] = "STOPPED_BY_OTHER";
   return FcrUIScreenShareStopReason;
 }({});
 var FcrUISelectionBoundsChangeReason = exports.FcrUISelectionBoundsChangeReason = /*#__PURE__*/function (FcrUISelectionBoundsChangeReason) {
-  /**
-   * 插拔显示器导致的窗口采集边界变化
+  /**
+   * 插拔显示器导致的窗口采集边界变化
    */
   FcrUISelectionBoundsChangeReason[FcrUISelectionBoundsChangeReason["DISPLAY_CHANGE"] = 1] = "DISPLAY_CHANGE";
   return FcrUISelectionBoundsChangeReason;

package/lib/providers/screen-share/type.d.ts

@@ -80,14 +80,6 @@ export interface FcrUIScreenShareProvider {
      * @returns 当前选中的共享区域的位置和尺寸信息
      */
     get selectionBounds(): FcrUI.FcrUIRectangle;
-    /**
-     * 获取当前选中的共享源的 id 和 类型
-     * @returns 选中的共享源的 id 和 类型
-     */
-    get selectionIdAndType(): {
-        id: string;
-        type: FcrScreenCaptureType;
-    };
     /**
      * 当前共享源所在的窗口边界信息
      * 例如：
@@ -169,14 +161,6 @@ export interface FcrUIScreenShareProvider {
      * 获取可共享的窗口列表
      */
     getWindowList(): Promise<FcrUIScreenShareWindowInfo[]>;
-    /**
-     *设置选中的共享源的 id 和 类型
-     * @param source
-     */
-    setSelectionIdAndType(idAndType: {
-        id: string;
-        type: FcrScreenCaptureType;
-    } | null): void;
     /**
      * 设置选中的共享源边界信息
      * @param source

package/lib/providers/stt-provider/stt-provider.d.ts

@@ -22,6 +22,7 @@ export declare class FcrUISttProviderImpl implements FcrUISttProvider, FcrUIMana
     private _sentenceMap;
     private _privilegeControl;
     private _interpreterDataSource;
+    private _effectiveTranslateLanguage;
     private _localUserId;
     private _privilegeObserver;
     private _roomControlObserver;
@@ -35,7 +36,6 @@ export declare class FcrUISttProviderImpl implements FcrUISttProvider, FcrUIMana
     private accessor _translateLanguage;
     private accessor _transcribingList;
     private accessor _captionSentence;
-    private accessor _preCaptionSentence;
     private accessor _isCaptionOpening;
     get captionState(): boolean;
     get transcribingState(): boolean;
@@ -49,7 +49,6 @@ export declare class FcrUISttProviderImpl implements FcrUISttProvider, FcrUIMana
     get isCaptionOpening(): boolean;
     get transcribingList(): FcrUISttTranscribingItem[];
     get captionSentence(): FcrUISttSentence | null;
-    get preCaptionSentence(): FcrUISttSentence | null;
     constructor({ sttControl, roomSessionControl, roomControl, localUserId, messageProvider, dialogProvider, sharedSecurityDataSource, privilegeProvider, sharedInterpreterDataSource, }: {
         sttControl: FcrSttControl;
         roomSessionControl: FcrRoomSessionControl;
@@ -64,7 +63,7 @@ export declare class FcrUISttProviderImpl implements FcrUISttProvider, FcrUIMana
     release(): void;
     requestOpenTranscribing(): Promise<string>;
     acceptOpenTranscribing(session: FcrRoomSession): Promise<[void, void]>;
-    rejectOpenTranscribing(session: FcrRoomSession): Promise<[void, string]>;
+    rejectOpenTranscribing(session: FcrRoomSession): Promise<[string]>;
     startCaption(): Promise<void>;
     stopCaption(isCallbackTriggered?: boolean): Promise<void>;
     startTranscribing(): Promise<void>;
@@ -72,12 +71,12 @@ export declare class FcrUISttProviderImpl implements FcrUISttProvider, FcrUIMana
     updateSourceLanguage(language: FcrLanguage): Promise<void>;
     subscribeTranslateLanguage(language: FcrLanguage | null): Promise<void>;
     clearCaptionSentence(): void;
-    clearPreCaptionSentence(): void;
     allowStartTranscribe(enable: boolean): void;
     allowStartCaption(enable: boolean): void;
     allowSetSourceLanguage(enable: boolean): void;
     addObserver(observer: FcrUISttObserver): void;
     removeObserver(observer: FcrUISttObserver): void;
+    private _updateSourceLanguage;
     private _getTranslation;
     private _handleSttEventReceived;
     private _handleSourceLanguageUpdated;