API参考
void createWhiteBoard(int width, int height, int pageCount, PageMode pageMode, String exInfo)
- 功能 : 创建白板
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| width | int | 宽度 |
| height | int | 高度 |
| pageCount | int | 页数 |
| pageMode | PageMode | 连页/单页 |
| exInfo | String | 额外信息 |
void notifyCreateBoard(BoardInfo desc, String opId)
- 功能 : 通知白板创建
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| desc | BoardInfo | 白板信息 |
| opId | String | 操作者ID |
void closeBoard(String wID)
- 功能 : 关闭白板
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
void notifyCloseBoard(String wID, String opId)
- 功能 : 关闭白板通知
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| opId | String | 操作者ID |
ArrayList<BoardInfo> getAllBoard()
- 功能 : 获取所有白板
- 返回值 : 所有白板
void updateBoardExInfo(String wId, String exInfo)
- 功能 : 更新白板的扩展信息
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| exInfo | String | 扩展信息 |
void notifyBoardExinfoUpdated(String wId, String extInfo, String opId)
- 功能 : 通知白板扩展信息有更新
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| exInfo | String | 扩展信息 |
| opId | String | 操作者ID |
BoardInfo getBoardInfo(String boardID)
- 功能 : 获取白板信息
- 返回值 : 白板信息
| 参数 | 类型 | 含义 |
|---|---|---|
| boardID | String | 白板ID |
String getCurrentBoard()
- 功能 : 获取白板信息
- 返回值 : 白板ID
void setCurrentBoard(String boardID)
- 功能 : 设置当前白板
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| boardID | String | 白板ID |
void notifyCurrentBoard(String wId, String opId)
- 功能 : 通知更换当前白板
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| opId | String | 操作者ID |
WB_SHAPE_TYPE getBoardViewToolType()
- 功能 : 获取view的工具类型
- 返回值 : 工具类型
void undo()
- 功能 : 撤销
- 返回值 : 无
void redo()
- 功能 : 恢复
- 返回值 : 无
void notifyViewScaleChanged(String wId, int scale, String opId)
- 功能 : 通知白板缩放比改变
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| scale | int | 缩放系数(200代表放大2倍),范围在20~500。 |
| opId | String | 操作者ID |
void notifyWbCurrentPos(String wId, float xPos,float yPos, String opId)
- 功能 : 通知白板位置改变
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| wID | String | 白板ID |
| xPos | float | X轴方向偏移量(取值范围0~1) |
| yPos | float | Y轴方向偏移量(取值范围0~1) |
| opId | String | 操作者ID |
void setBoardViewToolType(WB_SHAPE_TYPE type)
- 功能 : 设置白板操作模式
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| type | WB_SHAPE_TYPE | 白板操作模式 |
void setBoardViewToolAttr(BoardViewToolAttr property)
- 功能 : 设置白板画笔属性
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| property | BoardViewToolAttr | 白板画笔属性 |
BoardViewToolAttr getBoardViewToolAttr()
- 功能 : 获取白板画笔属性
- 返回值 : 画笔属性
void notifyInitBoardList(List<String> boardIDList)
- 功能 : 通知初始化白板列表
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| boardIDList | List | 白板ID列表 |
void setBoardViewCurPage(int pageNum)
- 功能 : 设置view的当前页
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| pageNum | int | 页数 |
int getBoardViewCurPage()
- 功能 : 设置view的当前页
- 返回值 : 当前页
void clearCurPage()
- 功能 : 清空当前页标注
- 返回值 : 无
void clearAllPage()
- 功能 : 清空整个view的标注
- 返回值 : 无
boolean getRedoEnableState()
- 功能 : 获取是否可以redo
- 返回值 : 是否可以redo
boolean getUndoEnableState()
- 功能 : 获取是否可以undo
- 返回值 : 是否可以undo
void notifyRedoEnableChanged(boolean bEnable)
- 功能 : 通知是否可以redo
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 是否可以redo |
void notifyUndoEnableChanged(boolean bEnable)
- 功能 : 通知是否可以undo
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 是否可以undo |
void notifyMarkException(MarkException exType)
- 功能 : 通知标注异常
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| exType | MarkException | 异常类型 |
void setBoardID(String boardID, BoardViewAttr viewAttr)
- 功能 : 设置白板ID和相关权限属性
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| boardID | String | 白板id |
| viewAttr | BoardViewAttr | 权限属性 |
void setBoardViewAttr(BoardViewAttr attr)
- 功能 : 获取白板权限属性
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| attr | BoardViewAttr | 权限属性 |
BoardViewAttr getBoardViewAttr()
- 功能 : 获取白板画笔属性
- 返回值 : 白板画笔属性
void setBoardViewCallback(BoardViewCallback callback)
- 功能 : 监听白板相关通知
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| callback | BoardViewCallback | 回调对象 |
void setViewScale(float scale)
- 功能 : 设置白板缩放值
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| scale | float | 缩放值(200代表2倍,范围在20~500) |
float getViewScale()
- 功能 : 获取白板缩放值
- 返回值 : 缩放值(2代表2倍,范围在0.2~5)
void notifyBoardCurPageChanged(int curPage, String operatorUserID)
- 功能 : 通知白板页变化
- 返回值 : 无
| 参数 | 类型 | 含义 |
|---|---|---|
| curPage | int | 当前页 |
| operatorUserID | String | 操作者ID |