fcr-core 3.11.0-rc.1 → 3.11.0-rc.2

package/lib/engine/index.js

@@ -60,6 +60,7 @@ var _parameters = require("../utilities/parameters");
 var _validateParams = _interopRequireDefault(require("../utilities/validate-params"));
 var _infinityRoomControl = require("../room-control/infinity-room-control");
 var _remoteControl = require("../remote-control");
+var _convertRoomType = require("../utilities/convertRoomType");
 let _initProto, _renewUserTokenDecs, _createMainRoomControlDecs, _createInfinityRoomControlDecs, _createWaitingRoomControlDecs, _createRoomRouterDecs, _createRoomControlAndJoinDecs, _sendPeerMessageDecs, _setParametersDecs;
 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 (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 (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (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 (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 + ""; }
@@ -295,7 +296,8 @@ class FcrCoreEngineImpl {
         data,
         ts
       } = res;
-      switch (data.room.roomProperties.roomType) {
+      const fcrRoomType = (0, _convertRoomType.convertServerRoomTypeToFcrRoomType)(data.room.roomProperties.roomType);
+      switch (fcrRoomType) {
         case _type3.FcrRoomType.Waitingroom:
           roomControl = this.createWaitingRoomControl(data.room.roomInfo.roomUuid);
           break;
@@ -306,13 +308,13 @@ class FcrCoreEngineImpl {
           roomControl = this.createMainRoomControl(roomId);
           break;
         default:
-          throw new Error(`Unknown room type: ${data.room.roomProperties.roomType}`);
+          throw new Error(`Unknown room type: ${fcrRoomType}`);
       }
       await roomControl.join({
         ...options,
         snapshot: data,
         timestamp: ts,
-        createStreamConfigs: data.room.roomProperties.roomType === _type3.FcrRoomType.Waitingroom ? [] : options.createStreamConfigs
+        createStreamConfigs: fcrRoomType === _type3.FcrRoomType.Waitingroom ? [] : options.createStreamConfigs
       });
     }, [], {
       retriesMax: 10

package/lib/imports.d.ts

@@ -47,7 +47,7 @@ export type { AgoraRteAudioRawDataConfig, AgoraRteBeautyOptions, AgoraRteCameraP
 export type { AgoraRteMonitor } from 'agora-rte-sdk/lib/core/monitor';
 export type { AgoraRteMediaControl } from 'agora-rte-sdk/lib/core/media/type';
 export type { AgoraRteUpdateStreamPrivilege, AgoraRteMediaStreamInfo, } from 'agora-rte-sdk/lib/core/scene/type';
-export { AgoraRteConnectionState, AgoraRteEngine, convertStreamTypeToPublishState, AgoraRteLatencyLevel, } from 'agora-rte-sdk';
+export { AgoraRteConnectionState, AgoraRteEngine, convertStreamTypeToPublishState, AgoraRteLatencyLevel, AgoraRteVideoOutputOrientationMode, } from 'agora-rte-sdk';
 export { AgoraRteRoomConnectorType, AgoraRteStreamPrivilegeOperation, AgoraRteStreamPrivilegeVideoSourceType, AgoraRteStreamPrivilegeAudioSourceType, AgoraRteMediaStreamType, } from 'agora-rte-sdk/lib/core/scene/type';
 export { AgoraRtcRegion, AgoraRtcVideoSourceType, AgoraRtcAudioSourceType, AgoraRtcMediaSourceState, AgoraRtcRenderMode, AgoraRtcVideoStreamType, AgoraRtcCapability, AgoraRtcAiDenoiseLevel, AgoraRtcAudioOutputRouting, AgoraRtcLatencyLevelType, AgoraRtcEncryptionMode, AgoraRtcDegradationPreference, } from 'agora-rte-sdk/lib/core/rtc/type';
 export { AgoraRteStreamLayer } from 'agora-rte-sdk/lib/type';

package/lib/imports.js

@@ -216,6 +216,12 @@ Object.defineProperty(exports, "AgoraRteVideoOrientation", {
     return _type5.AgoraRteVideoOrientation;
   }
 });
+Object.defineProperty(exports, "AgoraRteVideoOutputOrientationMode", {
+  enumerable: true,
+  get: function () {
+    return _agoraRteSdk.AgoraRteVideoOutputOrientationMode;
+  }
+});
 Object.defineProperty(exports, "AgoraRteVideoSourceType", {
   enumerable: true,
   get: function () {

package/lib/index.d.ts

@@ -5,3 +5,7 @@ export { FcrStreamLatencyLevel, FcrPermissionAction, FcrPrivilegeUserRole, FcrUs
 export { FcrCoreEngineImpl as FcrCoreEngine } from './engine';
 export { FcrCoreEngineConfig } from './struct';
 export { FcrError } from './type';
+export type { AgoraRtcDimensions } from './schema';
+export type { AgoraRteCameraPosition as FcrCameraPosition } from './imports';
+export { FcrDegradationPreference } from './schema';
+export { AgoraRteVideoOutputOrientationMode as FcrVideoOutputOrientationMode } from './imports';

package/lib/index.js

@@ -51,6 +51,12 @@ Object.defineProperty(exports, "FcrCoreEngineConfig", {
     return _struct.FcrCoreEngineConfig;
   }
 });
+Object.defineProperty(exports, "FcrDegradationPreference", {
+  enumerable: true,
+  get: function () {
+    return _schema.FcrDegradationPreference;
+  }
+});
 Object.defineProperty(exports, "FcrDualVideoStreamConfig", {
   enumerable: true,
   get: function () {
@@ -159,6 +165,12 @@ Object.defineProperty(exports, "FcrVideoEncoderConfig", {
     return _type.FcrVideoEncoderConfig;
   }
 });
+Object.defineProperty(exports, "FcrVideoOutputOrientationMode", {
+  enumerable: true,
+  get: function () {
+    return _imports.AgoraRteVideoOutputOrientationMode;
+  }
+});
 Object.defineProperty(exports, "FcrVideoRenderMode", {
   enumerable: true,
   get: function () {
@@ -186,4 +198,5 @@ Object.defineProperty(exports, "registerPlugin", {
 var _imports = require("./imports");
 var _type = require("./type");
 var _engine = require("./engine");
-var _struct = require("./struct");
+var _struct = require("./struct");
+var _schema = require("./schema");

package/lib/peer-session/index.js

@@ -326,6 +326,8 @@ class FcrPeerSessionControlImpl {
       data,
       cmd
     } = payload;
+    const logContext = `cmd=${cmd}, sessionKey=${data.sessionKey}, sessionId=${data.sessionUuid}, ` + `action=${String(data.action)}, senderId=${senderId}, keepAlive=${!!data.keepAlive}`;
+    this.logger.info(`[PeerSession] received peer message: ${logContext}, payload=${JSON.stringify(data.payload ?? {})}`);
     if (cmd === '1001') {
       const session = {
         sessionId: data.sessionUuid,
@@ -358,7 +360,10 @@ class FcrPeerSessionControlImpl {
               ...params,
               action: 1
             });
+            this.logger.info(`[PeerSession] forward peer session accepted to observers: ${logContext}`);
             this._observable.notifyObservers('onPeerSessionAccepted', sessionResponse);
+          } else {
+            this.logger.info(`[PeerSession] ignore peer session accepted without local schedule: ${logContext}`);
           }
           if (this._receivedMap.has(session.sessionId)) {
             this._receivedMap.set(session.sessionId, {
@@ -371,8 +376,10 @@ class FcrPeerSessionControlImpl {
           return;
         } else {
           if (!this._receivedMap.has(session.sessionId)) {
-            this.logger.info(`[PeerSession] received peer session request ${JSON.stringify(session)}`);
+            this.logger.info(`[PeerSession] forward peer session request to observers: ${logContext}`);
             this._observable.notifyObservers('onPeerSessionReceived', session);
+          } else {
+            this.logger.info(`[PeerSession] peer session request already cached, update cache only: ${logContext}`);
           }
           this._receivedMap.set(session.sessionId, {
             ...session,
@@ -381,6 +388,8 @@ class FcrPeerSessionControlImpl {
             action: 0
           });
         }
+      } else {
+        this.logger.info(`[PeerSession] ignore expired peer session message: ${logContext}, ` + `timestamp=${session.timestamp}, duration=${session.duration}`);
       }
     } else if (cmd === '1002') {
       if (data.action === 1) {
@@ -396,9 +405,11 @@ class FcrPeerSessionControlImpl {
             cause: data.payload?.cause ?? {},
             keepAlive: !!data.keepAlive
           };
-          this.logger.info(`[PeerSession] received peer session accepted ${JSON.stringify(sessionResponse)}`);
           this._scheduleMap.delete(data.sessionUuid);
+          this.logger.info(`[PeerSession] forward peer session accepted to observers: ${logContext}`);
           this._observable.notifyObservers('onPeerSessionAccepted', sessionResponse);
+        } else {
+          this.logger.info(`[PeerSession] ignore peer session accepted without local schedule: ${logContext}`);
         }
       } else if (data.action === 2) {
         if (this._scheduleMap.has(data.sessionUuid)) {
@@ -413,11 +424,13 @@ class FcrPeerSessionControlImpl {
             cause: data.payload?.cause ?? {},
             keepAlive: !!data.keepAlive
           };
-          this.logger.info(`[PeerSession] received peer session rejected ${JSON.stringify(sessionResponse)}`);
           if (this._scheduleMap.has(data.sessionUuid)) {
             this._scheduleMap.delete(data.sessionUuid);
+            this.logger.info(`[PeerSession] forward peer session rejected to observers: ${logContext}`);
             this._observable.notifyObservers('onPeerSessionRejected', sessionResponse);
           }
+        } else {
+          this.logger.info(`[PeerSession] ignore peer session rejected without local schedule: ${logContext}`);
         }
       } else if (data.action === 3) {
         const scheduleSession = this._scheduleMap.get(data.sessionUuid);
@@ -429,7 +442,6 @@ class FcrPeerSessionControlImpl {
             fromUserId: senderId,
             cause: data.payload?.cause ?? {}
           };
-          this.logger.info(`[PeerSession] received peer session ended ${JSON.stringify(params)}`);
           if (scheduleSession) {
             this._scheduleMap.delete(data.sessionUuid);
           }
@@ -437,8 +449,15 @@ class FcrPeerSessionControlImpl {
             this._receivedMap.delete(data.sessionUuid);
           }
           this._observable.notifyObservers('onPeerSessionEnded', params.sessionId, params.fromUserId, params.cause);
+          this.logger.info(`[PeerSession] forward peer session ended to observers: ${logContext}`);
+        } else {
+          this.logger.info(`[PeerSession] ignore peer session ended without cached session: ${logContext}`);
         }
+      } else {
+        this.logger.info(`[PeerSession] ignore peer session response with unknown action: ${logContext}`);
       }
+    } else {
+      this.logger.info(`[PeerSession] ignore unsupported peer session cmd: ${logContext}`);
     }
   }
 

package/lib/remote-control/index.js

@@ -78,13 +78,17 @@ class FcrRemoteControlImpl {
       data,
       cmd
     } = payload;
+    const logContext = `cmd=${cmd}, sessionKey=${data.sessionKey}, sessionId=${data.sessionUuid}, ` + `action=${String(data.action)}, senderId=${senderId}, keepAlive=${!!data.keepAlive}`;
     if (data.sessionKey !== this._remoteControlSessionKey) {
+      this.logger.info(`[RemoteControl] ignore peer message because sessionKey does not match remote-control: ${logContext}`);
       return;
     }
     if (cmd === '1001') {
       if (!data.keepAlive) {
+        this.logger.info(`[RemoteControl] ignore remote-control update without keepAlive: ${logContext}`);
         return;
       }
+      this.logger.info(`[RemoteControl] forward update session for handling: ${logContext}`);
       return await this._handleUpdateRemoteControlSession({
         senderId: senderId,
         sessionKey: data.sessionKey,
@@ -97,6 +101,7 @@ class FcrRemoteControlImpl {
         timestamp: message.timestamp
       });
     } else if (cmd === '1002') {
+      this.logger.info(`[RemoteControl] forward delete session for handling: ${logContext}`);
       return await this._handleDeleteRemoteControlSession({
         senderId: senderId,
         sessionKey: data.sessionKey,
@@ -107,6 +112,8 @@ class FcrRemoteControlImpl {
         action: data.action,
         timestamp: message.timestamp
       });
+    } else {
+      this.logger.info(`[RemoteControl] ignore unsupported cmd: ${logContext}`);
     }
   }
   async _handleUpdateRemoteControlSession(data) {

package/lib/room-control/index.js

@@ -45,6 +45,7 @@ var _2 = require("..");
 var _errorHelpers = require("../utilities/error-helpers");
 var _helpers = require("./helpers");
 var _sttControl = require("./stt-control");
+var _widgetControl = require("./widget-control");
 var _applicationControl = require("./application-control");
 let _initProto, _joinDecs, _updateRoomPropertiesDecs, _updateIncrementRoomPropertiesDecs, _deleteRoomPropertiesDecs, _startCloudRecordingDecs, _startLiveStreamingDecs, _updateLiveStreamingLayoutDecs, _sendRoomMessageDecs; // Core SDK imports
 // Service and API imports
@@ -79,6 +80,7 @@ class FcrBaseRoomControlImpl {
   _joinRoomSuccess = false;
   _joining = false;
   _joinState = _helpers.ROOM_CONTROL_CONSTANTS.JOIN_STATE.CANCELED;
+  _isClientRecordingOwner = false;
   _isStartingClientRecording = false;
   constructor(_engine, _scene, _api, _config, _roomType, _chatConnection, _sharedCache, _chatRoomControl) {
     this._engine = _engine;
@@ -117,9 +119,10 @@ class FcrBaseRoomControlImpl {
         // TODO: 确认是否需要限制在主房间
         this._roomType === _type2.FcrRoomType.Mainroom || this._roomType === _type2.FcrRoomType.Infinityroom)) {
           this.logger.info('join scene success, start create sharing control');
-          this.sharingControl = new _sharingControl.FcrSharingControlImpl(this._scene, this._api, this._engine, this._privilegeControl, this._streamControl, this._sharedCache, this._userControl);
+          this.sharingControl = new _sharingControl.FcrSharingControlImpl(this._scene, this._api, this._engine, this._config, this._privilegeControl, this._streamControl, this._sharedCache, this._userControl);
         }
         this._sttControl = new _sttControl.FcrSttControlImpl(this._scene, this._api, this._sharedCache);
+        this._widgetControl = new _widgetControl.FcrWidgetControlImpl(this._scene, this._api, this._sharedCache);
         this._observable.notifyObservers('onJoinRoomSuccess', sceneId);
       },
       // onJoinSceneFailure: (sceneId, error) => {
@@ -257,6 +260,7 @@ class FcrBaseRoomControlImpl {
    */
   _registerClientRecordingObserver() {
     this._engine.getMediaControl().addClientRecordingObserver(this._clientRecordingObserver);
+    this._isClientRecordingOwner = true;
   }
 
   /**
@@ -264,6 +268,7 @@ class FcrBaseRoomControlImpl {
    */
   _unregisterClientRecordingObserver() {
     this._engine.getMediaControl().removeClientRecordingObserver(this._clientRecordingObserver);
+    this._isClientRecordingOwner = false;
   }
 
   /**
@@ -276,6 +281,10 @@ class FcrBaseRoomControlImpl {
     (0, _helpers.validateControllerInitialized)(this._sttControl, _errorHelpers.ControllerType.STT);
     return this._sttControl;
   }
+  getWidgetControl() {
+    (0, _helpers.validateControllerInitialized)(this._widgetControl, _errorHelpers.ControllerType.WIDGET);
+    return this._widgetControl;
+  }
   getApplicationControl() {
     (0, _helpers.validateControllerInitialized)(this._applicationControl, _errorHelpers.ControllerType.APPLICATION);
     return this._applicationControl;
@@ -400,7 +409,6 @@ class FcrBaseRoomControlImpl {
     (0, _helpers.validateRoomJoined)(this._joinRoomSuccess, 'get schedule info');
     const schedule = this._scene.getScenePropertiesByKeyPath('schedule');
     return {
-      ...schedule,
       duration: schedule.duration ?? 0,
       startTime: Math.floor((schedule.startTime ?? 0) / 1000)
     };
@@ -762,17 +770,20 @@ class FcrBaseRoomControlImpl {
   async _cleanup() {
     this._scene.removeObserver(this._sceneObserver);
     this._engine.removeObserver(this._engineObserver);
-    this._unregisterClientRecordingObserver();
 
-    // 停止本地录制和采集，防止会议结束后录制/采集仍在运行，状态泄漏到下一个房间
-    try {
-      const mediaControl = this._engine.getMediaControl();
-      if (mediaControl.isClientRecordingActive()) {
-        await mediaControl.stopClientRecording();
-        this.logger.info('_cleanup: stopped client recording');
+    // 只有注册过录制观察者的 room control 才拥有录制生命周期，
+    // 其他房间（如等候室）的 cleanup 不应停止共享 mediaControl 上的录制。
+    if (this._isClientRecordingOwner) {
+      this._unregisterClientRecordingObserver();
+      try {
+        const mediaControl = this._engine.getMediaControl();
+        if (mediaControl.isClientRecordingActive()) {
+          await mediaControl.stopClientRecording();
+          this.logger.info('_cleanup: stopped client recording');
+        }
+      } catch (e) {
+        this.logger.error(`_cleanup: failed to stop client recording: ${e.message}`);
       }
-    } catch (e) {
-      this.logger.error(`_cleanup: failed to stop client recording: ${e.message}`);
     }
     this._sharedCache.getRoomCache(this._scene.sceneId).clear();
     try {

package/lib/room-control/infinity-room-control/index.js

@@ -60,6 +60,7 @@ class FcrInfinityRoomControlImpl extends _.FcrBaseRoomControlImpl {
     this._interpreterControl = new _interpreterControl.FcrInterpreterControlImpl(api, scene, config, engine, chatConnection, sharedCache);
     this._addLogObserver();
     (0, _boardInitInfoHelper.addBoardInitInfoObserver)(this._scene, this._api, this.logger);
+    this._registerClientRecordingObserver();
     this.logger.info(`initialized, room id: ${this._scene.sceneId}`);
   }
   getAnnouncement() {
@@ -114,13 +115,11 @@ class FcrInfinityRoomControlImpl extends _.FcrBaseRoomControlImpl {
   _onLocalUserPermissionInfoDeleted(roomId, event) {
     if ((0, _utils.hasBoardWritePermission)(event.permissionInfo)) {
       this.logger.info(`remove board write permission`);
-
-      // this.getSharingControl().getBoardControl().getMainWindow()?.setWritable(false);
+      this.getSharingControl().getBoardControl().getMainWindow()?.setWritable(false);
     }
     if ((0, _utils.hasAnnotationWritePermission)(event.permissionInfo)) {
       this.logger.info(`remove annotation write permission`);
-
-      // this.getSharingControl().getAnnotationControl().getMainWindow()?.setWritable(false);
+      this.getSharingControl().getAnnotationControl().getMainWindow()?.setWritable(false);
     }
   }
   _addLogObserver() {

package/lib/room-control/mainroom-control/index.js

@@ -139,13 +139,11 @@ class FcrMainRoomControlImpl extends _.FcrBaseRoomControlImpl {
   _onLocalUserPermissionInfoDeleted(roomId, event) {
     if ((0, _utils2.hasBoardWritePermission)(event.permissionInfo)) {
       this.logger.info(`remove board write permission`);
-
-      // this.getSharingControl().getBoardControl().getMainWindow()?.setWritable(false);
+      this.getSharingControl().getBoardControl().getMainWindow()?.setWritable(false);
     }
     if ((0, _utils2.hasAnnotationWritePermission)(event.permissionInfo)) {
       this.logger.info(`remove annotation write permission`);
-
-      // this.getSharingControl().getAnnotationControl().getMainWindow()?.setWritable(false);
+      this.getSharingControl().getAnnotationControl().getMainWindow()?.setWritable(false);
     }
   }
   _checkIfUpdateAnnotationMainWindow() {

package/lib/room-control/room-control-factory.js

@@ -7,6 +7,7 @@ exports.RoomControlFactory = void 0;
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.map.js");
 var _imports = require("../imports");
+var _convertRoomType = require("../utilities/convertRoomType");
 var _error = require("../utilities/error");
 var _infinityRoomControl = require("./infinity-room-control");
 var _room = require("./interpreter-control/room");
@@ -53,7 +54,10 @@ class RoomControlFactory {
       roomResponse,
       monitorControl
     } = params;
-    const roomType = roomResponse.room.roomProperties.roomType;
+    const roomType = (0, _convertRoomType.convertServerRoomTypeToFcrRoomType)(roomResponse.room.roomProperties.roomType);
+    if (roomType === null) {
+      throw (0, _error.generateFcrCoreClientError)(_imports.ErrorModuleCode.FCR_ROOM, _imports.DetailErrorCode.UNDEFINED_ERROR, `Unsupported room types: ${roomResponse.room.roomProperties.roomType}`);
+    }
     const RoomControlImpl = ROOM_CONTROL_IMPLEMENTATIONS[roomType];
     if (!RoomControlImpl) {
       throw (0, _error.generateFcrCoreClientError)(_imports.ErrorModuleCode.FCR_ROOM, _imports.DetailErrorCode.UNDEFINED_ERROR, `Unsupported room types: ${roomType}`);

package/lib/room-control/sharing-control/index.d.ts

@@ -5,13 +5,14 @@ import { FcrScreenSharingState, FcrSharingControl, FcrSharingObserver, FcrWhiteb
 import { FcrPrivilegeControl } from '../privilege-control/type';
 import { FcrWhiteboardControl } from '../whiteboard-control-v2/whiteboard-control/type';
 import { FcrStreamInfo } from '../../type';
-import { FcrUserControl } from '../..';
+import { FcrCoreEngineConfig, FcrUserControl } from '../..';
 import { FcrSharedCache } from '../shared-cache';
 import { FcrAnnotationControl } from '../whiteboard-control-v2/annotation-control/type';
 export declare class FcrSharingControlImpl implements FcrSharingControl {
     private _scene;
     private _api;
     private _engine;
+    private _config;
     private _privilegeControl;
     private _streamControl;
     private _sharedCache;
@@ -30,7 +31,7 @@ export declare class FcrSharingControlImpl implements FcrSharingControl {
     private _whiteboardObserver;
     get ownerId(): string;
     get ownerStream(): FcrStreamInfo | null;
-    constructor(_scene: AgoraRteScene, _api: FcrCoreServiceApi, _engine: AgoraRteEngine, _privilegeControl: FcrPrivilegeControl, _streamControl: FcrStreamControl, _sharedCache: FcrSharedCache, _userControl: FcrUserControl);
+    constructor(_scene: AgoraRteScene, _api: FcrCoreServiceApi, _engine: AgoraRteEngine, _config: FcrCoreEngineConfig, _privilegeControl: FcrPrivilegeControl, _streamControl: FcrStreamControl, _sharedCache: FcrSharedCache, _userControl: FcrUserControl);
     startScreenSharing(config: FcrScreenStreamCreateConfig, size?: FcrSize, labels?: Map<string, any>): Promise<string>;
     startWhiteboard(): Promise<void>;
     updateScreenSharing(enableAnnotation: boolean): Promise<void>;

package/lib/room-control/sharing-control/index.js

@@ -35,6 +35,8 @@ var _factory2 = require("../whiteboard-control-v2/annotation-control/factory");
 var _type3 = require("../type");
 var _type4 = require("../whiteboard-control/type");
 var _sceneProperties = require("../../utilities/scene-properties");
+var _parameters = require("../../utilities/parameters");
+var _sharedStorage = require("../../utilities/shared-storage");
 let _initProto, _startScreenSharingDecs, _updateScreenSharingDecs;
 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 (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 (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (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 (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 + ""; }
@@ -73,10 +75,11 @@ class FcrSharingControlImpl {
   get ownerStream() {
     return this._shareOwnerStream;
   }
-  constructor(_scene, _api, _engine, _privilegeControl, _streamControl, _sharedCache, _userControl) {
+  constructor(_scene, _api, _engine, _config, _privilegeControl, _streamControl, _sharedCache, _userControl) {
     this._scene = _scene;
     this._api = _api;
     this._engine = _engine;
+    this._config = _config;
     this._privilegeControl = _privilegeControl;
     this._streamControl = _streamControl;
     this._sharedCache = _sharedCache;
@@ -88,6 +91,12 @@ class FcrSharingControlImpl {
     this._streamControl.addObserver(this._streamObserver);
     this._whiteboardControl.addObserver(this._whiteboardObserver);
     this._scene.addObserver(this._sceneObserver);
+    (0, _sharedStorage.clearBoardIpList)();
+    const boardIpList = (0, _parameters.getScribbleForgeIpList)(this._config.parameters);
+    if (boardIpList) {
+      this.logger.info('set board ip list to storage ', boardIpList);
+      (0, _sharedStorage.setBoardIpList)(boardIpList);
+    }
     this.logger.info(`initialized, room id: ${this._scene.sceneId}`);
   }
   async startScreenSharing(config, size, labels) {
@@ -159,6 +168,7 @@ class FcrSharingControlImpl {
         userName,
         roomId: this._scene.sceneId,
         boardRatio: 1,
+        ipList: (0, _parameters.getScribbleForgeIpList)(this._config.parameters),
         size: {
           width: 1280,
           height: 720
@@ -205,7 +215,8 @@ class FcrSharingControlImpl {
         userId,
         userName,
         roomId: this._scene.sceneId,
-        boardRatio: 0
+        boardRatio: 0,
+        ipList: (0, _parameters.getScribbleForgeIpList)(this._config.parameters)
       };
       this._whiteboardControl = factory.createForMainProcess(
       // @ts-ignore

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

@@ -14,6 +14,7 @@ import { FcrSharingControl } from './sharing-control/type';
 import { FcrSttControl } from './stt-control/type';
 import { FcrRoomAnnouncement } from './infinity-room-control/type';
 import { FcrApplicationControl } from './application-control/type';
+import { FcrWidgetControl } from './widget-control/type';
 export interface FcrBaseRoomControl {
     /**
      * Gets the caption control.
@@ -27,6 +28,10 @@ export interface FcrBaseRoomControl {
      * Gets the stream control.
      */
     getStreamControl(): FcrStreamControl;
+    /**
+     * Gets the widget control.
+     */
+    getWidgetControl(): FcrWidgetControl;
     /**
      * Gets the room session control.
      */
@@ -348,12 +353,12 @@ export type FcrJoinBeforeHostWaitingRoomObserver = FcrRoomObserver & {};
 export type FcrMainRoomObserver = FcrRoomObserver & {};
 export type FcrLocalUserWaitingRoomMovedEvent = FcrRoomPropertiesUpdatedEvent;
 export declare enum FcrRoomType {
-    Mainroom = 11,
-    Waitingroom = 102,
-    Subroom = 101,
-    Interpreterroom = 103,
-    JoinBeforeHostWaitingRoom = 104,
-    Infinityroom = 12
+    Mainroom = 0,
+    Subroom = 1,
+    Waitingroom = 2,
+    Interpreterroom = 3,
+    JoinBeforeHostWaitingRoom = 4,
+    Infinityroom = 5
 }
 export declare enum FcrLiveStreamingStateUpdatedReason {
     USERSTOPPED = 1,

package/lib/room-control/type.js

@@ -5,12 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FcrWidgetUuid = exports.FcrWidgetCauseCmd = exports.FcrRoomType = exports.FcrLiveStreamingStateUpdatedReason = exports.FcrLineType = void 0;
 let FcrRoomType = exports.FcrRoomType = /*#__PURE__*/function (FcrRoomType) {
-  FcrRoomType[FcrRoomType["Mainroom"] = 11] = "Mainroom";
-  FcrRoomType[FcrRoomType["Waitingroom"] = 102] = "Waitingroom";
-  FcrRoomType[FcrRoomType["Subroom"] = 101] = "Subroom";
-  FcrRoomType[FcrRoomType["Interpreterroom"] = 103] = "Interpreterroom";
-  FcrRoomType[FcrRoomType["JoinBeforeHostWaitingRoom"] = 104] = "JoinBeforeHostWaitingRoom";
-  FcrRoomType[FcrRoomType["Infinityroom"] = 12] = "Infinityroom";
+  FcrRoomType[FcrRoomType["Mainroom"] = 0] = "Mainroom";
+  FcrRoomType[FcrRoomType["Subroom"] = 1] = "Subroom";
+  FcrRoomType[FcrRoomType["Waitingroom"] = 2] = "Waitingroom";
+  FcrRoomType[FcrRoomType["Interpreterroom"] = 3] = "Interpreterroom";
+  FcrRoomType[FcrRoomType["JoinBeforeHostWaitingRoom"] = 4] = "JoinBeforeHostWaitingRoom";
+  FcrRoomType[FcrRoomType["Infinityroom"] = 5] = "Infinityroom";
   return FcrRoomType;
 }({});
 let FcrLiveStreamingStateUpdatedReason = exports.FcrLiveStreamingStateUpdatedReason = /*#__PURE__*/function (FcrLiveStreamingStateUpdatedReason) {

package/lib/room-control/user-control/index.js

@@ -72,8 +72,8 @@ class FcrUserControlImpl {
       });
       const fcrUserEvents = events.map(e => {
         return {
-          userInfo: e.userInfo && (0, _user.convertRteUserToFcrUser)(e.userInfo, this._roomCache),
-          operatorUser: e.operatorUser && (0, _user.convertRteUserToFcrUser)(e.operatorUser, this._roomCache)
+          userInfo: e.userInfo && (0, _user.convertRteUserToFcrUser)(e.userInfo, this._roomCache)
+          // operatorUser: e.operatorUser && convertRteUserToFcrUser(e.operatorUser, this._roomCache),
         };
       });
       fcrUserEvents.forEach(event => {

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

@@ -170,14 +170,15 @@ class FcrBaseWhiteboardControlImpl {
       });
       const {
         userId,
-        userName
+        userName,
+        ipList
       } = this.config;
       const {
         boardAppId,
         boardId,
         boardRegion,
-        boardToken
-        // boardPerformance = false,
+        boardToken,
+        boardPerformance = false
       } = this.boardRoomConfig || {};
       if (!boardAppId) {
         throw (0, _error.generateFcrCoreClientError)(_imports.ErrorModuleCode.FCR_ROOM_WHITEBOARD, _imports.DetailErrorCode.UNDEFINED_ERROR, 'boardAppId is required');
@@ -200,6 +201,15 @@ class FcrBaseWhiteboardControlImpl {
         whiteboardOption.height = 600;
       }
       this.logger.info(`open board with boardId: ${boardId}, boardToken: ${boardToken}, region: ${boardRegion}, appIdentifier: ${boardAppId} whiteboardOption: ${(0, _imports.jsonstring)(whiteboardOption)}`);
+      let endpoint = undefined;
+      if (ipList !== undefined) {
+        if (Array.isArray(ipList) && ipList[0]) {
+          this.logger.info(`use ipList from config: ${(0, _imports.jsonstring)(ipList)}`);
+          endpoint = ipList[0];
+        } else {
+          this.logger.error(`ipList in config is empty or invalid: ${(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');
@@ -237,10 +247,11 @@ class FcrBaseWhiteboardControlImpl {
             nickName: userName || userId,
             roomToken: boardToken,
             sdkConfig: {
-              region: boardRegion,
+              region: endpoint ? 'private' : boardRegion,
               appIdentifier: boardAppId
             },
-            writable: true
+            writable: isNeedLaunch,
+            endpoint
             // verboseLog: true,
           };
           this.logger.info(`Room.joinRoom calling, params: ${(0, _imports.jsonstring)(joinRoomParams)}, timeout: ${WHITEBOARD_ROOM_JOIN_TIMEOUT}`);
@@ -286,14 +297,11 @@ class FcrBaseWhiteboardControlImpl {
         this.whiteboard = whiteboard;
         this.boardView = boardView;
         this.boardRoom = boardRoom;
-
-        // if (isNeedLaunch) {
-        //   // 所有人开启白板时都默认没有开启写权限, 需要写权限的地方需要自己手动开启
-        //   boardView.internalSetWritable(false);
-        // }
-
-        // boardView.setPerformanceMode(boardPerformance);
-
+        if (isNeedLaunch) {
+          // 所有人开启白板时都默认没有开启写权限, 需要写权限的地方需要自己手动开启
+          boardView.internalSetWritable(false);
+        }
+        boardView.setPerformanceMode(boardPerformance);
         this.updateConnectionState(_type.FcrConnectionState.CONNECTED);
         resolve(boardView);
         if (this._waitPromiseResolve) {

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

@@ -28,6 +28,12 @@ export declare class FcrBoardMainWindowImpl implements FcrBoardMainWindow {
     redo(): Promise<FcrReturnCode>;
     clean(): Promise<FcrReturnCode>;
     getSnapshotImage(): Promise<ImageData>;
+    /**
+     * 设置性能模式状态, enabled 为 true 时开启性能模式, 否则关闭性能模式
+     * 性能模式下, 白板会降低渲染质量及同步频率以提升性能, 适用于低性能设备或需要大量绘制元素的场景
+     * @param enable 是否开启性能模式
+     */
+    setPerformanceMode(enable: boolean): FcrReturnCode;
     setBackgroundColor(color: string): Promise<FcrReturnCode>;
     getPageInfo(): FcrBoardPageInfo;
     prevPage(): Promise<FcrReturnCode>;