腾讯云互动白板Android端API概览-教育服务解决方案

TEduBoardController

白板功能的主要接口类

类名 描述
TEduBoardController 白板控制器

创建销毁实例

API 描述
TEduBoardController 创建白板控制类实例

设置 TEduBoardCallback 回调

API 描述
addCallback 设置事件回调监听
removeCallback 删除事件回调监听

基本流程接口

API 描述
init 初始化白板
uninit 反初始化白板,释放内部资源.
getBoardRenderView 获取白板渲染 View在调用此接口获取 View 后,加入到视图树中后,在结束时需要 removeView收到 onTEBBoardInit 回调之前调用该接口无效
addBoardViewToContainer 将白板View设置到容器中
addSyncData 添加白板同步数据
setDataSyncEnable 设置白板是否开启数据同步
isDataSyncEnable 获取白板是否开启数据同步
reset 重置白板
getSyncTime 获取同步时间戳
syncRemoteTime 同步远端时间戳
getVersion 获取 SDK 版本号
addBackupDomain 添加资源主备域名映射

白板相关接口

API 描述
setHandwritingEnable 设置白板是否开启笔锋
isHandwritingEnable 获取白板是否开启笔锋
setMouseToolBehavior 设置鼠标工具行为
setPenAutoFittingMode 设置画笔自动拟合模式
setProxyServer 设置代理服务器
setRemoteCursorVisible 设置远端画笔在本地是否显示
setScaleAnchor 对当前白板进行移动
setScaleToolRatio 设置缩放工具缩放比例
setSystemCursorEnable 设置是否启用原生系统光标
setToolTypeTitle 设置白板工具提示语text
setZoomCursorIcon 自定义缩放工具图标
setToolTypeTitle 设置白板工具提示语text
getBoardRemark 获取白板备注
removeBackupDomain 删除资源主备域名映射
setBoardRemark 设置白板备注
setEraseLayerLimit 设置橡皮擦单次擦除图层数量
setEraseLayerType 设置橡皮擦可擦除的白板元素类型
syncAndReload 同步本地发送失败的数据到远端并刷新本地数据
setLogLevel 设置输出日志级别
setScrollBarVisible 设置白板滚动条是否可见
setPiecewiseErasureEnable 是否启用点擦(分段擦除)功能
isPiecewiseErasureEnable 获取分段擦除模式开启状态
setEraserSize 设置橡皮擦大小
getEraserSize 获取橡皮擦大小
setOwnerNickNameVisible 是否本地显示自己的别名
useMathTool 使用数学教具
getElementById 获取白板中的元素信息
updateElementById 设置元素样式

文件操作接口

API 描述
addImagesFile 批量导入图片当传入文件的 URL 重复时,返回 URL 对应的 文件 ID最大支持5k的数据
addTranscodeFile 添加转码文件
deleteFile 删除文件
switchFile 切换文件
getCurrentFile 获取当前文件 ID
getFileInfoList 获取白板中上传的所有文件的文件信息列表
getFileInfo 获取白板中指定文件的文件信息
getFileBoardList 获取指定文件的白板 ID 列表
getThumbnailImages 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
addH5File 添加 H5 页面
loadResource 课件预加载,提高加载速度,请参考 课件预加载
soundMuteForPPT 对转码后的H5PPT进行静音
getPPTRemarks 获取 PPT 的备注

白板页操作接口

API 描述
addBoard 增加一页白板
deleteBoard 删除一页白板
prevStep 上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
nextStep 下一步
prevBoard 向前翻页
nextBoard 向后翻页
gotoBoard 跳转到指定白板页
getCurrentBoard 获取当前白板页 ID
getBoardList 获取所有文件的白板列表
setBoardRatio 设置当前白板页宽高比
getBoardRatio 获取当前白板页宽高比
setBoardScale 设置当前白板页缩放比例
getBoardScale 获取当前白板页缩放比例
setBoardContentFitMode 设置白板内容自适应模式
getBoardContentFitMode 获取白板内容自适应模式
refresh 刷新当前页白板,触发 onTEBRefresh 回调
gotoStep 跳转到指定动画步数
getBoardScroll 获取白板滚动位置

涂鸦相关接口

API 描述
setDrawEnable 设置白板是否允许涂鸦
isDrawEnable 获取白板是否允许涂鸦
setAccessibleUsers 设置允许操作哪些用户绘制的图形
setToolType 设置要使用的白板工具
getToolType 获取正在使用的白板工具
setZoomCursorIcon 自定义缩放工具图标
setCursorIcon 自定义白板工具鼠标样式
setBrushColor 设置画笔颜色
getBrushColor 获取画笔颜色
setBrushThin 设置画笔粗细
getBrushThin 获取画笔粗细
setTextColor 设置文本颜色
getTextColor 获取文本颜色
setTextSize 设置文本大小
getTextSize 获取文本大小
setTextStyle 设置文本样式
getTextStyle 获取文本样式
setLineStyle 设置直线样式
getLineStyle 获取直线样式
setNextTextInput 预设文本工具内容
setOvalDrawMode 设置椭圆绘制模式
getOvalDrawMode 获取椭圆绘制模式
addElementFormula 添加公式元素
addElementFunctionGrapher 添加数学函数图像
addElementMathCanvas 添加数学函数画板
getBoardElementList 获取白板当中所有元素
removeElement 删除白板元素
setMathGraphType 设置几何画板元素
setTextValue 设置文本组件内容
addElement 添加白板元素
setTextFontFamily 设置自定义字体
addTextFontFamily 添加自定义字体
getTextFontFamily 获取当前使用字体
enablePenAutoFit 开启绘制涂鸦过程中自动拟合图形
setHighlighterColor 设置荧光笔颜色,画笔颜色用于荧光笔绘制
getHighlighterColor 获取荧光笔颜色

清空相关

API 描述
clear 清空当前白板页涂鸦
clearFileDraws 清空指定文件的所有白板涂鸦

背景相关

API 描述
setGlobalBackgroundColor 设置所有白板的背景色
getGlobalBackgroundColor 获取白板全局背景色
setBackgroundColor 设置当前白板页的背景色
getBackgroundColor 获取当前白板页的背景色
setBackgroundImage 设置当前白板页的背景图片
setBackgroundH5 设置当前白板页的背景 H5 页面
setGlobalBackgroundPic 设置白板全局背景图
getGlobalBackgroundPic 获取白板全局背景图

撤销和恢复相关

API 描述
undo 撤销当前白板页上一次动作
redo 重做当前白板页上一次撤销

互动白板音视频文件相关接口

API 描述
enableAudioControl 是否启用音频控制面板
getAudioVolume 获取音频音量
pauseAudio 暂停音频
playAudio 播放音频
setAudioVolume 设置音频音量
setSyncAudioStatusEnable 是否同步本地音频操作状态到远端
seekAudio 跳转音频进度
addVideoFile 添加视频文件
showVideoControl 显示或隐藏视频控制栏
playVideo 播放视频
pauseVideo 暂停视频
seekVideo 跳转(仅支持点播视频)
setSyncVideoStatusEnable 是否同步本地视频操作到远端
startSyncVideoStatus 内部启动定时器,定时同步视频状态到远端(仅限于 mp4)
stopSyncVideoStatus 停止同步视频状态

截图板书相关接口

API 描述
snapshot 白板快照
addSnapshotMark 生成板书图片标记需要配合服务端 API 接口来生成,服务端会根据标记点进行快照截图

分组讨论相关接口

API 描述
addBoardToClassGroup 添加白板到分组
addUserToClassGroup 添加用户到分组
getAllClassGroupIds 获取所有分组 id
getClassGroupEnable 获取分组模式状态
getClassGroupIdByUserId 获取用户所在的分组
getClassGroupInfoByGroupId 获取分组信息
gotoClassGroupBoard 分组内跳转
removeBoardInClassGroup 从分组中删除白板
removeClassGroup 删除分组
removeUserInClassGroup 从分组中删除用户
resetClassGroup 重置所有分组
setClassGroup 添加分组
setClassGroupEnable 开启分组模式
setClassGroupTitle 设置分组标题

腾讯云官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠

发表评论