TEduBoardController
白板功能的主要接口类
类名 | 描述 |
白板控制器 |
TEduBoardController类方法
API | 描述 |
获取缓存的启用状态 | |
获取版本号 | |
获取单实例模式 | |
启用和关闭缓存, 请在 TEduBoardController 初始化之前调用 | |
是否开启单实例模式 |
设置 TEduBoardCallback 回调
API | 描述 |
设置事件回调监听 | |
删除事件回调监听 |
基本流程接口
API | 描述 |
初始化白板 | |
反初始化白板 | |
获取白板渲染 View | |
添加白板同步数据 | |
设置白板是否开启数据同步 | |
获取白板是否开启数据同步 | |
获取同步时间戳 | |
同步远端时间戳 | |
添加资源主备域名映射,主备域名均需包含协议类型(支持 http/https)切换域名重试超时默认为5s多次调用此接口,可为统一主域名添加多个备用域名。如果备用域名已在列表中则不再添加,当主域名不可用时,SDK 将按从前往后的顺序从列表中选择一个备用域名并重试,请务必将可用性高的域名添加到列表前面 | |
删除资源主备域名映射 | |
重置白板 | |
获取版本号 |
白板相关接口
API | 描述 |
增加一页白板 | |
增加一页白板 | |
设置白板是否开启笔锋 | |
获取白板是否开启笔锋 | |
设置鼠标工具行为 | |
设置画笔自动拟合模式 | |
设置远端画笔在本地是否可见 | |
设置缩放锚点 | |
设置缩放工具的缩放比例 | |
是否启用原生系统光标 | |
设置画笔和激光笔工具提示语 | |
获取白板备注 | |
设置白板备注 | |
设置橡皮擦单次擦除图层数量 | |
设置橡皮擦可擦除的白板元素类型 | |
同步本地发送失败的数据到远端并刷新本地数据 | |
设置用户信息 | |
设置输出日志级别 | |
设置白板滚动条是否可见 | |
设置分段擦除模式是否开启 | |
获取分段擦除模式开启状态 | |
设置橡皮擦大小 | |
获取橡皮擦大小 | |
是否本地显示自己的别名 | |
使用数学教具 | |
获取白板中的元素信息 | |
设置元素样式 |
文件操作接口
API | 描述 |
批量导入图片到白板 | |
主动查询文件转码进度 | |
添加转码文件 | |
删除文件 | |
切换文件 | |
切换文件 | |
获取当前文件 ID | |
获取白板中指定文件的文件信息 | |
获取白板中上传的所有文件的文件信息列表 | |
获取指定文件的白板 ID 列表 | |
添加 H5 页面 | |
获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT) | |
对转码后的 H5 PPT 进行静音 | |
课件预加载,提高加载速度,请参考 课件预加载 | |
获取 PPT 的备注 |
白板页操作接口
API | 描述 |
删除一页白板 | |
上一步 每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页 | |
下一步 | |
向前翻页 | |
向后翻页 | |
跳转到指定白板页 | |
向前翻页 | |
向后翻页 | |
跳转到指定白板页 | |
获取当前白板页 ID | |
获取所有文件的白板列表 | |
设置当前白板页宽高比 | |
获取当前白板页宽高比 | |
设置当前白板页缩放比例 | |
获取当前白板页缩放比例 | |
设置白板内容自适应模式 | |
获取白板内容自适应模式 | |
添加图片资源(已废弃,请使用 addElement 接口代替) | |
添加白板元素 | |
删除白板元素 | |
预设文本工具内容 | |
刷新当前页白板,触发 onTEBRefresh 回调 | |
添加白板元素 | |
添加一个数学函数画板 | |
添加公式元素 | |
添加一个数学函数图像 | |
设置几何画板元素 | |
跳转到指定动画步数 | |
获取白板滚动位置 | |
添加一个文本元素 |
涂鸦相关接口
API | 描述 |
设置允许操作哪些用户绘制的图形 | |
设置允许操作哪些用户绘制的图形 1. ERASER 工具只能擦除 users 参数列出的用户绘制的涂鸦,无法擦除其他人绘制的涂鸦 2. POINTSELECT、SELECT 工具只能选中 users 参数列出的用户绘制的涂鸦,无法选中其他人绘制的涂鸦 3. clear 接口只能用于清空选中涂鸦以及 users 参数列出的用户绘制的涂鸦,无法清空背景及其他人绘制的涂鸦 4. 白板包含的其他功能未在本列表明确列出者都可以确定不受本接口影响 | |
设置白板是否允许涂鸦 | |
获取白板是否允许涂鸦 | |
设置要使用的白板工具 | |
获取正在使用的白板工具 | |
设置画笔颜色 | |
获取画笔颜色 | |
设置画笔粗细 | |
获取画笔粗细 | |
设置文本颜色 | |
获取文本颜色 | |
设置文本样式 | |
获取文本样式 | |
设置文本大小 | |
获取文本大小 | |
设置直线样式 | |
获取直线样式 | |
设置椭圆绘制模式 | |
获取椭圆绘制模式 | |
自定义白板工具鼠标样式 | |
预设文本工具内容 | |
获取白板中所有元素 | |
设置自定义字体 | |
添加自定义字体 | |
获取当前使用字体 | |
开启绘制涂鸦过程中自动拟合图形(魔法笔) | |
设置荧光笔颜色 | |
获取荧光笔颜色 |
分组讨论相关接口
API | 描述 |
添加白板到分组 | |
添加用户到分组 | |
获取所有分组 ID | |
获取分组模式状态 | |
获取用户所在的分组 | |
获取分组信息 | |
分组内跳转 | |
从分组中删除白板 | |
删除分组 | |
从分组中删除用户 | |
重置所有分组 | |
添加分组 | |
设置分组标题 | |
开启分组模式 |
清空相关
API | 描述 |
清除涂鸦,同时清空背景色以及背景图片 | |
清除涂鸦 | |
清空当前白板页涂鸦 | |
清空指定文件的所有白板涂鸦 |
背景相关
API | 描述 |
设置白板父容器的背景色 | |
设置所有白板的背景色 | |
获取白板全局背景色 | |
设置当前白板页的背景色 | |
获取当前白板页的背景色 | |
设置当前白板页的背景图片 | |
设置当前白板页的背景 H5 页面 | |
设置全局背景图 | |
获取全局背景图 |
撤销和恢复相关
互动白板音视频文件相关接口
API | 描述 |
添加视频文件 | |
显示或隐藏视频控制栏 | |
播放视频 | |
暂停视频 | |
跳转(仅支持点播视频) | |
是否同步本地视频操作到远端 | |
内部启动定时器,定时同步视频状态到远端(仅限于 MP4) | |
停止同步视频状态 | |
是否同步本地音频操作到远端 | |
是否启用音频控制面板 | |
播放音频 | |
暂停音频 | |
跳转 | |
设置音量 | |
获取音量 |
截图板书相关接口
API | 描述 |
白板快照 | |
生成板书图片标记 需要配合服务端 API 接口来生成,服务端会根据标记点进行快照截图 |