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

TEduBoardController

白板功能的主要接口类

类名 描述
TEduBoardController 白板控制器

TEduBoardController类方法

API 描述
enableCache 获取缓存的启用状态
getVersion 获取版本号
isSingleMode 获取单实例模式
setEnableCache 启用和关闭缓存, 请在 TEduBoardController 初始化之前调用
setSingleMode 是否开启单实例模式

设置 TEduBoardCallback 回调

API 描述
addDelegate: 设置事件回调监听
removeDelegate: 删除事件回调监听

基本流程接口

API 描述
initWithAuthParam:roomId:initParam: 初始化白板
unInit 反初始化白板
getBoardRenderView 获取白板渲染 View
addSyncData: 添加白板同步数据
setDataSyncEnable: 设置白板是否开启数据同步
isDataSyncEnable 获取白板是否开启数据同步
getSyncTime 获取同步时间戳
syncRemoteTime:timestamp: 同步远端时间戳
addBackupDomain:backup:priority: 添加资源主备域名映射,主备域名均需包含协议类型(支持 http/https)切换域名重试超时默认为5s多次调用此接口,可为统一主域名添加多个备用域名。如果备用域名已在列表中则不再添加,当主域名不可用时,SDK 将按从前往后的顺序从列表中选择一个备用域名并重试,请务必将可用性高的域名添加到列表前面
removeBackupDomain:backup: 删除资源主备域名映射
reset 重置白板
getVersion 获取版本号

白板相关接口

API 描述
addBoard:model:type:needSwitch: 增加一页白板
addBoardWithBackgroundImage: 增加一页白板
setHandwritingEnable: 设置白板是否开启笔锋
isHandwritingEnable 获取白板是否开启笔锋
setMouseToolBehavior: 设置鼠标工具行为
setPenAutoFittingMode: 设置画笔自动拟合模式
setRemoteCursorVisible: 设置远端画笔在本地是否可见
setScaleAnchor:yRatio: 设置缩放锚点
setScaleToolRatio: 设置缩放工具的缩放比例
setSystemCursorEnable: 是否启用原生系统光标
setToolTypeTitle:style:toolType: 设置画笔和激光笔工具提示语
getBoardRemark: 获取白板备注
setBoard:remark: 设置白板备注
setEraseLayerLimit: 设置橡皮擦单次擦除图层数量
setEraseLayerType: 设置橡皮擦可擦除的白板元素类型
syncAndReload 同步本地发送失败的数据到远端并刷新本地数据
setUserInfo: 设置用户信息
setLogLevel: 设置输出日志级别
setScrollBarVisible: 设置白板滚动条是否可见
setPiecewiseErasureEnable 设置分段擦除模式是否开启
isPiecewiseErasureEnable 获取分段擦除模式开启状态
setEraserSize 设置橡皮擦大小
getEraserSize 获取橡皮擦大小
setOwnerNickNameVisible 是否本地显示自己的别名
useMathTool 使用数学教具
getElementById 获取白板中的元素信息
updateElement 设置元素样式

文件操作接口

API 描述
addImagesFile: 批量导入图片到白板
getFileTranscodeProgress: 主动查询文件转码进度
addTranscodeFile:needSwitch: 添加转码文件
deleteFile: 删除文件
switchFile: 切换文件
switchFile:boardId:stepIndex: 切换文件
getCurrentFile 获取当前文件 ID
getFileInfo: 获取白板中指定文件的文件信息
getFileInfoList 获取白板中上传的所有文件的文件信息列表
getFileBoardList: 获取指定文件的白板 ID 列表
addH5File: 添加 H5 页面
getThumbnailImages: 获取指定文件的缩略图,不支持默认文件(fileId=#DEFAULT)
soundMuteForPPT: 对转码后的 H5PPT 进行静音
loadResource: 课件预加载,提高加载速度,请参考 课件预加载
getPPTRemarks 获取 PPT 的备注

白板页操作接口

API 描述
deleteBoard: 删除一页白板
prevStep 上一步
每个 Step 对应 PPT 的一个动画效果,若当前没有已展示的动画效果,则该接口调用会导致向前翻页
nextStep 下一步
preBoard 向前翻页
nextBoard 向后翻页
gotoBoard: 跳转到指定白板页
preBoard: 向前翻页
nextBoard: 向后翻页
gotoBoard:resetStep: 跳转到指定白板页
getCurrentBoard 获取当前白板页 ID
getBoardList 获取所有文件的白板列表
setBoardRatio: 设置当前白板页宽高比
getBoardRatio 获取当前白板页宽高比
setBoardScale: 设置当前白板页缩放比例
getBoardScale 获取当前白板页缩放比例
setBoardContentFitMode: 设置白板内容自适应模式
getBoardContentFitMode 获取白板内容自适应模式
addImageElement: 添加图片资源(已废弃,请使用 addElement 接口代替)
addElement:type: 添加白板元素
removeElement: 删除白板元素
setNextTextInput:focus: 预设文本工具内容
refresh 刷新当前页白板,触发 onTEBRefresh 回调
addElement:type:options: 添加白板元素
addElementWithBoard:options: 添加一个数学函数画板
addElementWithExpression:type: 添加公式元素
addElementWithGraph:options: 添加一个数学函数图像
setMathGraphType:mouseTool: 设置几何画板元素
gotoStep 跳转到指定动画步数
getBoardScroll) 获取白板滚动位置
addTextElement 添加一个文本元素

涂鸦相关接口

API 描述
setAccessibleUsers: 设置允许操作哪些用户绘制的图形
setAccessibleUsers:operationType: 设置允许操作哪些用户绘制的图形 1. ERASER 工具只能擦除 users 参数列出的用户绘制的涂鸦,无法擦除其他人绘制的涂鸦 2. POINTSELECT、SELECT 工具只能选中 users 参数列出的用户绘制的涂鸦,无法选中其他人绘制的涂鸦 3. clear 接口只能用于清空选中涂鸦以及 users 参数列出的用户绘制的涂鸦,无法清空背景及其他人绘制的涂鸦4. 白板包含的其他功能未在本列表明确列出者都可以确定不受本接口影响
setDrawEnable: 设置白板是否允许涂鸦
isDrawEnable 获取白板是否允许涂鸦
setToolType: 设置要使用的白板工具
getToolType 获取正在使用的白板工具
setBrushColor: 设置画笔颜色
getBrushColor 获取画笔颜色
setBrushThin: 设置画笔粗细
getBrushThin 获取画笔粗细
setTextColor: 设置文本颜色
getTextColor 获取文本颜色
setTextStyle: 设置文本样式
getTextStyle 获取文本样式
setTextSize: 设置文本大小
getTextSize 获取文本大小
setLineStyle: 设置直线样式
getLineStyle 获取直线样式
setOvalDrawMode: 设置椭圆绘制模式
getOvalDrawMode 获取椭圆绘制模式
setCursorIcon:cursorIcon: 自定义白板工具鼠标样式
setZoomCursorIcon:zoomOutCursorIcon: 预设文本工具内容
getBoardElementList 获取白板中所有元素
setTextFontFamily 设置自定义字体
addTextFontFamily 添加自定义字体
getTextFontFamily 获取当前使用字体
enablePenAutoFit 开启绘制涂鸦过程中自动拟合图形(魔法笔)
setHighlighterColor 设置荧光笔颜色
getHighlighterColor 获取荧光笔颜色

分组讨论相关接口

API 描述
addBoard:toClassGroup: 添加白板到分组
addUser:toClassGroup: 添加用户到分组
getAllClassGroupIds 获取所有分组 ID
getClassGroupEnable 获取分组模式状态
getClassGroupIdByUserId: 获取用户所在的分组
getClassGroupInfoById: 获取分组信息
gotoClassGroupBoard: 分组内跳转
removeBoard:inClassGroup: 从分组中删除白板
removeClassGroup: 删除分组
removeUser:inClassGroup: 从分组中删除用户
resetClassGroup 重置所有分组
setClassGroup:boards:users:title:currentBoardId: 添加分组
setClassGroup:title: 设置分组标题
setClassGroupEnable: 开启分组模式

清空相关

API 描述
clear 清除涂鸦,同时清空背景色以及背景图片
clearDraws 清除涂鸦
clearBackground:andSelected: 清空当前白板页涂鸦
clearFileDraws: 清空指定文件的所有白板涂鸦

背景相关

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

撤销和恢复相关

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

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

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

截图板书相关接口

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



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

发表评论