Skip to content

Commit 2f21daf

Browse files
committed
docs: update appliance-plugin.md
1 parent 5ae6c7d commit 2f21daf

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/en/appliance-plugin.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ The following interfaces are involved:
195195
import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
196196
room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
197197
```
198+
![Image](https://github.com/user-attachments/assets/3cd10c3a-b17b-4c01-b9d4-868c69116d96)
198199
2. Extended Teaching AIDS (Version >=1.1.1)
199200
```js
200201
export enum EStrokeType {
@@ -248,7 +249,7 @@ The following interfaces are involved:
248249
appliance.setMemberState({ ... } as ExtendMemberState);
249250
```
250251
3. Split screen display Elements (little whiteboard featrue), need to combine '@netless/app-little-white-board' (Version >=1.1.3)
251-
252+
![Image](https://github.com/user-attachments/assets/20810ea6-7d85-4e72-b75f-185599fffaf8)
252253
4. Minimap function (Version >=1.1.6)
253254
```js
254255
/** Create a minimap
@@ -259,6 +260,7 @@ The following interfaces are involved:
259260
/** Destroy minimap */
260261
destroyMiniMap(viewId: string): Promise<void>;
261262
```
263+
![Image](https://github.com/user-attachments/assets/8888dc2f-ba66-4807-aa12-16530b3b8a3c)
262264
5. Filter Elements (Version >=1.1.6)
263265
```js
264266
/** Filter Elements
@@ -276,6 +278,7 @@ The following interfaces are involved:
276278
*/
277279
cancelFilterRender(viewId: string, isSync?:boolean): void;
278280
```
281+
![Image](https://github.com/user-attachments/assets/7952ee1d-4f9c-4e86-802a-bac8e4ae6a51)
279282
6. Handwriting graphics automatic association function: 'autoDraw' (version >=1.1.7)
280283
```js
281284
export type AutoDrawOptions = {
@@ -295,6 +298,7 @@ The following interfaces are involved:
295298
});
296299
plugin.usePlugin(autoDrawPlugin);
297300
```
301+
![Image](https://github.com/user-attachments/assets/c388691c-ae72-44ec-bbb7-e92c3a73c9c7)
298302
### Configure parameters
299303
``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)``
300304
- wm: WindowManager\room\player. In multi-window mode, you pass WindowManager, and in single-window mode, you pass room or player(whiteboard playback mode).

docs/zh/appliance-plugin.md

+5
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ module: {
198198
import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
199199
room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
200200
```
201+
![Image](https://github.com/user-attachments/assets/3cd10c3a-b17b-4c01-b9d4-868c69116d96)
201202
2. 扩展教具 (Version >=1.1.1)
202203
```js
203204
export enum EStrokeType {
@@ -251,6 +252,7 @@ module: {
251252
appliance.setMemberState({ ... } as ExtendMemberState);
252253
```
253254
3. 分屏显示笔记(小白板功能),需要结合 `@netless/app-little-white-board` (Version >=1.1.3)
255+
![Image](https://github.com/user-attachments/assets/20810ea6-7d85-4e72-b75f-185599fffaf8)
254256
4. 小地图功能 (Version >=1.1.6)
255257
```js
256258
/** 创建小地图
@@ -261,6 +263,7 @@ module: {
261263
/** 销毁小地图 */
262264
destroyMiniMap(viewId: string): Promise<boolean>;
263265
```
266+
![Image](https://github.com/user-attachments/assets/8888dc2f-ba66-4807-aa12-16530b3b8a3c)
264267
5. 过滤笔记 (Version >=1.1.6)
265268
```js
266269
/** 过滤笔记
@@ -278,6 +281,7 @@ module: {
278281
*/
279282
cancelFilterRender(viewId: string, isSync?:boolean): void;
280283
```
284+
![Image](https://github.com/user-attachments/assets/7952ee1d-4f9c-4e86-802a-bac8e4ae6a51)
281285
6. 手写图形自动联想功能:`autoDraw` (version >=1.1.7)
282286
```js
283287
export type AutoDrawOptions = {
@@ -297,6 +301,7 @@ module: {
297301
});
298302
plugin.usePlugin(autoDrawPlugin);
299303
```
304+
![Image](https://github.com/user-attachments/assets/c388691c-ae72-44ec-bbb7-e92c3a73c9c7)
300305

301306
### 配置参数
302307
``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)``

0 commit comments

Comments
 (0)