概览

最近更新时间:2020-01-13 14:32:02

TEduBoardController

白板功能的主要接口类

类名 描述
TEduBoardController 白板控制器

设置 TEduBoardCallback 回调

API 描述
addDelegate: 设置事件回调监听
removeDelegate: 删除事件回调监听

基本流程接口

API 描述
initWithAuthParam:roomId:initParam: 初始化白板
getBoardRenderView 获取白板渲染 View
addSyncData: 添加白板同步数据
setDataSyncEnable: 设置白板是否开启数据同步
isDataSyncEnable 获取白板是否开启数据同步
getSyncTime 获取同步时间戳
syncRemoteTime:timestamp: 同步远端时间戳
reset 重置白板
getVersion 获取版本号

涂鸦相关接口

API 描述
setAccessibleUsers: 设置允许操作哪些用户绘制的图形
setDrawEnable: 设置白板是否允许涂鸦
isDrawEnable 获取白板是否允许涂鸦
setGlobalBackgroundColor: 设置所有白板的背景色
getGlobalBackgroundColor 获取白板全局背景色
setBackgroundColor: 设置当前白板页的背景色
getBackgroundColor 获取当前白板页的背景色
setBackgroundImage:mode: 设置当前白板页的背景图片
setBackgroundH5: 设置当前白板页的背景 H5 页面
setToolType: 设置要使用的白板工具
getToolType 获取正在使用的白板工具
setBrushColor: 设置画笔颜色
getBrushColor 获取画笔颜色
setBrushThin: 设置画笔粗细
getBrushThin 获取画笔粗细
setTextColor: 设置文本颜色
getTextColor 获取文本颜色
setTextStyle: 设置文本样式
getTextStyle 获取文本样式
setTextSize: 设置文本大小
getTextSize 获取文本大小
setLineStyle: 设置直线样式
getLineStyle 获取直线样式
setOvalDrawMode: 设置椭圆绘制模式
getOvalDrawMode 获取椭圆绘制模式
undo 撤销当前白板页上一次动作
redo 重做当前白板页上一次撤销
clear 清除涂鸦,同时清空背景色以及背景图片
clearDraws 清除涂鸦
clearBackground:andSelected: 清空当前白板页涂鸦
setCursorIcon:cursorIcon: 自定义白板工具鼠标样式

白板页操作接口

API 描述
addBoardWithBackgroundImage: 增加一页白板
deleteBoard: 删除一页白板
prevStep 上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
nextStep 下一步
preBoard 向前翻页
nextBoard 向后翻页
gotoBoard: 跳转到指定白板页
preBoard: 向前翻页
nextBoard: 向后翻页
gotoBoard:resetStep: 跳转到指定白板页
getCurrentBoard 获取当前白板页 ID
getBoardList 获取所有文件的白板列表
setBoardRatio: 设置当前白板页宽高比
getBoardRatio 获取当前白板页宽高比
setBoardScale: 设置当前白板页缩放比例
getBoardScale 获取当前白板页缩放比例
setBoardContentFitMode: 设置白板内容自适应模式
getBoardContentFitMode 获取白板内容自适应模式
addImageElement: 添加图片资源

文件操作接口

API 描述
applyFileTranscode:config: 发起文件转码请求
getFileTranscodeProgress: 主动查询文件转码进度
addTranscodeFile: 添加转码文件
deleteFile: 删除文件
switchFile: 切换文件
switchFile:boardId:stepIndex: 切换文件
getCurrentFile 获取当前文件 ID
getFileInfo: 获取白板中指定文件的文件信息
getFileInfoList 获取白板中上传的所有文件的文件信息列表
getFileBoardList: 获取指定文件的白板 ID 列表
getThumbnailImages: 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
clearFileDraws: 清空指定文件的所有白板涂鸦
addVideoFile: 添加视频文件
showVideoControl: 显示或隐藏视频控制栏
playVideo 播放视频
pauseVideo 暂停视频
seekVideo: 跳转(仅支持点播视频)
setSyncVideoStatusEnable: 是否同步本地视频操作到远端
startSyncVideoStatus: 内部启动定时器,定时同步视频状态到远端(仅限于 mp4)
stopSyncVideoStatus 停止同步视频状态
addH5File: 添加 H5 页面

TEduBoardDelegate

白板功能的回调接口类

类名 描述
TEduBoardDelegate-p 白板事件回调接口

通用事件回调

API 描述
onTEBError:msg: 白板错误回调
onTEBWarning:msg: 白板警告回调

基本流程回调

API 描述
onTEBInit 白板初始化完成回调
onTEBHistroyDataSyncCompleted 白板历史数据同步完成回调
onTEBSyncData: 白板同步数据回调
onTEBUndoStatusChanged: 白板可撤销状态改变回调
onTEBRedoStatusChanged: 白板可重做状态改变回调

涂鸦功能回调

API 描述
onTEBImageStatusChanged:url:status: 白板图片状态改变回调
onTEBSetBackgroundImage: 设置白板背景图片回调
onTEBAddImageElement: 添加图片元素回调
onTEBBackgroundH5StatusChanged:url:status: 设置白板背景 H5 状态改变回调

白板页操作回调

API 描述
onTEBAddBoard:fileId: 增加白板页回调
onTEBDeleteBoard:fileId: 删除白板页回调
onTEBGotoBoard:fileId: 跳转白板页回调
onTEBGotoStep:totalStep: 白板页动画步数回调

文件操作回调

API 描述
onTEBFileTranscodeProgress:path:errorCode:errorMsg: 文件转码进度回调
onTEBAddTranscodeFile: 增加转码文件回调
onTEBDeleteFile: 删除文件回调
onTEBSwitchFile: 切换文件回调
onTEBFileUploadProgress:currentBytes:totalBytes:uploadSpeed:percent: 文件上传进度回调
onTEBFileUploadStatus:status:errorCode:errorMsg: 文件上传状态回调
onTEBH5FileStatusChanged:status: H5 文件状态回调
onTEBVideoStatusChanged:status:progress:duration: 视频文件状态回调

关键类型定义

类名 描述
TEduBoardInfo 白板信息
TEduBoardFileInfo 文件信息
TEduBoardAuthParam 授权参数
TEduBoardInitParam 白板初始化参数
TEduBoardLineStyle 直线样式
TEduBoardTranscodeConfig 文件转码参数
TEduBoardTranscodeFileResult 文件转码结果
TEduBoardCursorIcon 鼠标样式

枚举值

枚举 描述
TEduBoardToolType 白板工具
TEduBoardImageFitMode 白板图片填充对齐模式 当以宽度基准等比例放大,则居左和居右同居中对齐效果一致;当以高度基准等比例放大,则居顶和居底同居中对齐效果一致
TEduBoardContentFitMode 白板内容自适应模式 内容包括图片、文件、PPT 动画
TEduBoardImageStatus 白板图片状态
TEduBoardTextStyle 白板文本样式
TEduBoardUploadStatus 白板上传状态
TEduBoardBackgroundH5Status H5 背景状态
TEduBoardLineType 直线类型
TEduBoardArrowType 箭头类型
TEduBoardOvalDrawMode 椭圆绘制模式
TEduBoardFileTranscodeStatus 文件转码状态
TEduBoardVideoStatus 视频文件状态
TEduBoardH5FileStatus H5 文件状态

错误码

枚举值

枚举 描述
TEduBoardErrorCode 白板错误码(严重)
TEduBoardWarningCode 白板错误码(警告)