文档中心
概览
ARBoardKit 是 anyRTC 白板 SDK 的入口类。它为 App 提供了快速搭建白板的 API。
ARBoardKit 包含了以下方法：
| 核心方法 | |
|---|---|
| init | 实例化白板对象 |
| destory | 反序列化白板 |
| 涂鸦相关方法 | |
| clear | 清空当前白板页数据。默认只清除当前白板页的涂鸦，如果 clearBackground 参数为 true，则同时清除涂鸦和背景。 |
| getBrushColor | 获取画笔颜色。 |
| getBrushThin | 获取画笔粗细。 |
| getToolType | 获取画笔类型。 |
| isDrawEnable | 获取白板是否可涂鸦。 |
| getTextColor | 获取设置的文字颜色。 |
| getTextSize | 获取设置的文字大小。 |
| resize | 重新计算白板大小，并渲染。 |
| setBrushColor | 设置画笔颜色。 |
| setBrushThin | 设置画笔粗细。 |
| setToolType | 设置画笔工具类型。 |
| setDrawEnable | 设置白板是否可涂鸦。 |
| setTextColor | 设置的文字颜色。 |
| setTextSize | 设置文字的大小。 |
| 白板页相关方法 | |
| addBoard | 添加一页白板并切换到这一页。 |
| deleteBoard | 删除当前白板页并切换到上一页。 |
| getBoardList | 获取所有文件的白板列表。 |
| getBoardScale | 获取当前白板页缩放比例。 |
| getBoardSnapshot | 获取当前白板页的快照。 |
| getCurrentBoardId | 获取当前白板页 ID。 |
| getCurrentFileId | 获取当前文件 ID。 |
| getFileBoardList | 获取指定文件的白板 ID 列表。 |
| getFileInfo | 获取白板的基本信息。 |
| gotoBoard | 切换到指定的白板页。 |
| nextBoard | 切换到下一页白板。 |
| prevBoard | 切换到上一页白板。 |
| reset | 重置白板。 |
| setBoardScale | 设置当前白板页的缩放大小。 |
| setBoardRatio | 设置白板宽高比例。 |
| getBoardRatio | 获取白板宽高比。 |
| 背景相关方法 | |
| getBackgroundColor | 获取当前白板页的背景颜色。 |
| getGlobalBackgroundColor | 获取全局设置的白板页背景颜色。 |
| setBackgroundColor | 设置当前白板页的背景颜色。 |
| setGlobalBackgroundColor | 全局设置白板页的背景颜色。 |
| setBackgroundImage | 设置当前白板页的背景图片 url。 |
| getBackgroundImage | 获取当前白板页的背景图片 url。 |
| getBackgroundImageFillMode | 获取当前白板页的背景图片显示模式。 |
| 撤销和恢复相关方法 | |
| redo | 画笔重做。 |
| undo | 撤销画笔。 |
| 其它方法 | |
| getVersion | 获取 SDK 版本。 |
init
- (instancetype)initWithAuthParam:(ARBoardAuthParam *)authParam roomId:(NSString *_Nonnull)roomId boardParam:(ARBoardBaseParam *)baseParam delegate:(id<ARBoardDelegate> _Nullable)delegate;
实例化 ARBoardKit 对象
该方法初始化一个 ARBoardKit 对象。使用 ARBoardKit，必须先调用该接口进行初始化。
| 参数 | 描述 |
|---|---|
| authParam | 授权配置，详见ARBoardAuthParam |
| roomId | 房间Id，标识通话频道的字符串，长度在 64 字节以内的字符串。 以下为支持的字符集范围（共 89 个字符）: |
| baseParam | 白板配置项,详见ARBoardBaseParam |
| delegate | 白板事件回调 |
返回值
- ARBoardKit 白板实例对象
- nil ，检测参数是否有误
destrory
- (int)destrory;
反序列化白板
返回值
0方法调用成功，<0方法调用失败
clear
- (void)clear:(BOOL)clearBackground;
清空当前白板页数据
| 参数 | 描述 |
|---|---|
| clearBackground | clearBackground 如果 clearBackground 参数为 true，则同时清除涂鸦和一切背景 |
返回值
0方法调用成功，<0方法调用失败
getBrushColor
- (UIColor *)getBrushColor;
获取画笔颜色
返回值
画笔颜色
getBrushThin
- (UInt32)getBrushThin;
获取画笔粗细
返回值
画笔粗细
getToolType
- (ARBoardToolType)getToolType;
获取画笔类型
返回值
画笔类型
isDrawEnable
- (BOOL)isDrawEnable;
获取白板是否允许涂鸦
返回值
白板涂鸦状态
getTextColor
- (UIColor *)getTextColor;
获取文本颜色
返回值
文本颜色
getTextSize
- (UInt32)getTextSize;
获取文本大小
返回值
文本大小
resize
- (void)resize;
重新计算白板大小，并渲染
setBrushColor
- (void)setBrushColor:(UIColor *)color;
设置的画笔颜色
| 参数 | 描述 |
|---|---|
| color | 画笔颜色 |
返回值
画笔颜色
setBrushThin
- (void)setBrushThin:(UInt32)thin;
设置画笔粗细
| 参数 | 描述 |
|---|---|
| thin | 画笔粗细 |
setToolType
- (void)setToolType:(ARBoardToolType)type;
设置画笔类型
| 参数 | 描述 |
|---|---|
| type | 画笔类型 |
setDrawEnable
- (void)setDrawEnable:(BOOL)enable;
设置白板是否允许涂鸦
| 参数 | 描述 |
|---|---|
| enable | YES可以涂鸦，NO不可以涂鸦 |
setTextColor
- (void)setTextColor:(UIColor *)color;
设置文本颜色
| 参数 | 描述 |
|---|---|
| color | 文本颜色 |
setTextSize
- (void)setTextSize:(UInt32)size;
设置文本大小
| 参数 | 描述 |
|---|---|
| size | 文本大小 |
addBoard
- (void)addBoard;
添加一页白板并切换到这一页
deleteBoard
- (void)deleteBoard;
删除当前白板页并切换到上一页
getBoardList
- (NSArray<NSString *> *)getBoardList;
设置的画笔颜色
返回值
所有的白板页的 ID 列表
getBoardScale
- (UInt32)getBoardScale;
获取当前白板页缩放比例
返回值
白板缩放比例
getBoardSnapshot
- (void)getBoardSnapshot:(void(^ _Nullable)(UIImage *))imageBlock;
获取当前白板页的快照
| 参数 | 描述 |
|---|---|
| imageBlock | 白板快照回调 |
getCurrentBoardId
- (NSString *)getCurrentBoardId;
获取当前白板页 ID
返回值
当前白板页 ID
getCurrentFileId
- (NSString *)getCurrentFileId;
获取当前文件 ID
返回值
当前白板文件 ID
getFileBoardList
- (void)getFileBoardList:(NSString *_Nonnull)fileId WithResult:(void(^)(NSArray<NSString *> * ))result;
获取指定文件的白板 ID 列表
| 参数 | 描述 |
|---|---|
| fileId | 文件 ID |
| result | 指定文件的白板 ID 列表回调 |
getFileInfo
- (void)getFileInfo:(NSString *_Nonnull)fileId WithResult:(void(^)(ARBoardFileInfo *fileInfo))result;
获取白板的基本信息
| 参数 | 描述 |
|---|---|
| fileId | 文件 ID |
| result | 指定文件的文件信息回调 |
gotoBoard
- (void)gotoBoard:(NSString *_Nonnull)boardId;
切换到指定的白板页
| 参数 | 描述 |
|---|---|
| boardId | 要跳转到的白板页 ID |
nextBoard
- (void)nextBoard;
切换到下一页白板
preBoard
- (void)preBoard;
切换到上一页白板
reset
- (void)reset;
重置白板
删除所有白板页和涂鸦
setBoardScale
- (void)setBoardScale:(UInt32)scale;
切换到指定的白板页
| 参数 | 描述 |
|---|---|
| scale | 要设置的白板缩放比例， 100 则为不缩放，范围在 [100 ~ 300] 之间 |
setBoardRatio
- (void)setBoardRatio:(NSString *)ratio;
设置当前白板页宽高比
| 参数 | 描述 |
|---|---|
| ratio | 要设置的白板宽高比。格式如: "4:3"、"16:9" |
getBoardRatio
- (NSString *)getBoardRatio;
返回值
当前白板页宽高比。
getBackgroundColor
- (UIColor *)getBackgroundColor;
获取当前白板页背景色
返回值
当前白板页背景色
getGlobalBackgroundColor
- (UIColor *)getGlobalBackgroundColor;
获取白板全局背景色
返回值
白板全局背景色
setBackgroundColor
- (void)setBackgroundColor:(UIColor *)color;
设置当前白板页背景色
| 参数 | 描述 |
|---|---|
| color | 当前白板背景色 |
setGlobalBackgroundColor
- (void)setGlobalBackgroundColor:(UIColor *)color;
设置所有白板的背景色
| 参数 | 描述 |
|---|---|
| color | 要设置的全局背景色 |
setBackgroundImage
- (void)setBackgroundImage:(NSString *_Nonnull)url fillMode:(ARBoardFillMode)mode;
设置当前白板页的背景图片 url
| 参数 | 描述 |
|---|---|
| url | 背景图片的url 或者 base64 的图片地址，如果是线上的url 请务必允许跨域访问 |
| mode | 显示模式，详见 ARBoardFillMode |
getBackgroundImage
- (NSString *)getBackgroundImage;
获取当前白板页的背景图片 url
返回值
获取当前白板页的背景图片 url
getBackgroundImageFillMode
- (ARBoardFillMode)getBackgroundImageFillMode;
获取当前白板页的背景图片显示模式
返回值
显示模式，详见 ARBoardFillMode
redo
- (void)redo;
重做当前白板页上一次撤销
undo
- (void)undo;
撤销当前白板页上一次动作
getVersion
+ (NSString * _Nonnull)getVersion;
查询 SDK 版本号
返回值
当前的 SDK 版本号，格式为字符串，如 1.0.0