@netless/appliance-plugin 1.1.6 → 1.1.7-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -199,7 +199,7 @@ The following interfaces are involved:
199
199
  - 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
200
200
 
201
201
  #### New features
202
- 1. Minimap function
202
+ 1. Minimap function (Version >=1.1.6)
203
203
  ```js
204
204
  /** Create a minimap
205
205
  * @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
@@ -209,7 +209,7 @@ The following interfaces are involved:
209
209
  /** Destroy minimap */
210
210
  destroyMiniMap(viewId: string): Promise<void>;
211
211
  ```
212
- 2. Filter Elements
212
+ 2. Filter Elements (Version >=1.1.6)
213
213
  ```js
214
214
  /** Filter Elements
215
215
  * @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
@@ -226,12 +226,64 @@ The following interfaces are involved:
226
226
  */
227
227
  cancelFilterRender(viewId: string, isSync?:boolean): void;
228
228
  ```
229
- 3. Split screen display Elements (little whiteboard featrue), need to combine '@netless/app-little-white-board'
229
+ 3. Split screen display Elements (little whiteboard featrue), need to combine '@netless/app-little-white-board' (Version >=1.1.3)
230
230
 
231
- 4. laserPen teaching aids
231
+ 4. laserPen teaching aids (Version >=1.1.1)
232
232
  ```js
233
- import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
234
- room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
233
+ import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
234
+ room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
235
+ ```
236
+ 5. Extended Teaching AIDS (Version >=1.1.1)
237
+ ```js
238
+ export enum EStrokeType {
239
+ /** Solid line */
240
+ Normal = 'Normal',
241
+ /** Line with pen edge */
242
+ Stroke = 'Stroke',
243
+ /** Dotted line */
244
+ Dotted = 'Dotted',
245
+ /** Long dotted line */
246
+ LongDotted = 'LongDotted'
247
+ };
248
+ export type ExtendMemberState = {
249
+ /** The teaching AIDS selected by the current user */
250
+ currentApplianceName: ApplianceNames;
251
+ /** Whether to open the pen tip */
252
+ strokeType? : EStrokeType;
253
+ /** Whether to delete the entire line segment */
254
+ isLine? : boolean;
255
+ /** Wireframe transparency */
256
+ strokeOpacity? : number;
257
+ /** Whether to turn on laser pointer */
258
+ useLaserPen? : boolean;
259
+ /** Laser pointer holding time, second */
260
+ duration? : number;
261
+ /** Fill style */
262
+ fillColor? : Color;
263
+ /** Fill transparency */
264
+ fillOpacity? : number;
265
+ /** The specific type of graph to draw when using shape */
266
+ shapeType? : ShapeType;
267
+ /** Number of polygon vertices */
268
+ vertices? :number;
269
+ /** Length of the inner vertex of the polygon */
270
+ innerVerticeStep? :number;
271
+ /** Ratio of the radius of the inner vertex of the polygon to the outer vertex */
272
+ innerRatio? : number;
273
+ /** Text transparency */
274
+ textOpacity? : number;
275
+ /** Text background color */
276
+ textBgColor? : Color;
277
+ /** Text background color transparency */
278
+ textBgOpacity? : number;
279
+ /** Location */
280
+ placement? : SpeechBalloonPlacement;
281
+ };
282
+ import { ExtendMemberState, ApplianceNames } from '@netless/appliance-plugin';
283
+ /** Set the state of teaching AIDS */
284
+ room.setMemberState({ ... } as ExtendMemberState);
285
+ manager.mainView.setMemberState({ ... } as ExtendMemberState);
286
+ appliance.setMemberState({ ... } as ExtendMemberState);
235
287
  ```
236
288
 
237
289
  ### Configure parameters
package/cdn/cdn.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-CIRArL.js",e="/subWorker-C_XI7b.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r="/fullWorker-l-yx2w.js",e="/subWorker-B_WP6U.js";exports.fullWorkerUrl=r;exports.subWorkerUrl=e;