文档中心
概览
ARBoardKit 是 anyRTC 白板 SDK 的入口类。它为 App 提供了快速搭建白板的 API。
ARBoardKit 包含了以下方法：
| 核心方法 | |
|---|---|
| ARBoardKit | 实例化白板对象 |
| getARBoardView | 获取白板View |
| leaveChannel | 离开白板房间 |
| 涂鸦相关方法 | |
| clearDraws | 清除涂鸦 |
| clear | 清除涂鸦，同时清空背景颜色以及背景图片 |
| getBrushColor | 获取画笔颜色 |
| getBrushThin | 获取画笔粗细 |
| getToolType | 获取画笔类型 |
| isDrawEnable | 获取白板是否可涂鸦 |
| getTextColor | 获取设置的文字颜色 |
| getTextSize | 获取设置的文字大小 |
| resize | 重新计算白板大小并渲染 |
| setBrushColor | 设置画笔颜色 |
| setBrushThin | 设置画笔粗细 |
| setToolType | 设置画笔工具类型 |
| setDrawEnable | 设置白板是否可涂鸦 |
| setTextColor | 设置的文字颜色 |
| setTextSize | 设置文字的大小 |
| 白板页相关方法 | |
| addBoard | 添加一页白板并切换到这一页 |
| deleteBoard | 删除当前白板页并切换到上一页 |
| getBoardList | 获取所有文件的白板列表 |
| getBoardScale | 获取当前白板页缩放比例 |
| snapshot | 保存截图 |
| getCurrentBoardId | 获取当前白板页 ID |
| getCurrentFile | 获取当前文件 ID |
| getFileBoardList | 获取指定文件的白板 ID 列表 |
| getFileInfo | 获取白板的基本信息 |
| gotoBoard | 切换到指定的白板页 |
| nextBoard | 切换到下一页白板 |
| prevBoard | 切换到上一页白板 |
| reset | 重置白板 |
| setBoardScale | 设置当前白板页的缩放 |
| setBoardRatio | 设置当前白板页的缩放 |
| getBoardRatio | 设置当前白板页的缩放 |
| 背景相关方法 | |
| getBackgroundColor | 获取当前白板页的背景颜色 |
| getGlobalBackgroundColor | 获取全局设置的白板页背景颜色 |
| setBackgroundColor | 设置当前白板页的背景颜色 |
| setGlobalBackgroundColor | 全局设置白板页的背景颜色 |
| setBackgroundImage | 设置当前白板页背景图片及填充模式 |
| getBackgroundImage | 获取当前白板页背景图片 |
| getBackgroundImageFillMode | 获取当前白板页背景图片的填充模式 |
| 撤销和恢复相关方法 | |
| redo | 重做 |
| undo | 撤销 |
| 其它方法 | |
| getVersion | 获取 SDK 版本 |
ARBoardKit
public ARBoardKit(Context context, ARBoardAuthParam authParam, String roomId, ARBoardBaseParam params, ARBoardHandler handler);
实例化 ARBoardKit 对象
该方法初始化一个 ARBoardKit 对象。使用 ARBoardKit，必须先调用该接口进行初始化。
| 参数 | 描述 |
|---|---|
| context | Activity上下文 |
| ARBoardAuthParam | 授权配置，详见ARBoardAuthParam |
| roomId | 标识通话频道的字符串，长度在 64 字节以内的字符串。 以下为支持的字符集范围（共 89 个字符）: |
| ARBoardBaseParam | 白板配置，详见ARBoardBaseParam |
| handler | 白板事件回调，详见ARBoardHandler |
返回值
- 一个 ARBoardKit 实例对象。
getBoardView
public ARBoardView getARBoardView()
获取白板View
返回值
- 白板View。
leaveChannel
public void leaveChannel()
离开白板房间
clearDraws
public void clearDraws()
清除涂鸦
clear
public void clear()
清除涂鸦，同时清空背景颜色以及背景图片
getBrushColor
public String getBrushColor()
获取画笔颜色
返回值
- 16进制字符串，如：
"#F3F3F3"；格式为ARGB
getBrushThin
public int getBrushThin()
获取画笔粗细
返回值
- 16进制字符串，如：
"#F3F3F3"；格式为ARGB
getToolType
public ARBoardToolType getToolType()
获取画笔类型，详见ARBoardToolType
返回值
- 画笔类型
isDrawEnable
public boolean isDrawEnable()
获取白板是否允许涂鸦
返回值
- 白板涂鸦状态
getTextColor
public String getTextColor()
获取文本颜色
返回值
- 16进制字符串，如：
"#F3F3F3"；格式为ARGB
getTextSize
public int getTextSize()
获取文本大小
返回值
- 文本大小
resize
public void resize()
重新计算白板大小并渲染
setBrushColor
public void setBrushColor(String color)
设置画笔颜色
| 参数 | 描述 |
|---|---|
| color | 16进制字符串，如："#F3F3F3"；格式为ARGB |
返回值
- 画笔颜色
setBrushThin
public void setBrushThin(int thin)
设置画笔粗细
| 参数 | 描述 |
|---|---|
| thin | 画笔粗细 |
setToolType
public void setToolType(ARBoardToolType type)
设置画笔类型，详见ARBoardToolType
| 参数 | 描述 |
|---|---|
| type | 画笔类型 |
setDrawEnable
public void setDrawEnable(boolean enable)
设置白板是否允许涂鸦
| 参数 | 描述 |
|---|---|
| enable | true=可涂鸦，false=不可涂鸦 |
setTextColor
public void setTextColor(String color)
设置文本颜色
| 参数 | 描述 |
|---|---|
| color | 16进制字符串，如："#F3F3F3"；格式为ARGB |
setTextSize
public void setTextSize(int size)
设置文本大小
| 参数 | 描述 |
|---|---|
| size | 文本大小 |
addBoard
public void addBoard()
添加一页白板并切换到这一页
deleteBoard
public void deleteBoard()
删除当前白板页并切换到上一页
getBoardList
public String[] getBoardList()
获取所有文件的白板列表
返回值
- ID 数组
getBoardScale
public int getBoardScale()
获取当前白板页缩放比例
返回值
- 白板缩放比例
snapshot
public void snapshot(String path)
截图并保存到传入的path文件中 需提前创建空文件 需读写权限
| 参数 | 描述 |
|---|---|
| path | 空文件的绝对路径，png |
getCurrentBoardId
public String getCurrentBoard()
获取当前白板页 ID
返回值
- 当前白板页 ID
getCurrentFile
public String getCurrentFile()
获取当前文件 ID
返回值
- 当前白板文件 ID
getFileBoardList
public String[] getFileBoardList(String fileId)
获取指定文件的白板 ID 列表
| 参数 | 描述 |
|---|---|
| fileId | 文件 ID |
返回值
- ID 数组
getFileInfo
public ARBoardFileInfo getFileInfo(String fileId)
获取白板的基本信息
| 参数 | 描述 |
|---|---|
| fileId | 文件 ID |
返回值
- ARBoardFileInfo 对象
gotoBoard
public void gotoBoard(String boardId)
切换到指定的白板页
| 参数 | 描述 |
|---|---|
| boardId | 要跳转到的白板页 ID |
nextBoard
public void nextBoard()
切换到下一页白板
prevBoard
public void prevBoard()
切换到上一页白板
reset
public void reset()
删除所有白板页和涂鸦 如果fileId为#DEFAULT，则仅保留第一页，不保留涂鸦
setBoardScale
public void setBoardScale(int scale)
设置当前白板页的缩放
| 参数 | 描述 |
|---|---|
| scale | 要设置的白板缩放比例，100 为不缩放，范围在 [100 ~ 300] 之间 |
setBoardRatio
public void setBoardRatio(String ratio)
设置当前白板页宽高比例
| 参数 | 描述 |
|---|---|
| ratio | 白板页的宽高比例。例如，设置的横屏比例有：16:9、4:3；竖屏比例有 9:16、3:4 |
getBoardRatio
public String getBoardRatio()
获取当前白板页缩放比例
返回值
- 当前白板页比例的字符串，如：
"4:3";
getBackgroundColor
public String getBackgroundColor()
获取当前白板页背景色
返回值
- 当前白板页背景色字符串，如：
"#F3F3F3"；格式为ARGB
getGlobalBackgroundColor
public String getGlobalBackgroundColor()
获取白板全局背景色
返回值
- 16进制字符串，如：
"#F3F3F3"；格式为ARGB
setBackgroundColor
public void setBackgroundColor(String color)
设置当前白板页背景色
| 参数 | 描述 |
|---|---|
| color | 16进制字符串，如："#F3F3F3"；格式为ARGB |
setGlobalBackgroundColor
public void setGlobalBackgroundColor(String color)
设置所有白板的背景色
| 参数 | 描述 |
|---|---|
| color | 16进制字符串，如："#F3F3F3"；格式为ARGB |
setBackgroundImage
public void setBackgroundImage(String src, ARBoardFillMode fillMode)
设置当前白板页背景图片及填充模式，ARBoardFillMode详见ARBoardFillMode
| 参数 | 描述 |
|---|---|
| src | 图片地址，需要HTTPS协议 |
| fillMode | 填充模式 |
getBackgroundImage
public String getBackgroundImage()
获取当前白板页背景图片
返回值
- 当前白板页背景图片URL
getBackgroundImageFillMode
public ARBoardFillMode getBackgroundImageFillMode()
获取当前白板页背景图片的填充模式，ARBoardFillMode详见ARBoardFillMode
返回值
- 当前白板页背景图片的填充模式
redo
public void redo()
重做当前白板页上一次撤销
undo
public void undo()
撤销当前白板页上一次动作，可撤销涂鸦的形状、画笔、以及形状的移动位置
getVersion
public String getVersion()
查询 SDK 版本号
返回值
- 当前的 SDK 版本号，格式为字符串，如：
"1.0.0"