TEduBoardController
白板功能的主要接口类
类名 | 描述 |
TEduBoard | 白板控制器 |
创建销毁实例
API | 描述 |
TEduBoard | 白板构造函数 |
destroy | 销毁白板 |
设置 TEduBoardCallback 回调
API | 描述 |
on | 启用事件监听 |
off | 取消事件监听 |
基本流程接口
API | 描述 |
addSyncData | 添加白板同步数据 |
getVersion | 获取 SDK 版本号 |
setDataSyncEnable | 设置白板是否开启数据同步 |
isDataSyncEnable | 获取白板是否开启数据同步 |
reset | 重置白板 |
getSyncTime | 获取同步时间戳 |
syncRemoteTime | 同步远端时间戳 |
涂鸦相关接口
API | 描述 |
setDrawEnable | 设置白板是否允许涂鸦 |
isDrawEnable | 获取白板是否允许涂鸦 |
setAccessibleUsers | 设置允许操作哪些用户绘制的图形 |
setGlobalBackgroundColor | 设置所有白板的背景色 |
getGlobalBackgroundColor | 获取白板全局背景色 |
setBackgroundColor | 设置当前白板页的背景色 |
getBackgroundColor | 获取当前白板页的背景色 |
setToolType | 设置要使用的白板工具 |
getToolType | 获取正在使用的白板工具 |
setCursorIcon | 自定义白板工具鼠标样式 |
setBrushColor | 设置画笔颜色 |
getBrushColor | 获取画笔颜色 |
setBrushThin | 设置画笔粗细 |
getBrushThin | 获取画笔粗细 |
setTextColor | 设置文本颜色 |
getTextColor | 获取文本颜色 |
setTextSize | 设置文本大小 |
getTextSize | 获取文本大小 |
setTextStyle | 设置文本样式 |
getTextStyle | 获取文本样式 |
setLineStyle | 设置直线样式 |
getLineStyle | 获取直线样式 |
setOvalDrawMode | 设置椭圆绘制模式 |
getOvalDrawMode | 获取椭圆绘制模式 |
clear | 清空当前白板页涂鸦 |
setBackgroundImage | 设置当前白板页的背景图片 |
setBackgroundH5 | 设置当前白板页的背景 H5 页面 |
undo | 撤销当前白板页上一次动作 |
redo | 重做当前白板页上一次撤销 |
resize | 重新计算白板大小,并渲染 |
白板页操作接口
API | 描述 |
addBoard | 增加一页白板 |
deleteBoard | 删除一页白板 |
prevStep | 上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页 |
nextStep | 下一步 |
prevBoard | 向前翻页 |
nextBoard | 向后翻页 |
gotoBoard | 跳转到指定白板页 |
getCurrentBoard | 获取当前白板页 ID |
getBoardList | 获取所有文件的白板列表 |
setBoardRatio | 设置当前白板页宽高比 |
getBoardRatio | 获取当前白板页宽高比 |
setBoardScale | 设置当前白板页缩放比例 |
getBoardScale | 获取当前白板页缩放比例 |
setBoardContentFitMode | 设置白板内容自适应模式 |
getBoardContentFitMode | 获取白板内容自适应模式 |
文件操作接口
API | 描述 |
applyFileTranscode | 发起文件转码请求 |
getFileTranscodeProgress | 主动查询文件转码进度 |
addTranscodeFile | 添加转码文件 |
deleteFile | 删除文件 |
switchFile | 切换文件 |
getCurrentFile | 获取当前文件 ID |
getFileInfo | 获取白板中指定文件的文件信息 |
getFileInfoList | 获取白板中上传的所有文件的文件信息列表 |
getFileBoardList | 获取指定文件的白板 ID 列表 |
getThumbnailImages | 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT) |
clearFileDraws | 清空指定文件的所有白板涂鸦 |
TEduBoardCallback
白板功能的回调接口类
类名 | 描述 |
TEduBoardCallback | 白板事件回调接口 |
通用事件回调
API | 描述 |
TEB_ERROR | 白板错误回调 |
TEB_WARNING | 白板警告回调 |
基本流程回调
API | 描述 |
TEB_INIT | 白板初始化完成回调 |
TEB_HISTROYDATA_SYNCCOMPLETED | 白板历史数据同步完成回调 |
TEB_SYNCDATA | 白板同步数据回调 |
TEB_OPERATE_CANUNDO_STATUS_CHANGED | 白板可撤销状态改变回调 |
TEB_OPERATE_CANREDO_STATUS_CHANGED | 白板可重做状态改变回调 |
涂鸦功能回调
API | 描述 |
TEB_IMAGE_STATUS_CHANGED | 白板图片状态改变回调 |
TEB_SETBACKGROUNDIMAGE | 设置白板背景图片回调 |
TEB_H5BACKGROUND_STATUS_CHANGED | 设置白板背景 H5 状态改变回调 |
白板页操作回调
API | 描述 |
TEB_ADDBOARD | 增加白板页回调 |
TEB_DELETEBOARD | 删除白板页回调 |
TEB_GOTOBOARD | 跳转白板页回调 |
TEB_GOTOSTEP | 白板页动画步数回调 |
文件操作回调
API | 描述 |
TEB_TRANSCODEPROGRESS | 文件转码进度回调 |
TEB_ADDTRANSCODEFILE | 增加转码文件回调 |
TEB_DELETEFILE | 删除文件回调 |
TEB_SWITCHFILE | 切换文件回调 |
TEB_FILEUPLOADPROGRESS | 文件上传进度回调 |
TEB_FILEUPLOADSTATUS | 文件上传状态回调 |
关键类型定义
类名 | 描述 |
TEduBoardInitParam | 白板初始化参数 |
TEduBoardLineStyle | 直线样式 |
TEduBoardCursorIcon | 鼠标样式 |
TEduBoardTranscodeConfig | 文件转码参数 |
TEduBoardTranscodeFileResult | 文件转码结果 |
TEduBoardInfo | 白板信息 |
TEduBoardFileInfo | 文件信息 |
枚举值
枚举 | 描述 |
TEduBoardToolType | 白板工具 |
TEduBoardImageFitMode | 白板图片填充对齐模式 |
TEduBoardImageStatus | 白板图片状态 |
TEduBoardTextStyle | 白板文本样式 |
TEduBoardUploadStatus | 白板上传状态 |
TEduBoardBackgroundH5Status | H5 背景状态 |
TEduBoardContentFitMode | 白板内容自适应模式 |
TEduBoardLineType | 直线类型 |
TEduBoardArrowType | 箭头类型 |
TEduBoardOvalDrawMode | 椭圆绘制模式 |
错误码
枚举值
枚举 | 描述 |
TEduBoardErrorCode | 白板错误码(严重) |
TEduBoardWarningCode | 白板错误码(警告) |