fcr-core 3.11.0-rc.7 → 3.11.0-rc.9

package/lib/media-control/type.d.ts

@@ -163,6 +163,12 @@ export interface FcrAudioEffectEnhancer {
      * Disables AGC for the audio track.
      */
     disableAGC(): void;
+    /**
+     * Sets the Windows system-level audio preprocessing (hardware 3A) mode.
+     * Only effective on Electron Windows.
+     * @param mode `0` off (default), `1` on, `2` only enabled under speaker routing.
+     */
+    setWindowsSystemAudioPreprocessingMode(mode: number): void;
 }
 export interface FcrVideoEffectEnhancer {
     /**

package/lib/room-control/whiteboard-control-v1/board-window.d.ts

@@ -7,7 +7,7 @@ import { FcrReturnCode } from '../../type';
 import { FcrBoardEraserSize, FcrBoardMainWindow_V1, FcrBoardPage, FcrBoardWindowObserver } from './type';
 import { FcrColor } from '../whiteboard-control/type';
 export declare class FcrBoardMainWindowImpl implements FcrBoardMainWindow_V1 {
-    protected logger: import("agora-foundation/lib/logger/type").Logger;
+    protected logger: import("agora-rte-sdk/lib/imports").Logger;
     private _whiteBoardroom;
     private _whiteView;
     private _windowManager?;

package/lib/room-control/whiteboard-control-v2/annotation-control/control.d.ts

@@ -9,7 +9,7 @@ export declare class FcrAnnotationControlImpl extends FcrBaseWhiteboardControlIm
     protected config: FcrAnnotationConfig;
     private _sceneConfig;
     private _api;
-    protected logger: import("agora-foundation/lib/logger").Logger;
+    protected logger: import("agora-rte-sdk/lib/imports").Logger;
     constructor(rtmClient: RTMClient, config: FcrAnnotationConfig, forgeInitConfigFetcher: () => Promise<FcrBoardRoomConfig>, _sceneConfig: FcrAnnotationSceneConfig, _api: FcrCoreServiceApi);
     syncScreenShareOwnerAnnotationOpenDone(): Promise<number>;
     syncWhiteboardWriteCount(isWritable: boolean): Promise<number>;
@@ -21,7 +21,7 @@ export declare class FcrStandaloneAnnotationControlImpl extends FcrBaseWhiteboar
     protected rtmClient: RTMClient;
     protected config: FcrAnnotationConfig;
     private _sceneConfig;
-    protected logger: import("agora-foundation/lib/logger").Logger;
+    protected logger: import("agora-rte-sdk/lib/imports").Logger;
     constructor(rtmClient: RTMClient, config: FcrAnnotationConfig, forgeInitConfigFetcher: () => Promise<FcrBoardRoomConfig>, _sceneConfig: Omit<FcrAnnotationSceneConfig, 'getBoardPerformance' | 'sceneId'>);
     open(): Promise<FcrBoardMainWindow>;
     protected getApplicationId(): string;

package/lib/room-control/whiteboard-control-v2/base/index.d.ts

@@ -7,6 +7,10 @@ import { FcrConnectionState } from '../../../type';
 import { FcrCoreServiceApi } from '../../../service/api';
 import { FcrBaseWhiteboardControl, FcrBaseWhiteboardObserver, FcrBoardMainWindow, FcrBoardRoomConfig } from '../type';
 import { FcrBoardConfig } from '../whiteboard-control/type';
+type BoardRoomAttempt = {
+    boardRoom: Room;
+    getWhiteboard: () => Promise<Whiteboard>;
+};
 export declare class FcrBaseWhiteboardControlImpl<T extends FcrBaseWhiteboardObserver> implements FcrBaseWhiteboardControl<T> {
     protected rtmClient: RTMClient;
     protected config: FcrBoardConfig;
@@ -34,6 +38,8 @@ export declare class FcrBaseWhiteboardControlImpl<T extends FcrBaseWhiteboardObs
     removeObserver(observer: T): void;
     protected internalOpen(isNeedLaunch: boolean): Promise<FcrBoardMainWindow>;
     protected updateConnectionState(state: FcrConnectionState): void;
+    protected createBoardRoomAttempt(boardId: string, appId: string, whiteboardOption: WhiteboardOption, isNeedLaunch: boolean): BoardRoomAttempt;
+    protected releaseBoardRoomAttempt(boardRoom: Room): Promise<void>;
     protected connect(isNeedLaunch: boolean): Promise<FcrBoardMainWindow>;
     protected getApplicationId(): string;
     protected getWhiteboardOption(): WhiteboardOption;
@@ -42,3 +48,4 @@ export declare class FcrBaseWhiteboardControlImpl<T extends FcrBaseWhiteboardObs
     private _checkForConnect;
     private _clearWaitPromise;
 }
+export {};

package/lib/room-control/whiteboard-control-v2/base/index.js

@@ -161,6 +161,42 @@ class FcrBaseWhiteboardControlImpl {
     this.logger.info("Connection state updated: ".concat(_type.FcrConnectionState[oldState], " -> ").concat(_type.FcrConnectionState[state]));
     this.observable.notifyObservers('onConnectionStateUpdated', state);
   }
+  createBoardRoomAttempt(boardId, appId, whiteboardOption, isNeedLaunch) {
+    const rtmProvider = new _forgeRtm.RTMProvider_2_2(this.rtmClient);
+    const boardRoom = new _forgeRoom.Room(boardId, rtmProvider);
+    this.logger.info('ApplicationManager.registerApplication calling');
+    boardRoom.applicationManager.registerApplication(_forgeWhiteboard.WhiteboardApplication);
+    if (isNeedLaunch) {
+      return {
+        boardRoom,
+        getWhiteboard: () => {
+          this.logger.info("ApplicationManager.launchApplication calling, appId: ".concat(appId, ", option: ").concat((0, _imports.jsonstring)(whiteboardOption)));
+          return boardRoom.applicationManager.launchApplication(_forgeWhiteboard.WhiteboardApplication, whiteboardOption, appId);
+        }
+      };
+    }
+    const launchPromise = new Promise(resolve => {
+      this.logger.info('ApplicationManager.once launch event listening');
+      boardRoom.applicationManager.once('launch', (applicationId, app) => {
+        this.logger.info("ApplicationManager.launch event received, appId: ".concat(applicationId));
+        resolve(app);
+      });
+    });
+    return {
+      boardRoom,
+      getWhiteboard: () => launchPromise
+    };
+  }
+  async releaseBoardRoomAttempt(boardRoom) {
+    try {
+      this.logger.info('ApplicationManager.removeAllListeners calling after a failed board attempt');
+      boardRoom.applicationManager.removeAllListeners();
+      this.logger.info('Room.leaveRoom calling after a failed board attempt');
+      await boardRoom.leaveRoom();
+    } catch (error) {
+      this.logger.error('release failed board room attempt failed', error);
+    }
+  }
   async connect(isNeedLaunch) {
     if (this.boardView) {
       this.logger.info('board already connected, returning existing board view');
@@ -169,8 +205,16 @@ class FcrBaseWhiteboardControlImpl {
     const abortController = new AbortController();
     this._openAbortController = abortController;
     return new Promise(async (resolve, reject) => {
-      // 监听中止信号
+      let activeAttempt = null;
+      const releaseActiveAttempt = async () => {
+        const attempt = activeAttempt;
+        activeAttempt = null;
+        if (attempt) {
+          await this.releaseBoardRoomAttempt(attempt.boardRoom);
+        }
+      };
       abortController.signal.addEventListener('abort', () => {
+        void releaseActiveAttempt();
         reject(new Error('join board aborted'));
       });
       const _this$config = this.config,
@@ -214,38 +258,17 @@ class FcrBaseWhiteboardControlImpl {
           this.logger.error("ipList in config is empty or invalid: ".concat((0, _imports.jsonstring)(ipList), ", ignore ipList config"));
         }
       }
-      const rtmProvider = new _forgeRtm.RTMProvider_2_2(this.rtmClient);
-      const wbRoom = new _forgeRoom.Room(boardId, rtmProvider);
-      this.logger.info('ApplicationManager.registerApplication calling');
-      wbRoom.applicationManager.registerApplication(_forgeWhiteboard.WhiteboardApplication);
       try {
         this.updateConnectionState(_type.FcrConnectionState.CONNECTING);
         let error = null;
         let boardView = null;
         let whiteboard = null;
-        let boardRoom = wbRoom;
+        let boardRoom = null;
         const appId = this.getApplicationId();
-        let getWhiteboard;
-
-        // 第一个开启白板的人需要调用 launch 方法, 其他人监听 launch 事件获取白板实例
-        if (isNeedLaunch) {
-          getWhiteboard = () => {
-            this.logger.info("ApplicationManager.launchApplication calling, appId: ".concat(appId, ", option: ").concat((0, _imports.jsonstring)(whiteboardOption)));
-            return wbRoom.applicationManager.launchApplication(_forgeWhiteboard.WhiteboardApplication, whiteboardOption, appId);
-          };
-        } else {
-          const launchPromise = new Promise((launchPromseResolve, launchPromseReject) => {
-            this.logger.info('ApplicationManager.once launch event listening');
-            wbRoom.applicationManager.once('launch', (appId, app) => {
-              this.logger.info("ApplicationManager.launch event received, appId: ".concat(appId));
-              launchPromseResolve(app);
-            });
-          });
-          getWhiteboard = () => {
-            return launchPromise;
-          };
-        }
         var _await$to = await (0, _imports.to)((0, _imports.retryAttempt)(async () => {
+          await releaseActiveAttempt();
+          const attempt = this.createBoardRoomAttempt(boardId, appId, whiteboardOption, isNeedLaunch);
+          activeAttempt = attempt;
           const joinRoomParams = {
             userId,
             nickName: userName || userId,
@@ -261,9 +284,15 @@ class FcrBaseWhiteboardControlImpl {
           this.logger.info("Room.joinRoom calling, params: ".concat((0, _imports.jsonstring)(joinRoomParams), ", timeout: ").concat(WHITEBOARD_ROOM_JOIN_TIMEOUT));
 
           // 20 秒超时
-          await wbRoom.joinRoom(joinRoomParams, WHITEBOARD_ROOM_JOIN_TIMEOUT);
-          boardRoom = wbRoom;
-          whiteboard = await getWhiteboard();
+          await attempt.boardRoom.joinRoom(joinRoomParams, WHITEBOARD_ROOM_JOIN_TIMEOUT);
+          if (abortController.signal.aborted) {
+            throw new Error('join board aborted');
+          }
+          whiteboard = await attempt.getWhiteboard();
+          if (abortController.signal.aborted) {
+            throw new Error('join board aborted');
+          }
+          boardRoom = attempt.boardRoom;
           if (isNeedLaunch) {
             // 在同一个房间内只有第一次调用 launchApplication 时传入的宽高参数会生效, 后续的调用不会生效, 所以需要在这里更新宽高
             // 只有 launch 的用户需要更新宽、高, 白板会自动同步给后加入的用户
@@ -276,6 +305,7 @@ class FcrBaseWhiteboardControlImpl {
           let error = _ref2.error,
             timeFn = _ref2.timeFn,
             currentRetry = _ref2.currentRetry;
+          await releaseActiveAttempt();
           if (abortController.signal.aborted) {
             throw new Error('join board aborted');
           }
@@ -286,22 +316,31 @@ class FcrBaseWhiteboardControlImpl {
         var _await$to2 = (0, _slicedToArray2.default)(_await$to, 1);
         error = _await$to2[0];
         if (abortController.signal.aborted) {
+          await releaseActiveAttempt();
           throw new Error('join board aborted');
         }
         if (error) {
+          await releaseActiveAttempt();
           this.logger.error("join board failed, ".concat(error.message, "-").concat(JSON.stringify(error)));
           throw error;
         }
+        const connectedBoardRoom = boardRoom;
+        const connectedWhiteboard = whiteboard;
+        if (!connectedBoardRoom || !connectedWhiteboard) {
+          await releaseActiveAttempt();
+          throw new Error('board attempt completed without a room or whiteboard');
+        }
         this.logger.info('Whiteboard camera settings: enableCameraByMouse=false, enableCameraByTouch=false');
-        whiteboard.enableCameraByMouse = false;
-        whiteboard.enableCameraByTouch = false;
+        connectedWhiteboard.enableCameraByMouse = false;
+        connectedWhiteboard.enableCameraByTouch = false;
         this.logger.info('Whiteboard.setViewModeToMain calling');
-        whiteboard.setViewModeToMain();
-        boardView = new _mainWindow.FcrBoardMainWindowImpl(whiteboard, wbRoom, appId, this.config.roomId, this.config.userId, this.api);
+        connectedWhiteboard.setViewModeToMain();
+        boardView = new _mainWindow.FcrBoardMainWindowImpl(connectedWhiteboard, connectedBoardRoom, appId, this.config.roomId, this.config.userId, this.api);
         boardView.setBackgroundColor(this.getBackgroundColor());
-        this.whiteboard = whiteboard;
+        this.whiteboard = connectedWhiteboard;
         this.boardView = boardView;
-        this.boardRoom = boardRoom;
+        this.boardRoom = connectedBoardRoom;
+        activeAttempt = null;
         if (isNeedLaunch) {
           // 所有人开启白板时都默认没有开启写权限, 需要写权限的地方需要自己手动开启
           boardView.internalSetWritable(false);
@@ -314,6 +353,7 @@ class FcrBaseWhiteboardControlImpl {
           this._clearWaitPromise();
         }
       } catch (e) {
+        await releaseActiveAttempt();
         this.logger.error("join board failed");
         this.updateConnectionState(_type.FcrConnectionState.DISCONNECTED);
         reject(e);

package/lib-es/room-control/whiteboard-control-v2/base/index.js

@@ -156,6 +156,42 @@ export class FcrBaseWhiteboardControlImpl {
     this.logger.info("Connection state updated: ".concat(FcrConnectionState[oldState], " -> ").concat(FcrConnectionState[state]));
     this.observable.notifyObservers('onConnectionStateUpdated', state);
   }
+  createBoardRoomAttempt(boardId, appId, whiteboardOption, isNeedLaunch) {
+    const rtmProvider = new RTMProvider_2_2(this.rtmClient);
+    const boardRoom = new Room(boardId, rtmProvider);
+    this.logger.info('ApplicationManager.registerApplication calling');
+    boardRoom.applicationManager.registerApplication(WhiteboardApplication);
+    if (isNeedLaunch) {
+      return {
+        boardRoom,
+        getWhiteboard: () => {
+          this.logger.info("ApplicationManager.launchApplication calling, appId: ".concat(appId, ", option: ").concat(jsonstring(whiteboardOption)));
+          return boardRoom.applicationManager.launchApplication(WhiteboardApplication, whiteboardOption, appId);
+        }
+      };
+    }
+    const launchPromise = new Promise(resolve => {
+      this.logger.info('ApplicationManager.once launch event listening');
+      boardRoom.applicationManager.once('launch', (applicationId, app) => {
+        this.logger.info("ApplicationManager.launch event received, appId: ".concat(applicationId));
+        resolve(app);
+      });
+    });
+    return {
+      boardRoom,
+      getWhiteboard: () => launchPromise
+    };
+  }
+  async releaseBoardRoomAttempt(boardRoom) {
+    try {
+      this.logger.info('ApplicationManager.removeAllListeners calling after a failed board attempt');
+      boardRoom.applicationManager.removeAllListeners();
+      this.logger.info('Room.leaveRoom calling after a failed board attempt');
+      await boardRoom.leaveRoom();
+    } catch (error) {
+      this.logger.error('release failed board room attempt failed', error);
+    }
+  }
   async connect(isNeedLaunch) {
     if (this.boardView) {
       this.logger.info('board already connected, returning existing board view');
@@ -164,8 +200,16 @@ export class FcrBaseWhiteboardControlImpl {
     const abortController = new AbortController();
     this._openAbortController = abortController;
     return new Promise(async (resolve, reject) => {
-      // 监听中止信号
+      let activeAttempt = null;
+      const releaseActiveAttempt = async () => {
+        const attempt = activeAttempt;
+        activeAttempt = null;
+        if (attempt) {
+          await this.releaseBoardRoomAttempt(attempt.boardRoom);
+        }
+      };
       abortController.signal.addEventListener('abort', () => {
+        void releaseActiveAttempt();
         reject(new Error('join board aborted'));
       });
       const _this$config = this.config,
@@ -209,38 +253,17 @@ export class FcrBaseWhiteboardControlImpl {
           this.logger.error("ipList in config is empty or invalid: ".concat(jsonstring(ipList), ", ignore ipList config"));
         }
       }
-      const rtmProvider = new RTMProvider_2_2(this.rtmClient);
-      const wbRoom = new Room(boardId, rtmProvider);
-      this.logger.info('ApplicationManager.registerApplication calling');
-      wbRoom.applicationManager.registerApplication(WhiteboardApplication);
       try {
         this.updateConnectionState(FcrConnectionState.CONNECTING);
         let error = null;
         let boardView = null;
         let whiteboard = null;
-        let boardRoom = wbRoom;
+        let boardRoom = null;
         const appId = this.getApplicationId();
-        let getWhiteboard;
-
-        // 第一个开启白板的人需要调用 launch 方法, 其他人监听 launch 事件获取白板实例
-        if (isNeedLaunch) {
-          getWhiteboard = () => {
-            this.logger.info("ApplicationManager.launchApplication calling, appId: ".concat(appId, ", option: ").concat(jsonstring(whiteboardOption)));
-            return wbRoom.applicationManager.launchApplication(WhiteboardApplication, whiteboardOption, appId);
-          };
-        } else {
-          const launchPromise = new Promise((launchPromseResolve, launchPromseReject) => {
-            this.logger.info('ApplicationManager.once launch event listening');
-            wbRoom.applicationManager.once('launch', (appId, app) => {
-              this.logger.info("ApplicationManager.launch event received, appId: ".concat(appId));
-              launchPromseResolve(app);
-            });
-          });
-          getWhiteboard = () => {
-            return launchPromise;
-          };
-        }
         var _await$to = await to(retryAttempt(async () => {
+          await releaseActiveAttempt();
+          const attempt = this.createBoardRoomAttempt(boardId, appId, whiteboardOption, isNeedLaunch);
+          activeAttempt = attempt;
           const joinRoomParams = {
             userId,
             nickName: userName || userId,
@@ -256,9 +279,15 @@ export class FcrBaseWhiteboardControlImpl {
           this.logger.info("Room.joinRoom calling, params: ".concat(jsonstring(joinRoomParams), ", timeout: ").concat(WHITEBOARD_ROOM_JOIN_TIMEOUT));
 
           // 20 秒超时
-          await wbRoom.joinRoom(joinRoomParams, WHITEBOARD_ROOM_JOIN_TIMEOUT);
-          boardRoom = wbRoom;
-          whiteboard = await getWhiteboard();
+          await attempt.boardRoom.joinRoom(joinRoomParams, WHITEBOARD_ROOM_JOIN_TIMEOUT);
+          if (abortController.signal.aborted) {
+            throw new Error('join board aborted');
+          }
+          whiteboard = await attempt.getWhiteboard();
+          if (abortController.signal.aborted) {
+            throw new Error('join board aborted');
+          }
+          boardRoom = attempt.boardRoom;
           if (isNeedLaunch) {
             // 在同一个房间内只有第一次调用 launchApplication 时传入的宽高参数会生效, 后续的调用不会生效, 所以需要在这里更新宽高
             // 只有 launch 的用户需要更新宽、高, 白板会自动同步给后加入的用户
@@ -271,6 +300,7 @@ export class FcrBaseWhiteboardControlImpl {
           let error = _ref2.error,
             timeFn = _ref2.timeFn,
             currentRetry = _ref2.currentRetry;
+          await releaseActiveAttempt();
           if (abortController.signal.aborted) {
             throw new Error('join board aborted');
           }
@@ -281,22 +311,31 @@ export class FcrBaseWhiteboardControlImpl {
         var _await$to2 = _slicedToArray(_await$to, 1);
         error = _await$to2[0];
         if (abortController.signal.aborted) {
+          await releaseActiveAttempt();
           throw new Error('join board aborted');
         }
         if (error) {
+          await releaseActiveAttempt();
           this.logger.error("join board failed, ".concat(error.message, "-").concat(JSON.stringify(error)));
           throw error;
         }
+        const connectedBoardRoom = boardRoom;
+        const connectedWhiteboard = whiteboard;
+        if (!connectedBoardRoom || !connectedWhiteboard) {
+          await releaseActiveAttempt();
+          throw new Error('board attempt completed without a room or whiteboard');
+        }
         this.logger.info('Whiteboard camera settings: enableCameraByMouse=false, enableCameraByTouch=false');
-        whiteboard.enableCameraByMouse = false;
-        whiteboard.enableCameraByTouch = false;
+        connectedWhiteboard.enableCameraByMouse = false;
+        connectedWhiteboard.enableCameraByTouch = false;
         this.logger.info('Whiteboard.setViewModeToMain calling');
-        whiteboard.setViewModeToMain();
-        boardView = new FcrBoardMainWindowImpl(whiteboard, wbRoom, appId, this.config.roomId, this.config.userId, this.api);
+        connectedWhiteboard.setViewModeToMain();
+        boardView = new FcrBoardMainWindowImpl(connectedWhiteboard, connectedBoardRoom, appId, this.config.roomId, this.config.userId, this.api);
         boardView.setBackgroundColor(this.getBackgroundColor());
-        this.whiteboard = whiteboard;
+        this.whiteboard = connectedWhiteboard;
         this.boardView = boardView;
-        this.boardRoom = boardRoom;
+        this.boardRoom = connectedBoardRoom;
+        activeAttempt = null;
         if (isNeedLaunch) {
           // 所有人开启白板时都默认没有开启写权限, 需要写权限的地方需要自己手动开启
           boardView.internalSetWritable(false);
@@ -309,6 +348,7 @@ export class FcrBaseWhiteboardControlImpl {
           this._clearWaitPromise();
         }
       } catch (e) {
+        await releaseActiveAttempt();
         this.logger.error("join board failed");
         this.updateConnectionState(FcrConnectionState.DISCONNECTED);
         reject(e);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fcr-core",
   "description": "Core APIs for building online scenes",
-  "version": "3.11.0-rc.7",
+  "version": "3.11.0-rc.9",
   "module": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -42,7 +42,7 @@
     "@types/lodash": "^4.14.168",
     "@types/sinon": "^17.0.2",
     "@types/uuid": "^8.3.0",
-    "agora-toolchain": "3.11.0-rc.7",
+    "agora-toolchain": "3.11.0-rc.9",
     "core-js": "^3.33.3",
     "decomment": "^0.9.5",
     "husky": "^9.0.11",
@@ -62,8 +62,8 @@
     "@netless/video-js-plugin": "^0.3.8",
     "@netless/white-snapshot": "^0.4.2",
     "@netless/window-manager": "^1.0.7-beta.6",
-    "agora-foundation": "3.11.0-rc.7",
-    "agora-rte-sdk": "3.11.0-rc.7",
+    "agora-foundation": "3.11.0-rc.9",
+    "agora-rte-sdk": "3.11.0-rc.9",
     "await-to-js": "^3.0.0",
     "dayjs": "^1.10.4",
     "easemob-websdk": "4.13.0",