@netless/appliance-plugin 1.1.0 → 1.1.1-7.beta.0

package/README.md

@@ -1,6 +1,6 @@
  # appliance-plugin 
 
- [中文文档](https://github.com/hqer927/appliance-plugin/blob/master/READMA.zh-CN.md)
+ [中文文档](https://github.com/netless-io/fastboard/blob/main/docs/zh/appliance-plugin.md)
  
 The plug-in is attached to the plug-in mechanism of white-web-sdk to achieve a set of whiteboard teaching AIDS, state synchronization, playback, scene switching and other functions still rely on white-web-sdk or window-manager. 
  
@@ -67,13 +67,13 @@ const subWorkerUrl = URL.createObjectURL(subWorkerBlob);
  
 const whiteWebSdk = new WhiteWebSdk(...) 
 const room = await whiteWebSdk.joinRoom({ 
-... 
-invisiblePlugins: [WindowManager, ApplianceMultiPlugin], 
-useMultiViews: true, 
+    ... 
+    invisiblePlugins: [WindowManager, ApplianceMultiPlugin], 
+    useMultiViews: true, 
 }) 
 const manager = await WindowManager.mount({ room , container:elm, chessboard: true, cursor: true, supportAppliancePlugin: true}); 
 if (manager) { 
-await manager.switchMainViewToWriter(); 
+// await manager.switchMainViewToWriter(); 
 await ApplianceMultiPlugin.getInstance(manager,
         {
             options: {
@@ -135,7 +135,11 @@ module: {
 ``` 
  
 ## Call introduction 
+
 ### api introduction
+
+#### Optimize legacy interface
+
 The plugin re-implements some of the interfaces of the same name on room or Windows Manager, but internally we have re-injected them back into the original object via injectMethodToObject. No changes are required for external users. As follows:
 ```js
     // Internal hack
@@ -183,10 +187,104 @@ The following interfaces are involved:
 - `cleanCurrentScene` 
  
 4. Customize 
-- `getBoundingRectAsync` 
-- `screenshotToCanvasAsync` 
-- `scenePreviewAsync` 
-- `destroy`
+- `getBoundingRectAsync` Replace the api room.getBoundingRect
+- `screenshotToCanvasAsync` Replace the api room.screenshotToCanvas
+- `scenePreviewAsync` Replace the api room.scenePreview
+- `destroy` Destroy the instance of appliance-plugin
+- `addListener` add appliance plugin Listener
+- `removeListener` remove appliance plugin Listener
+
+5.Incompatible
+- `exportScene` When the appliance-plugin is enabled, notes cannot be exported in room mode
+- Server-side screenshot, after the appliance-plugin is turned on, notes cannot be obtained by calling server-side screenshot, but need to use `screenshotToCanvasAsync` to obtain the screenshot
+
+#### New features
+1. Minimap function (Version >=1.1.6)
+    ```js
+    /** Create a minimap
+     * @param viewId ID of the whiteboard under windowManager. The ID of the main whiteboard is mainView, and the ID of other whiteboards is the appID of addApp() return
+     * @param div Small map DOM container
+     */
+    createMiniMap(viewId: string, div: HTMLElement): Promise<void>;
+    /** Destroy minimap */
+    destroyMiniMap(viewId: string): Promise<void>;
+    ```
+2. Filter Elements (Version >=1.1.6)
+    ```js
+    /** Filter Elements
+     * @param viewId ID of the whiteboard under windowManager. The ID of the main whiteboard is mainView, and the ID of other whiteboards is the appID of addApp() return
+     * @param filter filter condition
+     *  render: Whether notes can be rendered, [uid1, uid2,...] Or true. true, that is, both render, [uid1, uid2,...] The collection of user Uids rendered for the specified
+     *  hide: Note is hidden, [uid1, uid2,...] Or true. true, that is to hide, [uid1, uid2,...] To specify a hidden user uid collection
+     *  clear: Whether notes can be cleared, [uid1, uid2,...] Or true. true, that is, can be cleared, [uid1, uid2,...] Specifies a collection of user Uids that can be cleared
+     * @param isSync Whether to synchronize data to other users. The default value is true, that is, the data will be synchronized to other users
+     */
+    filterRenderByUid(viewId: string, filter: { render?: _ArrayTrue, hide?: _ArrayTrue, clear?: _ArrayTrue}, isSync?:boolean): void;
+    /** Filter Elements
+     * @param viewId ID of the whiteboard under windowManager. The ID of the main whiteboard is mainView, and the ID of other whiteboards is the appID of addApp() return
+     * @param isSync Whether to synchronize data to other users. The default value is true, that is, the data will be synchronized to other users. Keep it the same as the filterRenderByUid setting
+     */
+    cancelFilterRender(viewId: string, isSync?:boolean): void;
+    ```
+3. Split screen display Elements (little whiteboard featrue), need to combine '@netless/app-little-white-board' (Version >=1.1.3)
+
+4. laserPen teaching aids (Version >=1.1.1)
+    ```js
+    import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
+    room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
+    ```
+5. Extended Teaching AIDS (Version >=1.1.1)
+    ```js
+    export enum EStrokeType { 
+        /** Solid line */ 
+        Normal = 'Normal', 
+        /** Line with pen edge */ 
+        Stroke = 'Stroke', 
+        /** Dotted line */ 
+        Dotted = 'Dotted', 
+        /** Long dotted line */ 
+        LongDotted = 'LongDotted' 
+    };
+    export type ExtendMemberState = {
+        /** The teaching AIDS selected by the current user */ 
+        currentApplianceName: ApplianceNames; 
+        /** Whether to open the pen tip */ 
+        strokeType? : EStrokeType; 
+        /** Whether to delete the entire line segment */ 
+        isLine? : boolean; 
+        /** Wireframe transparency */ 
+        strokeOpacity? : number; 
+        /** Whether to turn on laser pointer */ 
+        useLaserPen? : boolean; 
+        /** Laser pointer holding time, second */ 
+        duration? : number; 
+        /** Fill style */ 
+        fillColor? : Color; 
+        /** Fill transparency */ 
+        fillOpacity? : number; 
+        /** The specific type of graph to draw when using shape */ 
+        shapeType? : ShapeType; 
+        /** Number of polygon vertices */ 
+        vertices? :number; 
+        /** Length of the inner vertex of the polygon */ 
+        innerVerticeStep? :number; 
+        /** Ratio of the radius of the inner vertex of the polygon to the outer vertex */ 
+        innerRatio? : number; 
+        /** Text transparency */ 
+        textOpacity? : number; 
+        /** Text background color */ 
+        textBgColor? : Color; 
+        /** Text background color transparency */ 
+        textBgOpacity? : number; 
+        /** Location */ 
+        placement? : SpeechBalloonPlacement;
+    };
+    import { ExtendMemberState, ApplianceNames } from '@netless/appliance-plugin';
+    /** Set the state of teaching AIDS  */
+    room.setMemberState({ ... } as ExtendMemberState);
+    manager.mainView.setMemberState({ ... } as ExtendMemberState);
+    appliance.setMemberState({ ... } as ExtendMemberState);
+    ```
 
 ### Configure parameters 
 ``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)`` 

package/cdn/cdn.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-CjGKnN.js",e="/subWorker-DUJqv_.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-DXT06v.js",e="/subWorker-caziyz.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;