概览

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

TEduBoardController

白板功能的主要接口类

类名 描述
TEduBoardController 白板控制器

创建销毁实例

API 描述
CreateTEduBoardController 创建白板控制类实例
DestroyTEduBoardController 销毁白板控制类

日志相关接口

API 描述
GetTEduBoardVersion 获取 SDK 版本号
SetTEduBoardLogFilePath 设置白板日志文件路径

高级功能接口

API 描述
EnableTEduBoardOffscreenRender 启用白板离屏渲染
DisableTEduBoardCrashReport 禁用白板 Crash 上报
GetTEduBoardRenderProcessHandler 获取 SDK 内部的 CefRenderProcessHandler

设置 TEduBoardCallback 回调

API 描述
AddCallback 设置事件回调监听
RemoveCallback 删除事件回调监听

基本流程接口

API 描述
Init 初始化白板
GetBoardRenderView 获取白板渲染 View
AddSyncData 添加白板同步数据
SetDataSyncEnable 设置白板是否开启数据同步
IsDataSyncEnable 获取白板是否开启数据同步
Reset 重置白板
SetBoardRenderViewPos 设置白板渲染 View 的位置和大小
GetSyncTime 获取同步时间戳
SyncRemoteTime 同步远端时间戳
CallExperimentalAPI 调用白板实验性接口

涂鸦相关接口

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 重做当前白板页上一次撤销

白板页操作接口

API 描述
AddBoard 增加一页白板
AddImageElement 添加图片资源
DeleteBoard 删除一页白板
PrevStep 上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
NextStep 下一步
PrevBoard 向前翻页
NextBoard 向后翻页
GotoBoard 跳转到指定白板页
GetCurrentBoard 获取当前白板页 ID
GetBoardList 获取所有文件的白板列表
SetBoardRatio 设置当前白板页宽高比
GetBoardRatio 获取当前白板页宽高比
SetBoardScale 设置当前白板页缩放比例
GetBoardScale 获取当前白板页缩放比例
SetBoardContentFitMode 设置白板内容自适应模式
GetBoardContentFitMode 获取白板内容自适应模式

文件操作接口

API 描述
ApplyFileTranscode 发起文件转码请求
GetFileTranscodeProgress 主动查询文件转码进度
AddTranscodeFile 添加转码文件
AddVideoFile 添加视频文件
ShowVideoControl 显示或隐藏视频控制栏
PlayVideo 播放视频
PauseVideo 暂停视频
SeekVideo 跳转(仅支持点播视频)
SetSyncVideoStatusEnable 是否同步本地视频操作到远端
StartSyncVideoStatus 内部启动定时器,定时同步视频状态到远端(仅限于 mp4)
StopSyncVideoStatus 停止同步视频状态
AddH5File 添加 H5 页面
DeleteFile 删除文件
SwitchFile 切换文件
GetCurrentFile 获取当前文件 ID
GetFileInfo 获取白板中指定文件的文件信息
GetFileInfoList 获取白板中上传的所有文件的文件信息列表
GetFileBoardList 获取指定文件的白板 ID 列表
GetThumbnailImages 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
ClearFileDraws 清空指定文件的所有白板涂鸦

TEduBoardCallback

白板功能的回调接口类

类名 描述
TEduBoardCallback 白板事件回调接口

通用事件回调

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

基本流程回调

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

涂鸦功能回调

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

白板页操作回调

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

文件操作回调

API 描述
onTEBFileTranscodeProgress 文件转码进度回调
onTEBAddTranscodeFile 增加转码文件回调
onTEBVideoStatusChanged 视频文件状态回调
onTEBH5FileStatusChanged H5文件状态回调
onTEBDeleteFile 删除文件回调
onTEBSwitchFile 切换文件回调
onTEBFileUploadProgress 文件上传进度回调
onTEBFileUploadStatus 文件上传状态回调

关键类型定义

类名 描述
TEduBoardAuthParam 白板授权参数
TEduBoardColor 颜色参数
TEduBoardInitParam 白板初始化参数
TEduBoardLineStyle 直线样式
TEduBoardCursorIcon 鼠标样式
TEduBoardTranscodeConfig 文件转码参数
TEduBoardTranscodeFileResult 文件转码结果
TEduBoardInfo 白板信息
TEduBoardInfoList 白板信息列表
TEduBoardFileInfo 文件信息
TEduBoardFileInfoList 文件信息列表
TEduBoardStringList 字符串列表

枚举值

枚举 描述
TEduBoardToolType 白板工具
TEduBoardImageFitMode 白板图片填充对齐模式
TEduBoardImageStatus 白板图片状态
TEduBoardTextStyle 白板文本样式
TEduBoardUploadStatus 白板上传状态
TEduBoardBackgroundH5Status H5 背景状态
TEduBoardContentFitMode 白板内容自适应模式
TEduBoardLineType 直线类型
TEduBoardArrowType 箭头类型
TEduBoardOvalDrawMode 椭圆绘制模式
TEduBoardFileTranscodeStatus 文件转码状态
TEduBoardH5FileStatus H5 文件状态
TEduBoardVideoStatus 视频文件状态

错误码

枚举值

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