fcr-core 3.6.0 → 3.6.2

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

@@ -0,0 +1,31 @@
+import { FcrUserInfo } from '../../type';
+import { FcrScreenStreamCreateConfig, FcrSize } from '../stream-control/type';
+import { FcrAnnotationControl } from '../whiteboard-control-v2/annotation-control/type';
+import { FcrWhiteboardControl } from '../whiteboard-control-v2/whiteboard-control/type';
+import { FcrBoardInactiveReason } from '../whiteboard-control/types';
+export interface FcrSharingControl {
+    startScreenSharing(config: FcrScreenStreamCreateConfig, size?: FcrSize): Promise<string>;
+    startWhiteboard(): Promise<void>;
+    updateScreenSharing(enableAnnotation: boolean): Promise<void>;
+    stop(): Promise<void>;
+    getScreenSharingState(): FcrScreenSharingState;
+    getWhiteboardState(): FcrWhiteboardState;
+    getAnnotationControl(): FcrAnnotationControl | undefined;
+    getBoardControl(): FcrWhiteboardControl;
+    addObserver(observer: FcrSharingObserver): void;
+    removeObserver(observer: FcrSharingObserver): void;
+}
+export interface FcrSharingObserver {
+    onScreenSharingUpdated?: (ownerId: string, state: FcrScreenSharingState) => void;
+    onWhiteboardStarted?: (ownerId: string, operatorUser: FcrUserInfo) => void;
+    onWhiteboardEnded?: (reason: FcrBoardInactiveReason, operatorUser?: FcrUserInfo) => void;
+}
+export declare enum FcrScreenSharingState {
+    END = 0,
+    START_ONLY_SCREEN = 1,
+    START_WHIT_ANNOTATION = 2
+}
+export declare enum FcrWhiteboardState {
+    END = 0,
+    START = 1
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrWhiteboardState = exports.FcrScreenSharingState = void 0;
+let FcrScreenSharingState = exports.FcrScreenSharingState = /*#__PURE__*/function (FcrScreenSharingState) {
+  FcrScreenSharingState[FcrScreenSharingState["END"] = 0] = "END";
+  FcrScreenSharingState[FcrScreenSharingState["START_ONLY_SCREEN"] = 1] = "START_ONLY_SCREEN";
+  FcrScreenSharingState[FcrScreenSharingState["START_WHIT_ANNOTATION"] = 2] = "START_WHIT_ANNOTATION";
+  return FcrScreenSharingState;
+}({});
+let FcrWhiteboardState = exports.FcrWhiteboardState = /*#__PURE__*/function (FcrWhiteboardState) {
+  FcrWhiteboardState[FcrWhiteboardState["END"] = 0] = "END";
+  FcrWhiteboardState[FcrWhiteboardState["START"] = 1] = "START";
+  return FcrWhiteboardState;
+}({});

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

@@ -12,10 +12,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FcrStreamControlImpl = void 0;
 require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.async-iterator.find.js");
 require("core-js/modules/esnext.async-iterator.for-each.js");
 require("core-js/modules/esnext.async-iterator.map.js");
 require("core-js/modules/esnext.async-iterator.some.js");
 require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.find.js");
 require("core-js/modules/esnext.iterator.for-each.js");
 require("core-js/modules/esnext.iterator.map.js");
 require("core-js/modules/esnext.iterator.some.js");
@@ -43,6 +45,7 @@ var _error = require("../../utilities/error");
 var _logger = require("../../utilities/logger");
 var _validateParams = _interopRequireDefault(require("../../utilities/validate-params"));
 var _schema = require("../../schema");
+var _type2 = require("agora-rte-sdk/lib/core/scene/type");
 var _FcrStreamControlImpl;
 let _initProto, _addLocalStreamsDecs, _bindLocalStreamsDecs, _updatePublishPrivilegeOfStreamsDecs, _removeStreamsDecs, _setVideoEncoderConfigDecs, _startRenderRemoteVideoStreamDecs, _stopRenderRemoteVideoStreamDecs, _startPlayRemoteAudioStreamDecs, _stopPlayRemoteAudioStreamDecs, _takeSnapshotDecs, _addLocalScreenStreamDecs, _adjustRemoteAudioStreamVolumeDecs, _mergeAudioStreamDecs, _splitAudioStreamDecs, _ref;
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -52,10 +55,10 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 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; }
-_ref = (_addLocalStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrLocalStreamCreateArrayConfigSchema)], _bindLocalStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrStreamBindConfigArrySchema)], _updatePublishPrivilegeOfStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrUpdateStreamCustomSchema, _schema.fcrUpdateStreamPrivilegeScopeSchema.optional())], _removeStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringArraySchema)], _setVideoEncoderConfigDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.agoraRtcVideoEncoderConfigurationSchema, _schema.fcrVideoStreamTypeSchema)], _startRenderRemoteVideoStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.fcrVideoStreamTypeSchema, _schema.fcrRenderConfigSchema, (0, _schema.createUnionSchema)([_schema.fcrRenderViewSchema, _imports.objectSchema]))], _stopRenderRemoteVideoStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.fcrRenderViewSchema)], _startPlayRemoteAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _stopPlayRemoteAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _takeSnapshotDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.stringSchema)], _addLocalScreenStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrScreenStreamCreateConfigSchema)], _adjustRemoteAudioStreamVolumeDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.numberSchema)], _mergeAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _splitAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], "logger");
 /**
  * @internal
  */
+_ref = (_addLocalStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrLocalStreamCreateArrayConfigSchema)], _bindLocalStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrStreamBindConfigArrySchema)], _updatePublishPrivilegeOfStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrUpdateStreamCustomSchema, _schema.fcrUpdateStreamPrivilegeScopeSchema.optional())], _removeStreamsDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringArraySchema)], _setVideoEncoderConfigDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.agoraRtcVideoEncoderConfigurationSchema, _schema.fcrVideoStreamTypeSchema)], _startRenderRemoteVideoStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.fcrVideoStreamTypeSchema, _schema.fcrRenderConfigSchema, (0, _schema.createUnionSchema)([_schema.fcrRenderViewSchema, _imports.objectSchema]))], _stopRenderRemoteVideoStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.fcrRenderViewSchema)], _startPlayRemoteAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _stopPlayRemoteAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _takeSnapshotDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.stringSchema)], _addLocalScreenStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.fcrScreenStreamCreateConfigSchema, _schema.fcrSizeSchema)], _adjustRemoteAudioStreamVolumeDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema, _schema.numberSchema)], _mergeAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], _splitAudioStreamDecs = [_imports.bound, _imports.trace, (0, _validateParams.default)(_schema.stringSchema)], "logger");
 class FcrStreamControlImpl {
   constructor(_engine, _scene, _api, _sharedCache) {
     //@internal
@@ -160,6 +163,9 @@ class FcrStreamControlImpl {
         connectorType: info.connectorType
       };
     });
+    (0, _defineProperty2.default)(this, "_getPublishStateByPrivilege", privilege => {
+      return privilege === _type2.AgoraRteStreamPrivilegeOperation.HAS_PRIVILEGE ? 1 : privilege === _type2.AgoraRteStreamPrivilegeOperation.NOPRIVILEGE ? 0 : undefined;
+    });
     (0, _defineProperty2.default)(this, "_convertStreamEvent", event => {
       return {
         modifiedStream: this._convertStreamInfo(event.modifiedStream),
@@ -200,6 +206,7 @@ class FcrStreamControlImpl {
     this._sharedCache = _sharedCache;
     this._roomCache = _sharedCache.getRoomCache(this._scene.sceneId);
     const streamList = this._scene.getStreamList();
+    this._mediaControl = this._engine.getMediaControl();
     streamList.forEach(stream => {
       const user = stream.owner;
       const streamInfo = this._convertStreamInfo(stream);
@@ -231,28 +238,69 @@ class FcrStreamControlImpl {
     }
   }
   addLocalStreams(streams) {
-    return (0, _error.handleRequestError)(() => this._scene.localUser.addLocalStreams(streams), _error.FcrErrorModuleCode.ROOM_STREAM, 'add local streams failed');
+    return (0, _error.handleRequestError)(() => this._api.upsertStreamBatch(this._scene.sceneId, streams.map(config => {
+      var _config$generateToken;
+      return _objectSpread({
+        streamName: config.streamName,
+        streamUuid: '0',
+        // means that this stream needs to be created
+        generateToken: (_config$generateToken = config.generateToken) !== null && _config$generateToken !== void 0 ? _config$generateToken : config.videoSourceType === _imports.AgoraRteVideoSourceType.SCREEN,
+        userUuid: config.ownerId,
+        videoSourceType: config.videoSourceType,
+        audioSourceType: config.audioSourceType,
+        videoSourceUuid: config.videoSourceId,
+        audioSourceUuid: config.audioSourceId
+      }, (0, _imports.convertStreamTypeToPublishState)(config.streamType));
+    })), _error.FcrErrorModuleCode.ROOM_STREAM, 'add local streams failed');
   }
   bindLocalStreams(streams) {
-    return (0, _error.handleRequestError)(() => this._scene.localUser.bindLocalStreams(streams), _error.FcrErrorModuleCode.ROOM_STREAM, 'bind local streams failed');
+    return (0, _error.handleRequestError)(() => this._api.upsertStreamBatch(this._scene.sceneId, streams.map(config => ({
+      streamUuid: config.streamId,
+      videoSourceUuid: config.videoSourceId,
+      audioSourceUuid: config.audioSourceId
+    }))), _error.FcrErrorModuleCode.ROOM_STREAM, 'bind local streams failed');
   }
   updatePublishPrivilegeOfStreams() {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
     if (args.length === 1) {
-      return (0, _error.handleRequestError)(() => this._scene.localUser.updatePublishPrivilegeOfStreams(args[0]), _error.FcrErrorModuleCode.ROOM_STREAM, 'update publish privilege of streams failed');
+      const privileges = args[0];
+      return (0, _error.handleRequestError)(() => this._api.upsertStreamBatch(this._scene.sceneId, Object.keys(privileges).map(streamId => ({
+        streamUuid: streamId,
+        audioState: this._getPublishStateByPrivilege(privileges[streamId].audioPrivilege),
+        videoState: this._getPublishStateByPrivilege(privileges[streamId].videoPrivilege)
+      }))), _error.FcrErrorModuleCode.ROOM_STREAM, 'update publish privilege of streams failed');
     } else if (args.length === 2) {
       const [privilege, scope] = args;
       const targetRteRoles = scope.targetRoleType.map(role => _type.FcrUserRoleToStringMap[role]);
-      return (0, _error.handleRequestError)(() => this._scene.localUser.updatePublishPrivilegeOfStreams(privilege, {
-        targetRoleType: targetRteRoles,
-        targetRoleTypeIsInclude: scope.targetRoleTypeIsInclude
+      const includeRoles = [];
+      const excludeRoles = [];
+      const condition = {
+        videoSourceType: scope.videoSourceType,
+        audioSourceType: scope.audioSourceType
+      };
+      if (scope.targetRoleTypeIsInclude) {
+        includeRoles.push(...targetRteRoles);
+      } else {
+        excludeRoles.push(...targetRteRoles);
+      }
+      const audioState = this._getPublishStateByPrivilege(privilege.audioPrivilege);
+      const videoState = this._getPublishStateByPrivilege(privilege.videoPrivilege);
+      return (0, _error.handleRequestError)(() => this._api.updateStreamBatchByCondition({
+        roomUuid: this._scene.sceneId,
+        includeRoles,
+        excludeRoles,
+        videoState,
+        audioState,
+        condition
       }), _error.FcrErrorModuleCode.ROOM_STREAM, 'update publish privilege of streams failed');
     }
   }
   removeStreams(streams) {
-    return (0, _error.handleRequestError)(() => this._scene.localUser.removeStreams(streams), _error.FcrErrorModuleCode.ROOM_STREAM, 'remove streams failed');
+    return (0, _error.handleRequestError)(() => this._api.deleteStreamBatch(this._scene.sceneId, streams.map(streamUuid => ({
+      streamUuid
+    }))), _error.FcrErrorModuleCode.ROOM_STREAM, 'remove streams failed');
   }
   setVideoEncoderConfig(streamId, config, streamType) {
     return this._scene.localUser.setVideoEncoderConfig(config, streamType, streamId);
@@ -279,18 +327,30 @@ class FcrStreamControlImpl {
   takeSnapshot(streamId, filePath) {
     return this._scene.streamPlayer.takeSnapshot(streamId, filePath);
   }
-  async addLocalScreenStream(config) {
+  async addLocalScreenStream(config, size) {
     const res = await (0, _error.handleRequestError)(() => this._api.startShareScreen({
       roomId: this._scene.sceneId,
       userId: this._scene.getLocalUser().getLocalUserId(),
-      config: _objectSpread({
+      config: _objectSpread(_objectSpread({
         videoSourceType: _.FcrVideoSourceType.SCREEN,
         audioSourceType: _.FcrAudioSourceType.LOOPBACK,
         videoSourceState: _.FcrMediaSourceState.CLOSE,
         audioSourceState: _.FcrMediaSourceState.CLOSE,
         videoSourceUuid: config.videoSourceId,
         audioSourceUuid: config.audioSourceId
-      }, (0, _imports.convertStreamTypeToPublishState)(config.streamType))
+      }, (0, _imports.convertStreamTypeToPublishState)(config.streamType)), {}, {
+        annotation: size ? {
+          size: {
+            width: size.width,
+            height: size.height
+          }
+        } : {
+          size: {
+            width: 0,
+            height: 0
+          }
+        }
+      })
     }), _error.FcrErrorModuleCode.ROOM_STREAM, 'add local screen stream failed');
     const {
       data: {
@@ -348,6 +408,15 @@ class FcrStreamControlImpl {
   removeObserver(observer) {
     this._observable.removeObserver(observer);
   }
+  async findSelectionByParamId(paramSourceId) {
+    var _this$_mediaControl, _this$_mediaControl2;
+    const wins = (await ((_this$_mediaControl = this._mediaControl) === null || _this$_mediaControl === void 0 ? void 0 : _this$_mediaControl.getWindowList())) || [];
+    const displays = (await ((_this$_mediaControl2 = this._mediaControl) === null || _this$_mediaControl2 === void 0 ? void 0 : _this$_mediaControl2.getDisplayList())) || [];
+    const findInList = list => list.find(item => item.id === paramSourceId);
+    const winMatch = findInList(wins);
+    const displayMatch = findInList(displays);
+    return winMatch || displayMatch || null;
+  }
   _addLogObserver() {
     this.addObserver((0, _logger.generateLogObserver)(this.logger, [
     // 'onLocalVideoStatsUpdated',

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

@@ -1,7 +1,7 @@
 import { FcrOperateCause, FcrRenderView, FcrStreamInfo, FcrUserInfo, FcrUserRole, FcrVideoEncoderConfig, FcrVideoRenderConfig } from '../../type';
 import { FcrVideoStreamType, FcrStreamPrivilegeOperation, FcrStreamPrivilegeVideoSourceType, FcrStreamPrivilegeAudioSourceType } from '../..';
 import { AgoraRteSnapshotInfo, AgoraRtcLocalVideoStats, AgoraRtcLocalAudioStats, AgoraRtcRemoteVideoStats, AgoraRtcRemoteAudioStats, AgoraRtcDimensions, AgoraRteMediaStreamCreateConfig } from '../../imports';
-import { FcrMediaStreamCreateConfigSchema, FcrStreamBindConfigSchema, FcrScreenStreamCreateConfigSchema } from '../../schema';
+import { FcrMediaStreamCreateConfigSchema, FcrStreamBindConfigSchema, FcrScreenStreamCreateConfigSchema, fcrSizeSchema } from '../../schema';
 export interface FcrStreamControl {
     /**
      * Gets the map of list of streams, indexed by user ID.
@@ -103,7 +103,7 @@ export interface FcrStreamControl {
      * Adds a local screen stream.
      * @param config
      */
-    addLocalScreenStream(config: FcrScreenStreamCreateConfig): Promise<string>;
+    addLocalScreenStream(config: FcrScreenStreamCreateConfig, size?: FcrSize): Promise<string>;
     /**
      * Removes the local screen stream.
      */
@@ -122,6 +122,7 @@ export interface FcrStreamControl {
 export type FcrLocalStreamCreateConfig = FcrMediaStreamCreateConfigSchema;
 export type FcrStreamBindConfig = FcrStreamBindConfigSchema;
 export type FcrScreenStreamCreateConfig = FcrScreenStreamCreateConfigSchema;
+export type FcrSize = fcrSizeSchema;
 export type FcrUpdateStreamPrivilege = {
     videoPrivilege: FcrStreamPrivilegeOperation;
     audioPrivilege: FcrStreamPrivilegeOperation;

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

@@ -8,17 +8,13 @@ import { FcrRoomConnectorControl } from './room-connector-control/type';
 import { FcrRoomSessionControl } from './room-session/type';
 import { FcrStreamControl } from './stream-control/type';
 import { FcrUserControl, FcrUserRole } from './user-control/type';
-import { FcrWhiteboardControl } from './whiteboard-control/types';
 import { FcrAbilityControl } from './ability-control/type';
+import { FcrSharingControl } from './sharing-control/type';
 export interface FcrBaseRoomControl {
     /**
      * Gets the user control.
      */
     getUserControl(): FcrUserControl;
-    /**
-     * Gets the whiteboard control.
-     */
-    getBoardControl(): FcrWhiteboardControl;
     /**
      * Gets the stream control.
      */
@@ -43,6 +39,10 @@ export interface FcrBaseRoomControl {
      * Gets the ability control.
      */
     getAbilityControl(): FcrAbilityControl;
+    /**
+     * Gets the sharing control.
+     */
+    getSharingControl(): FcrSharingControl;
     /**
      * Gets the room ID.
      */

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

@@ -1,7 +1,7 @@
 import { Room } from '@netless/window-manager';
 import '@netless/window-manager/dist/style.css';
 import { FcrBoardToolType } from './enums';
-import { Color, FcrBoardWindowObserver, FcrBoardMainWindow } from './types';
+import { Color, FcrBoardMainWindow, FcrBoardMainWindowObserver } from './types';
 import { FcrPrivilegeControl } from '../privilege-control/type';
 export declare class FcrBoardMainWindowImpl implements FcrBoardMainWindow {
     protected logger: import("agora-foundation/lib/logger").Logger;
@@ -14,9 +14,10 @@ export declare class FcrBoardMainWindowImpl implements FcrBoardMainWindow {
     private _observable;
     private _destroyed;
     constructor(room: Room, privilegeControl: FcrPrivilegeControl);
+    setBoardTransparent(isTransparent: boolean): Promise<void>;
     getSnapshotImage(): Promise<ImageData>;
-    addObserver(observer: FcrBoardWindowObserver): void;
-    removeObserver(observer: FcrBoardWindowObserver): void;
+    addObserver(observer: FcrBoardMainWindowObserver): void;
+    removeObserver(observer: FcrBoardMainWindowObserver): void;
     getContentView(): HTMLElement;
     setContainerSizeRatio(ratio: number): Promise<void>;
     getPageInfo(): {

package/lib/room-control/whiteboard-control/board-window.js

@@ -1,7 +1,6 @@
 "use strict";
 
 require("core-js/modules/es.symbol.description.js");
-require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.array.push.js");
 require("core-js/modules/esnext.async-iterator.filter.js");
 require("core-js/modules/esnext.async-iterator.for-each.js");
@@ -29,6 +28,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.FcrBoardMainWindowImpl = void 0;
+require("core-js/modules/es.error.cause.js");
 require("core-js/modules/es.promise.finally.js");
 require("core-js/modules/esnext.async-iterator.map.js");
 require("core-js/modules/esnext.iterator.map.js");
@@ -69,6 +69,9 @@ class FcrBoardMainWindowImpl {
     this._mount();
     this._addLogObserver();
   }
+  setBoardTransparent(isTransparent) {
+    throw new Error('Method not implemented.');
+  }
   async getSnapshotImage() {
     this._preCheck({
       wm: false

package/lib/room-control/whiteboard-control/types.d.ts

@@ -1,32 +1,15 @@
 import { FcrConnectionState } from '../..';
-import { FcrUserInfo } from '../../type';
 import { FcrBoardRegion, FcrBoardShape, FcrBoardToolType, FcrSharePermissionState } from './enums';
 import { AgoraRteRenderView, FcrImageData, FcrWhiteboardView } from '../../imports';
 import { ColorSchema } from '../../schema';
-export type FcrWhiteboardObserver = {
+export type FcrBaseWhiteboardObserver = {
     /**
      * Callback to receive the connection state change.
      * @param state
      */
     onConnectionStateUpdated?(state: FcrConnectionState): void;
-    /**
-     * Callback to receive the background color of the whiteboard change.
-     * @param info
-     */
-    onBackgroundColorUpdated?(color: string, operatorUser?: FcrUserInfo): void;
-    /**
-     * Callback to receive the whiteboard active event.
-     * @param info
-     */
-    onActive?(ownerId: string, operatorUser: FcrUserInfo): void;
-    /**
-     * Callback to receive the whiteboard inactive event.
-     * @param reason
-     * @param operatorUser
-     */
-    onInactive?(reason: FcrBoardInactiveReason, operatorUser?: FcrUserInfo): void;
 };
-export type FcrBoardWindowObserver = {
+export type FcrBoardMainWindowObserver = {
     /**
      * Callback to receive the page info change.
      * @param info
@@ -119,7 +102,7 @@ export type FcrBoardWindowOptions = SlideOptions & {
 export type FcrBoardRoomOptions = SlideOptions & {
     debug: boolean;
 };
-export interface FcrWhiteboardControl {
+export interface FcrBaseWhiteboardControl {
     /**
      * Opens the whiteboard and creates a main window.
      */
@@ -128,14 +111,6 @@ export interface FcrWhiteboardControl {
      * Closes the whiteboard and releases the main window.
      */
     close(): Promise<void>;
-    /**
-     * Activates the whiteboard.
-     */
-    active(): Promise<void>;
-    /**
-     * Inactivates the whiteboard.
-     */
-    inactive(): Promise<void>;
     /**
      * Gets the connection state of the whiteboard.
      */
@@ -145,38 +120,34 @@ export interface FcrWhiteboardControl {
      */
     getMainWindow(): FcrBoardMainWindow | undefined;
     /**
-     * Gets the active info of the whiteboard.
-     */
-    getBoardActiveInfo(): FcrBoardActiveInfo;
-    /**
-     * Sets the background color of the whiteboard.
-     * @param color
+     * Adds an observer to the whiteboard.
+     * @param observer
      */
-    setBackgroundColor(color: string): Promise<void>;
+    addObserver(observer: FcrBaseWhiteboardObserver): void;
     /**
-     * Gets the background color of the whiteboard.
+     * Removes the observer from the whiteboard.
+     * @param observer
      */
-    getBackgroundColor(): string | undefined;
+    removeObserver(observer: FcrBaseWhiteboardObserver): void;
+}
+export interface FcrBoardMainWindow {
     /**
-     * Gets the whiteboard activity info.
+     * Gets the content view.
      */
-    getActivity(): boolean;
+    getContentView(): FcrWhiteboardView;
     /**
-     * Gets the whiteboard owner ID.
+     * Gets the snapshot image of the whiteboard.
      */
-    getOwnerId(): string;
+    getSnapshotImage(): Promise<FcrImageData>;
     /**
-     * Adds an observer to the whiteboard.
-     * @param observer
+     * Sets the container size ratio.
+     * @param ratio
      */
-    addObserver(observer: FcrWhiteboardObserver): void;
+    setContainerSizeRatio(ratio: number): Promise<void>;
     /**
-     * Removes the observer from the whiteboard.
-     * @param observer
+     * Gets page info.
      */
-    removeObserver(observer: FcrWhiteboardObserver): void;
-}
-export interface FcrBoardMainWindow {
+    getPageInfo(): FcrBoardPageInfo;
     /**
      * Adds a page.
      */
@@ -185,6 +156,14 @@ export interface FcrBoardMainWindow {
      * Removes a page.
      */
     removePage(): Promise<void>;
+    /**
+     * Navigates to the previous page.
+     */
+    prevPage(): Promise<void>;
+    /**
+     * Navigate to the next page.
+     */
+    nextPage(): Promise<void>;
     /**
      * Undoes the operation.
      */
@@ -197,27 +176,6 @@ export interface FcrBoardMainWindow {
      * Cleans the whiteboard.
      */
     clean(): Promise<void>;
-    /**
-     * Gets the snapshot image of the whiteboard.
-     */
-    getSnapshotImage(): Promise<FcrImageData>;
-    /**
-     * Sets the background color of the whiteboard.
-     * @param color
-     */
-    setBackgroundColor(color: string): Promise<void>;
-    /**
-     * Gets page info.
-     */
-    getPageInfo(): FcrBoardPageInfo;
-    /**
-     * Navigates to the previous page.
-     */
-    prevPage(): Promise<void>;
-    /**
-     * Navigate to the next page.
-     */
-    nextPage(): Promise<void>;
     /**
      * Sets the tool type.
      * @param type
@@ -243,6 +201,15 @@ export interface FcrBoardMainWindow {
      * @param textSize
      */
     setTextSize(textSize: number): Promise<void>;
+    /**
+     * Sets the background color of the whiteboard.
+     * @param color
+     */
+    setBackgroundColor(color: string): Promise<void>;
+    /**
+     * Sets the board background to transparent.
+     */
+    setBoardTransparent(isTransparent: boolean): Promise<void>;
     /**
      * Inserts an image.
      * @param resourceUrl
@@ -265,12 +232,12 @@ export interface FcrBoardMainWindow {
      * Adds an observer to the main window.
      * @param observer
      */
-    addObserver(observer: FcrBoardWindowObserver): void;
+    addObserver(observer: FcrBoardMainWindowObserver): void;
     /**
      * Removes the observer from the main window.
      * @param observer
      */
-    removeObserver(observer: FcrBoardWindowObserver): void;
+    removeObserver(observer: FcrBoardMainWindowObserver): void;
 }
 export type FcrBoardInfo = {
     state: FcrSharePermissionState;

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

@@ -0,0 +1,33 @@
+import { AgoraRteScene } from 'agora-rte-sdk';
+import { FcrPrivilegeControl } from '../../privilege-control/type';
+import { FcrBoardMainWindow } from '../../whiteboard-control/types';
+import { FcrAnnotationControl } from './type';
+import { AgoraRteEngine } from 'agora-rte-sdk/lib/imports';
+import { FcrConnectionState } from '../../..';
+import { FcrWhiteboardObserver } from '../whiteboard-control/type';
+import { FcrCoreServiceApi } from '../../../service/api';
+import { FcrSharedCache } from '../../shared-cache';
+export declare class FcrAnnotationControlImpl implements FcrAnnotationControl {
+    private _scene;
+    private _api;
+    private _engine;
+    private _privilegeControl;
+    private _sharedCache;
+    protected logger: import("agora-rte-sdk/lib/imports").Logger;
+    private _FCR_ANNOTATION_APP_ID;
+    private _boardView;
+    private _boardRoom;
+    private _observable;
+    private _connectState;
+    private _joined;
+    constructor(_scene: AgoraRteScene, _api: FcrCoreServiceApi, _engine: AgoraRteEngine, _privilegeControl: FcrPrivilegeControl, _sharedCache: FcrSharedCache);
+    open(): Promise<FcrBoardMainWindow>;
+    close(): Promise<void>;
+    getConnectionState(): FcrConnectionState;
+    getMainWindow(): FcrBoardMainWindow | undefined;
+    addObserver(observer: FcrWhiteboardObserver): void;
+    removeObserver(observer: FcrWhiteboardObserver): void;
+    private _getBoardConfigInfoWithScene;
+    private _updateConnnectionState;
+    private _addLogObserver;
+}