有奖捉虫:云通信与企业服务文档专题,速来> HOT

主要功能

白板功能的主要接口类,可参考 概览文档
类名
描述
白板控制器

创建销毁实例

API
描述
CreateTEduBoardController
创建白板控制类实例
DestroyTEduBoardController
销毁白板控制类
ClearTEduBoardSDKEnv
清理白板 SDK 环境,在不使用白板后调用以释放资源

日志相关接口

API
描述
GetTEduBoardVersion
获取 SDK 版本号
SetTEduBoardLogFileDir
设置白板日志文件存储目录路径
SetLogLevel
设置输出日志级别

高级功能接口

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

设置 TEduBoardCallback 回调

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

基本流程接口

API
描述
Init
初始化白板
GetBoardRenderView
获取白板渲染 View
Refresh
刷新当前页白板,触发 onTEBRefresh 回调
SyncAndReload
同步本地发送失败的数据到远端并刷新本地数据
AddSyncData
添加白板同步数据
SetDataSyncEnable
设置白板是否开启数据同步
IsDataSyncEnable
获取白板是否开启数据同步
Reset
重置白板
SetBoardRenderViewPos
设置白板渲染 View 的位置和大小
GetSyncTime
获取同步时间戳
SyncRemoteTime
同步远端时间戳
SetSystemCursorEnable
是否启用原生系统光标
AddBackupDomain
添加备用域名
RemoveBackupDomain
删除备用域名
SetProxyServer
设置服务的代理服务器
CallExperimentalAPI
调用白板实验性接口

离屏渲染输入事件相关接口

API
描述
SendKeyEvent
发送键盘事件到白板
SendMouseClickEvent
发送鼠标点击事件到白板
SendMouseMoveEvent
发送鼠标移动事件到白板
SendMouseWheelEvent
发送鼠标滚轮事件到白板
SendTouchEvent
发送触摸事件到白板

涂鸦相关接口

API
描述
SetDrawEnable
设置白板是否允许涂鸦
IsDrawEnable
获取白板是否允许涂鸦
SetHandwritingEnable
设置白板是否开启笔锋特性
IsHandwritingEnable
获取白板是否开启笔锋特性
SetEraseLayerLimit
设置橡皮擦单次擦除图层数量
SetEraseLayerType
限制橡皮擦可擦除的白板元素类型
SetAccessibleUsers
设置允许操作哪些用户绘制的图形
SetToolType
设置要使用的白板工具
GetToolType
获取正在使用的白板工具
SetToolTypeTitle
设置画笔和激光笔工具提示语
SetCursorIcon
自定义白板工具鼠标样式
SetBrushColor
设置画笔颜色
GetBrushColor
获取画笔颜色
SetBrushThin
设置画笔粗细
GetBrushThin
获取画笔粗细
SetTextColor
设置文本颜色
GetTextColor
获取文本颜色
SetTextSize
设置文本大小
GetTextSize
获取文本大小
SetTextStyle
设置文本样式
GetTextStyle
获取文本样式
SetLineStyle
设置直线样式
GetLineStyle
获取直线样式
SetOvalDrawMode
设置椭圆绘制模式
GetOvalDrawMode
获取椭圆绘制模式
Clear
清空当前白板页涂鸦
Undo
撤销当前白板页上一次动作
Redo
重做当前白板页上一次撤销
setScrollBarVisible
设置白板滚动条是否可见
setTextFontFamily
设置自定义字体
addTextFontFamily
添加自定义字体
getTextFontFamily
获取当前使用字体
setPiecewiseErasureEnable
是否启用点擦(分段擦除)功能
isPiecewiseErasureEnable
获取分段擦除模式开启状态
setEraserSize
设置橡皮擦大小
getEraserSize
获取橡皮擦大小
setOwnerNickNameVisible
是否显示自己的别名
useMathTool
使用数学尺规教具
enablePenAutoFit
开启绘制涂鸦过程中自动拟合图形(魔法笔)
getElementById
获取元素信息
updateElementById
设置元素样式
setHighlighterColor
设置荧光笔颜色
getHighlighterColor
获取荧光笔颜色

白板页操作接口

API
描述
AddBoard
增加一页白板
AddImageElement
添加图片资源
AddElement
添加白板元素
RemoveElement
删除白板元素
GetBoardElementList
获取白板中所有元素
DeleteBoard
删除一页白板
PrevStep
上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
NextStep
下一步
PrevBoard
向前翻页
NextBoard
向后翻页
GotoBoard
跳转到指定白板页
GetCurrentBoard
获取当前白板页 ID
GetBoardList
获取所有文件的白板列表
SetBoardRatio
设置当前白板页宽高比
GetBoardRatio
获取当前白板页宽高比
SetBoardScale
设置当前白板页缩放比例
GetBoardScale
获取当前白板页缩放比例
SetFileScale
设置文件缩放比例
GetFileScale
获取文件缩放比例
SetScaleToolRatio
设置白板缩放工具的缩放比例
SetScaleAnchor
移动当前白板缩放展示位置
SetBoardContentFitMode
设置白板内容自适应模式
GetBoardContentFitMode
获取白板内容自适应模式
Snapshot
白板快照
SetNextTextInput
预设文本工具内容
SetZoomCursorIcon
设置放大缩小工具的指针图标
SetRemoteCursorVisible
设置远端画笔在本地是否可见
gotoStep
跳转到指定动画步数
getBoardScroll
获取白板滚动位置

文件操作接口

API
描述
GetFileTranscodeProgress
主动查询文件转码进度
AddTranscodeFile
添加转码文件
AddImagesFile
添加图片文件
AddVideoFile
添加视频文件
ShowVideoControl
显示或隐藏视频控制栏
PlayVideo
播放视频
PauseVideo
暂停视频
SeekVideo
跳转(仅支持点播视频)
SetSyncVideoStatusEnable
是否同步本地视频操作到远端
StartSyncVideoStatus
内部启动定时器,定时同步视频状态到远端(仅限于 mp4)
StopSyncVideoStatus
停止同步视频状态
EnableAudioControl
是否启用音频控制面板
PlayAudio
播放音频
PauseAudio
暂停音频
SeekAudio
跳转
SetAudioVolume
设置音频播放音量
GetAudioVolume
获取音频播放音量
AddH5File
添加 H5 页面
DeleteFile
删除文件
SwitchFile
切换文件
GetCurrentFile
获取当前文件 ID
GetFileInfo
获取白板中指定文件的文件信息
GetFileInfoList
获取白板中上传的所有文件的文件信息列表
GetFileBoardList
获取指定文件的白板 ID 列表
GetThumbnailImages
获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
ClearFileDraws
清空指定文件的所有白板涂鸦
SetUserInfo
设置用户信息
SetPenAutoFittingMode
设置画笔自动拟合模式
AddSnapshotMark
生成板书图片 调用此接口可在后台生成当前白板的板书内容
SetMouseToolBehavior
设置鼠标工具行为 调用此接口设置鼠标工具行为
SetMathGraphType
设置几何画板元素 调用此接口设置几何画板元素
SetBoardRemark
设置白板备注 为某个白板设置备注, 当前白板可省略 boardId 参数
GetBoardRemark
获取白板备注
SoundMuteForPPT
对转码后的H5PPT进行静音
LoadTeduBoardResource
课件预加载,请参考 课件预加载
SetTeduBoardResourceConfig
课件预加载配置参数,请参考 课件预加载
GetPPtRemarks
获取指定课件的备注

分组讨论

API
描述
SetClassGroupEnable
开启分组模式
GetClassGroupEnable
获取分组模式状态
SetClassGroup
添加分组
ResetClassGroup
重置所有分组
RemoveClassGroup
删除分组
GetClassGroupInfoByGroupId
获取分组信息
GetClassGroupIdByUserId
获取用户所在的分组
RemoveUserInClassGroup
从分组中删除用户
RemoveBoardInClassGroup
从分组中删除白板
GotoClassGroupBoard
分组内跳转 分组模式下切换白板只能通过此方法进行,必须知道需要跳转的白板 ID
SetClassGroupTitle
设置分组标题
AddBoardToClassGroup
新增白板 ID
AddUserToClassGroup
添加用户到分组
GetAllClassGroupIds
获取所有分组 ID

背景接口

API
描述
SetGlobalBackgroundColor
设置所有白板的背景色
GetGlobalBackgroundColor
获取白板全局背景色
SetBackgroundColor
设置当前白板页的背景色
GetBackgroundColor
获取当前白板页的背景色
SetBackgroundImage
设置当前白板页的背景图片
SetBackgroundH5
设置当前白板页的背景 H5 页面
setGlobalBackgroundPic
设置全局白板背景图
getGlobalBackgroundPic
获取全局白板背景图

回调定义

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

通用事件回调

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

基本流程回调

API
描述
onTEBInit
白板初始化完成回调
onTEBHistroyDataSyncCompleted
白板历史数据同步完成回调
onTEBSyncData
白板同步数据回调
onTEBUndoStatusChanged
白板可撤销状态改变回调
onTEBRedoStatusChanged
白板可重做状态改变回调
onTEBRectSelected
框选工具选中回调 只有框选中涂鸦或图片元素后触发回调
onTEBRefresh
刷新白板回调
onTEBOffscreenPaint
白板离屏渲染回调
onTEBAudioCallbackStarted
白板音频开始回调
onTEBAudioCallbackPacket
白板音频包回调
onTEBAudioCallbackStopped
白板音频停止回调

涂鸦功能回调

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

白板页操作回调

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

文件操作回调

API
描述
onTEBFileTranscodeProgress
文件转码进度回调
onTEBAddTranscodeFile
增加转码文件回调
onTEBAddImagesFile
增加批量图片文件回调
onTEBVideoStatusChanged
视频文件状态回调
onTEBAudioStatusChanged
音频文件状态回调
onTEBH5FileStatusChanged
H5 文件状态回调
onTEBH5PPTStatusChanged
H5 PPT 文件状态改变回调
onTEBDeleteFile
删除文件回调
onTEBSwitchFile
切换文件回调
onTEBFileUploadProgress
文件上传进度回调
onTEBFileUploadStatus
文件上传状态回调
onTEBOfflineWarning
白板离线告警
onTEBTextElementStatusChanged
文本组件状态回调
onTEBImageElementStatusChanged
白板图片状态改变回调
onTEBTextElementWarning
白板图片状态改变回调
onTEBSelectedElements
框选工具选中元素回调
onTEBMathGraphEvent
框选工具选中元素回调
onTEBZoomDragStatus
远端白板缩放移动状态回调
onTEBGroupStatusChanged
分组讨论状态变更

关键类型定义

类名
描述
TEduBoardAuthParam
白板授权参数
TEduBoardColor
颜色参数
TEduRoutineConfigInitParam
常规配置参数
TEduUserConfigInitParam
用户配置参数
TEduStyleConfigInitParam
样式配置参数
TEduElementOperationAuthority
操作权限参数
TEduMouseToolBehavior
设置鼠标工具行为
TEduAuthConfigInitParam
权限配置参数
TEduBoardInitParam
白板初始化参数
TEduBoardLineStyle
直线样式
TEduBoardCursorIcon
鼠标样式
TEduBoardToolTypeTitleStyle
工具提示语样式
TEduBoardElementOptions
元素选项
TEduBoardSnapshotInfo
快照信息
TEduBoardTranscodeConfig
文件转码参数
TEduBoardTranscodeFileResult
文件转码结果
TEduBoardInfo
白板信息
TEduAddBoardBase
添加白板元素
TEduAddBoardElementUrl
添加白板元素(类型不包括数学函数图像和数学函数画板)
TEduAddBoardElementMathGraph
添加一个数学函数图像
TEduAddBoardElementMathBoard
添加一个数学函数画板
TEduAddBoardElementFormula
添加一个公式元素
TEduBoardInfoList
白板信息列表
TEduBoardSelectedElementInfo
元素信息
TEduBoardSelectedElementInfoList
选中的白板元素信息列表
TEduBoardElementInfo
元素信息
TEduBoardElementInfoList
元素信息列表
TEduBoardFileInfo
文件信息
TEduBoardKeyEvent
键盘事件
TEduBoardMouseEvent
鼠标事件
TEduBoardTouchEvent
触摸事件
TEduBoardRect
矩形区域
TEduUserInfo
用户信息
TEduBoardFileInfoList
文件信息列表
TEduBoardStringList
字符串列表
TEduBoardReMarkInfo
白板备注信息
TEduBoardReMarkInfoList
白板备注列表
TEduBoardClassGroupInfo
组信息

枚举值

枚举
描述
TEduBoardToolType
白板工具
TEduBoardElementType
白板元素类型
TEduBoardErasableElementType
橡皮擦可擦除元素类型
TEduBoardImageFitMode
白板图片填充对齐模式
TEduBoardImageStatus
白板图片状态
TEduBoardPosition
位置类型
TEduBoardTextStyle
白板文本样式
TEduBoardUploadStatus
白板上传状态
TEduBoardBackgroundH5Status
H5 背景状态
TEduBoardContentFitMode
白板内容自适应模式
TEduBoardLineType
直线类型
TEduBoardArrowType
箭头类型
TEduBoardOvalDrawMode
椭圆绘制模式
TEduBoardFileTranscodeStatus
文件转码状态
TEduBoardH5FileStatus
H5 文件状态
TEduBoardH5PPTStatus
PPT 动画文件加载状态
TEduBoardVideoStatus
视频文件状态
TEduBoardAudioStatus
音频状态
TEduBoardKeyEventType
键盘事件类型
TEduBoardMouseButtonType
鼠标按键类型
TEduBoardTouchEventType
触摸事件类型
TEduBoardPointType
点设备类型
TEduBoardEventFlag
事件标记位
TEduBoardAccessibleOperation
白板事件类型
TEduBoardTextComponentStatus
白板文字工具异常状态码
TEduBoardMathGraphCode
数学函数图像工具状态码
TEduBoardPenFittingMode
画笔自动拟合模式
TEduBoardBackgroundType
白板背景类型
TEduBoardMathGraphType
几何图形类型
TEduBoardClassGroupOperationType
白板分组操作

错误码

枚举值

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