文档中心
anyRTC Web SDK 是通过 HTML 网页加载的 JavaScript 和 Typescript 库。你可以使用 anyRTC Web SDK 在网页浏览器中调用 API 建立连接，控制音视频通话和直播服务。
API 概览
核心方法
| 方法 | 描述 |
|---|---|
| ArWhiteBoard | 构造函数 |
| destroy | 销毁白板 |
涂鸦相关
| 方法 | 描述 |
|---|---|
| clear | 清空当前白板页数据。默认只清除当前白板页的涂鸦，如果 clearBackground 参数为 true，则同时清除涂鸦和背景。 |
| getBrushColor | 获取画笔颜色。 |
| getBrushThin | 获取画笔粗细。 |
| getBrushType | 获取画笔类型。 |
| getEnable | 获取白板是否可涂鸦。 |
| getTextColor | 获取设置的文字颜色。 |
| getTextSize | 获取设置的文字大小。 |
| resize | 重新计算白板大小，并渲染。 |
| setBrushColor | 设置画笔颜色。 |
| setBrushThin | 设置画笔粗细。 |
| setBrushType | 设置画笔工具类型。 |
| setEnable | 设置白板是否可涂鸦。 |
| setTextColor | 设置的文字颜色。 |
| setTextSize | 设置文字的大小。 |
白板页操作接口
| 方法 | 描述 |
|---|---|
| addBoard | 添加一页白板并切换到这一页。 |
| deleteBoard | 删除当前白板页并切换到上一页。 |
| getBoardList | 获取所有文件的白板列表。 |
| getBoardScale | 获取当前白板页缩放比例。 |
| getBoardRatio | 获取当前白板页宽高比例。 |
| getBoardSnapshot | 获取当前白板页的快照。 |
| getCurrentBoardId | 获取当前白板页 ID。 |
| getCurrentFileId | 获取当前文件 ID。 |
| getFileBoardList | 获取指定文件的白板 ID 列表。 |
| getFileInfo | 获取白板的基本信息。 |
| gotoBoard | 切换到指定的白板页。 |
| nextBoard | 切换到下一页白板。 |
| prevBoard | 切换到上一页白板。 |
| reset | 重置白板。 |
| setBoardScale | 设置当前白板页的缩放大小。 |
| setBoardRatio | 设置当前白板页宽高比例。 |
背景相关
| 方法 | 描述 |
|---|---|
| getBackgroundColor | 获取当前白板页的背景颜色。 |
| getGlobalBackgroundColor | 获取全局设置的白板页背景颜色。 |
| setBackgroundColor | 设置当前白板页的背景颜色。 |
| setGlobalBackgroundColor | 全局设置白板页的背景颜色。 |
| getBackgroundImage | 获取当前白板页的背景图片。 |
| getBackgroundImageFillMode | 设置当前白板页的背景图片。 |
| setBackgroundImage | 获取当前白板页背景图片的填充模式。 |
撤销和恢复相关
| 方法 | 描述 |
|---|---|
| redo | 画笔重做。 |
| undo | 撤销画笔。 |
其他
| 方法 | 描述 |
|---|---|
| getVersion | 获取 SDK 版本。 |
引入方式
CDN 引入
unpkg
// 最新版本
<script src="https://unpkg.com/ar-whiteboard"></script>
// 指定版本
<script src="https://unpkg.com/ar-whiteboard@VERSION"></script>
jsdelivr
// 最新版本
<script src="https://cdn.jsdelivr.net/npm/ar-whiteboard"></script>
// 指定版本
<script src="https://cdn.jsdelivr.net/npm/ar-whiteboard@VERSION"></script>
npm 引入
安装
npm install ar-whiteboard -D
项目导入
import ArWhiteBoard from "ar-whiteboard";
const board = new ArWhiteBoard(initParams);
类型模块（适用于 Typescript）
对于 Typescript 开发者，我们提供了 .d.ts 文件导出详细的类型定义。
import ArWhiteBoard, {
BoardToolType,
IArBoardInitBaseParams,
IArBoardInitParams,
IArBoardInitStyleParams,
IArBoardInitAuthParams,
IConfigParameters,
EBoardToolType,
EBoardTextStyle,
EConnectionState,
EBoardErrorCode
} from "ar-whiteboard";
const board = new ArWhiteBoard(initParams);