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

TEduBoard

白板功能的主要接口类

类名 描述
TEduBoard 白板控制器

创建销毁实例

API 描述
TEduBoard 白板构造函数
destroy 销毁白板

设置 TEduBoardCallback 回调

API 描述
on 启用事件监听
off 取消事件监听

基本流程接口

API 描述
addSyncData 添加白板同步数据
getVersion 获取 SDK 版本号
setDataSyncEnable 设置白板是否开启数据同步
isDataSyncEnable 获取白板是否开启数据同步
reset 重置白板,会清空所有的白板数据

白板操作接口

API 描述
addAckData 确认数据是否发送成功
addBackupDomain 添加资源主备域名映射
refresh 刷新当前页白板,触发 TEB_REFRESH 回调
removeBackupDomain 删除资源主备域名映射
setMouseToolBehavior 设置鼠标工具行为
setPenAutoFittingMode 设置画笔自动拟合模式
setProxyServer 设置服务的代理服务器
setRemoteCursorVisible 设置远端画笔在本地是否可见
setScaleAnchor 移动白板
setScaleToolRatio 设置缩放工具的缩放比例
setSystemCursorEnable 是否启用原生系统光标
syncAndReload 同步本地发送失败的数据到远端并刷新本地数据
isDrawEnable 获取白板是否允许涂鸦
resize 重新计算白板大小,并渲染
setDrawEnable 设置白板是否允许涂鸦
setAccessibleUsers 设置允许操作哪些用户绘制的图形
setLogLevel 设置输出日志级别
setScrollBarVisible 设置白板滚动条是否可见
setPiecewiseErasureEnable 设置分段擦除模式是否开启
isPiecewiseErasureEnable 获取分段擦除模式开启状态
setEraserSize 设置橡皮擦大小
getEraserSize 获取橡皮擦大小
setOwnerNickNameVisible 是否显示自己的别名
useMathTool 使用数学尺规教具
enablePenAutoFit 开启绘制涂鸦过程中自动拟合图形(魔法笔)
getElementById 获取元素信息
updateElementById 设置元素样式

文件操作接口

API 描述
addH5File 添加 H5 页面
addImagesFile 批量导入图片到白板
addTranscodeFile 添加转码文件
addVODFile 添加视频文件(内部接口)
deleteFile 删除文件
getFileTranscodeProgress 主动查询文件转码进度
getCurrentFile 获取当前文件 ID
getFileInfo 获取白板中指定文件的文件信息
getFileInfoList 获取白板中上传的所有文件的文件信息列表
getFileBoardList 获取指定文件的白板 ID 列表
getThumbnailImages 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
isHandwritingEnable 获取白板是否开启笔锋
setVODExtParam 设置点播视频的额外参数,如 plugins、hlsConfig 等,具体请参考 云点播开发文档
setFileScale 设置文件缩放比例
switchFile 切换文件
setHandwritingEnable 设置白板是否开启笔锋
soundMuteForPPT 对转码后的 H5PPT 进行静音
getPPTRemarks 获取指定课件的备注

白板页操作接口

API 描述
addBoard 增加一页白板
addElement 添加白板元素
deleteBoard 删除一页白板
getBoardContentFitMode 获取白板内容自适应模式
getBoardElementList 获取白板元素列表
getBoardList 获取所有文件的白板列表
getBoardRatio 获取当前白板页宽高比
getBoardScale 获取当前白板页缩放比例
getCurrentBoard 获取当前白板页 ID
gotoBoard 跳转到指定白板页
nextStep 下一步
nextBoard 向后翻页
prevStep 上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
prevBoard 向前翻页
setBoardContentFitMode 设置白板内容自适应模式
setBoardRatio 设置当前白板页宽高比
setBoardScale 设置当前白板页缩放比例
getBoardRemark 获取白板备注
setBoardRemark 设置白板备注
setCursorIcon 自定义白板工具鼠标样式
setZoomCursorIcon 自定义缩放工具的图标
gotoStep 跳转到指定动画步数
getBoardScroll 获取白板滚动位置

清空相关

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

涂鸦相关

API 描述
getToolType 获取正在使用的白板工具
getBrushColor 获取画笔颜色
getBrushThin 获取画笔粗细
getTextColor 获取文本颜色
getTextSize 获取文本大小
getTextStyle 获取文本样式
getLineStyle 获取直线样式
getOvalDrawMode 获取椭圆绘制模式
removeElement 删除白板元素
setToolType 设置要使用的白板工具
setNextTextInput 预设文本工具内容
setBrushColor 设置画笔颜色
setBrushThin 设置画笔粗细
setTextColor 设置文本颜色
setTextSize 设置文本大小
setTextStyle 设置文本样式
setLineStyle 设置直线样式
setOvalDrawMode 设置椭圆绘制模式
setEraseLayerLimit 设置橡皮擦单次擦除图层数量
setEraseLayerType 限制橡皮擦可擦除的白板元素类型
setMathGraphType 设置几何画板元素
setTextFontFamily 设置自定义字体
addTextFontFamily 添加自定义字体
getTextFontFamily 获取当前使用字体
setHighlighterColor 设置荧光笔颜色
getHighlighterColor 获取荧光笔颜色

背景相关

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

撤销和恢复相关

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

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

API 描述
addVideoFile 添加视频文件
enableAudioControl 是否启用音频控制面板 禁止控制面板后,不能通过界面交互方式操作音频元素
getAudioVolume 获取音量
muteAudio 音频是否静音
pauseAudio 暂停音频
playAudio 播放音频
seekAudio 音频跳转到指定位置
setAudioVolume 设置音频音量
applyVideoPermission 授权视频文件播放
hasVideoPermission 是否授权视频文件播放
muteVideo 静音
playVideo 播放
pauseVideo 暂停
showVideoControl 隐藏和显示默认视频控制栏
startSyncVideoStatus 内部启动定时器,定时同步视频状态到远端(仅限于 mp4)
seekVideo 跳转(仅支持点播视频)
setSyncAudioStatusEnable 是否同步本地音频操作状态到远端
setSyncVideoStatusEnable 是否同步本地视频操作状态到远端
stopSyncVideoStatus 停止同步视频状态

截图板书相关接口

API 描述
snapshot 白板快照
addSnapshotMark 生成板书图片

分组讨论相关接口

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

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

发表评论