TEduBoard
白板功能的主要接口类
类名 | 描述 |
TEduBoard | 白板控制器 |
创建销毁实例
设置 TEduBoardCallback 回调
基本流程接口
API | 描述 |
添加白板同步数据 | |
获取 SDK 版本号 | |
设置白板是否开启数据同步 | |
获取白板是否开启数据同步 | |
重置白板，会清空所有的白板数据 |
白板操作接口
API | 描述 |
确认数据是否发送成功 | |
添加资源主备域名映射 | |
刷新当前页白板，触发 TEB_REFRESH 回调 | |
删除资源主备域名映射 | |
设置鼠标工具行为 | |
设置画笔自动拟合模式 | |
设置服务的代理服务器 | |
设置远端画笔在本地是否可见 | |
移动白板 | |
设置缩放工具的缩放比例 | |
是否启用原生系统光标 | |
同步本地发送失败的数据到远端并刷新本地数据 | |
获取白板是否允许涂鸦 | |
重新计算白板大小，并渲染 | |
设置白板是否允许涂鸦 | |
设置允许操作哪些用户绘制的图形 | |
设置输出日志级别 | |
设置白板滚动条是否可见 | |
设置分段擦除模式是否开启 | |
获取分段擦除模式开启状态 | |
设置橡皮擦大小 | |
获取橡皮擦大小 | |
是否显示自己的别名 | |
使用数学尺规教具 | |
开启绘制涂鸦过程中自动拟合图形(魔法笔) | |
获取元素信息 | |
设置元素样式 |
文件操作接口
API | 描述 |
添加 H5 页面 | |
批量导入图片到白板 | |
添加转码文件 | |
添加视频文件（内部接口） | |
删除文件 | |
主动查询文件转码进度 | |
获取当前文件 ID | |
获取白板中指定文件的文件信息 | |
获取白板中上传的所有文件的文件信息列表 | |
获取指定文件的白板 ID 列表 | |
获取指定文件的缩略图，不支持默认文件（fileId=#DEFAULT） | |
获取白板是否开启笔锋 | |
设置点播视频的额外参数，如 plugins、hlsConfig 等，具体请参考 云点播开发文档 | |
设置文件缩放比例 | |
切换文件 | |
设置白板是否开启笔锋 | |
对转码后的 H5PPT 进行静音 | |
获取指定课件的备注 |
白板页操作接口
API | 描述 |
增加一页白板 | |
添加白板元素 | |
删除一页白板 | |
获取白板内容自适应模式 | |
获取白板元素列表 | |
获取所有文件的白板列表 | |
获取当前白板页宽高比 | |
获取当前白板页缩放比例 | |
获取当前白板页 ID | |
跳转到指定白板页 | |
下一步 | |
向后翻页 | |
上一步，每个 Step 对应 PPT 的一个动画效果，若当前没有已展示的动画效果，则该接口调用会导致向前翻页 | |
向前翻页 | |
设置白板内容自适应模式 | |
设置当前白板页宽高比 | |
设置当前白板页缩放比例 | |
获取白板备注 | |
设置白板备注 | |
自定义白板工具鼠标样式 | |
自定义缩放工具的图标 | |
跳转到指定动画步数 | |
获取白板滚动位置 |
清空相关
API | 描述 |
清空当前白板页涂鸦 | |
清空指定文件的所有白板涂鸦 |
涂鸦相关
API | 描述 |
获取正在使用的白板工具 | |
获取画笔颜色 | |
获取画笔粗细 | |
获取文本颜色 | |
获取文本大小 | |
获取文本样式 | |
获取直线样式 | |
获取椭圆绘制模式 | |
删除白板元素 | |
设置要使用的白板工具 | |
预设文本工具内容 | |
设置画笔颜色 | |
设置画笔粗细 | |
设置文本颜色 | |
设置文本大小 | |
设置文本样式 | |
设置直线样式 | |
设置椭圆绘制模式 | |
设置橡皮擦单次擦除图层数量 | |
限制橡皮擦可擦除的白板元素类型 | |
设置几何画板元素 | |
设置自定义字体 | |
添加自定义字体 | |
获取当前使用字体 | |
设置荧光笔颜色 | |
获取荧光笔颜色 |
背景相关
API | 描述 |
设置当前白板页的背景图片 | |
设置所有白板的背景色 | |
设置当前白板页的背景色 | |
获取白板全局背景色 | |
获取当前白板页的背景色 | |
设置当前白板页的背景 H5 页面 | |
设置全局背景图 | |
获取全局背景图 |
撤销和恢复相关
互动白板音视频文件相关接口
API | 描述 |
添加视频文件 | |
是否启用音频控制面板 禁止控制面板后，不能通过界面交互方式操作音频元素 | |
获取音量 | |
音频是否静音 | |
暂停音频 | |
播放音频 | |
音频跳转到指定位置 | |
设置音频音量 | |
授权视频文件播放 | |
是否授权视频文件播放 | |
静音 | |
播放 | |
暂停 | |
隐藏和显示默认视频控制栏 | |
内部启动定时器，定时同步视频状态到远端（仅限于 mp4） | |
跳转（仅支持点播视频） | |
是否同步本地音频操作状态到远端 | |
是否同步本地视频操作状态到远端 | |
停止同步视频状态 |
截图板书相关接口
API | 描述 |
白板快照 | |
生成板书图片 |
分组讨论相关接口
API | 描述 |
添加白板到分组 | |
添加用户到分组 | |
获取所有分组 ID | |
获取分组模式状态 | |
获取用户所在的分组 | |
获取分组信息 | |
分组内跳转 | |
从分组中移除白板 | |
删除分组 | |
从分组中移除用户 | |
重置所有分组 | |
设置分组 | |
开启分组模式 | |
设置分组标题 |
