腾讯云互动白板关键类型定义-教育服务解决方案

关键类型定义

互动白板结构体和常量的定义,请参考 关键类型定义文档。

TEduBoardToolType

白板工具

枚举 含义
TEDU_BOARD_TOOL_TYPE_MOUSE 鼠标
TEDU_BOARD_TOOL_TYPE_PEN 画笔
TEDU_BOARD_TOOL_TYPE_ERASER 橡皮擦
TEDU_BOARD_TOOL_TYPE_LASER 激光笔
TEDU_BOARD_TOOL_TYPE_LINE 直线
TEDU_BOARD_TOOL_TYPE_OVAL 空心椭圆
TEDU_BOARD_TOOL_TYPE_RECT 空心矩形
TEDU_BOARD_TOOL_TYPE_OVAL_SOLID 实心椭圆
TEDU_BOARD_TOOL_TYPE_RECT_SOLID 实心矩形
TEDU_BOARD_TOOL_TYPE_POINT_SELECT 点选工具
TEDU_BOARD_TOOL_TYPE_RECT_SELECT 框选工具
TEDU_BOARD_TOOL_TYPE_TEXT 文本工具
TEDU_BOARD_TOOL_TYPE_ZOOM_DRAG 缩放移动白板工具
TEDU_BOARD_TOOL_TYPE_SQUARE 空心正方形
TEDU_BOARD_TOOL_TYPE_SQUARE_SOLID 实心正方形
TEDU_BOARD_TOOL_TYPE_CIRCLE 空心正圆形
TEDU_BOARD_TOOL_TYPE_CIRCLE_SOLID 实心正圆形
TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH 自定义图形,请配合 AddElement(TEDU_BOARD_ELEMENT_CUSTOM_GRAPH,’自定义图形 URL’)接口使用
TEDU_BOARD_TOOL_TYPE_ARC 圆弧
TEDU_BOARD_TOOL_TYPE_HIGHLIGHTER 荧光笔
TEDU_BOARD_TOOL_TYPE_RIGHT_TRIANGLE 直角三角形
TEDU_BOARD_TOOL_TYPE_ISOSCELES_TRIANGLE 等腰三角形
TEDU_BOARD_TOOL_TYPE_PARALLELOGRAM 平行四边形
TEDU_BOARD_TOOL_TYPE_CUBE 立方体
TEDU_BOARD_TOOL_TYPE_CYLINDER 圆柱
TEDU_BOARD_TOOL_TYPE_CONE 圆锥

TEduBoardElementType

白板元素类型

枚举 含义
TEDU_BOARD_ELEMENT_IMAGE 图片元素
TEDU_BOARD_ELEMENT_H5 H5元素
TEDU_BOARD_ELEMENT_CUSTOM_GRAPH 自定义图形,请与自定义图形工具 TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH 配合使用
TEDU_BOARD_ELEMENT_AUDIO 音频元素,当前白板有效
TEDU_BOARD_ELEMENT_GLOBAL_AUDIO 全局音频元素,无控制界面,一般为背景音乐
TEDU_BOARD_ELEMENT_MATH_BOARD 数学函数画板
TEDU_BOARD_ELEMENT_MATH_GRAPH 数学函数图像
TEDU_BOARD_ELEMENT_GRAFFITI_LINE 画线涂鸦
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_LINE 直线涂鸦
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RECT 矩形涂鸦
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL 椭圆涂鸦
TEDU_BOARD_ELEMENT_TEXT 文本元素
TEDU_BOARD_ELEMENT_MAGIC_LINE 魔法笔元素
TEDU_BOARD_ELEMENT_FORMULA 数学公式元素

TEduBoardErasableElementType

橡皮擦可擦除元素类型

枚举 含义
TEDU_BOARD_ERASABLE_ELEMENT_LINE 画线元素
TEDU_BOARD_ERASABLE_ELEMENT_GRAPH 图形元素
TEDU_BOARD_ERASABLE_ELEMENT_TEXT 文本元素
TEDU_BOARD_ERASABLE_ELEMENT_IMAGE 图片元素
TEDU_BOARD_ERASABLE_ELEMENT_ELEMENT 自定义元素

TEduBoardImageFitMode

白板图片填充对齐模式

枚举 含义
TEDU_BOARD_IMAGE_FIT_MODE_CENTER 以宽度或者高度为基准居中对齐等比例放大
TEDU_BOARD_IMAGE_FIT_MODE_LEFT 以宽度或者高度为基准左对齐等比例放大
TEDU_BOARD_IMAGE_FIT_MODE_TOP 以宽度或者高度为基准顶对齐等比例放大
TEDU_BOARD_IMAGE_FIT_MODE_RIGHT 以宽度或者高度为基准右对齐等比例放大
TEDU_BOARD_IMAGE_FIT_MODE_BOTTOM 以宽度或者高度为基准底对齐等比例放大

介绍

当以宽度基准等比例放大,则居左和居右同居中对齐效果一致;当以高度基准等比例放大,则居顶和居底同居中对齐效果一致

TEduBoardImageStatus

白板图片状态

枚举 含义
TEDU_BOARD_IMAGE_STATUS_LOADING 背景图片正在加载
TEDU_BOARD_IMAGE_STATUS_LOAD_DONE 背景图片加载完成
TEDU_BOARD_IMAGE_STATUS_LOAD_ABORT 背景图片加载中断
TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR 背景图片加载错误
TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT 背景图片加载超时
TEDU_BOARD_IMAGE_STATUS_LOAD_CANCEL 背景图片取消加载
TEDU_BOARD_IMAGE_STATUS_READ_ERROR 背景图片读取失败

TEduBoardPosition

位置类型

枚举 含义
TEDU_BOARD_POSITION_LEFT_TOP 左上方
TEDU_BOARD_POSITION_RIGHT_TOP 右上方
TEDU_BOARD_POSITION_RIGHT_BOTTOM 右下方
TEDU_BOARD_POSITION_LEFT_BOTTOM 左下方

TEduBoardTextStyle

白板文本样式

枚举 含义
TEDU_BOARD_TEXT_STYLE_NORMAL 常规样式
TEDU_BOARD_TEXT_STYLE_BOLD 粗体样式
TEDU_BOARD_TEXT_STYLE_ITALIC 斜体样式
TEDU_BOARD_TEXT_STYLE_BOLD_ITALIC 粗斜体样式

TEduBoardUploadStatus

白板上传状态

枚举 含义
TEDU_BOARD_UPLOAD_STATUS_SUCCEED 上传成功
TEDU_BOARD_UPLOAD_STATUS_FAILED 上传失败

TEduBoardBackgroundH5Status

H5 背景状态

枚举 含义
TEDU_BOARD_BACKGROUND_H5_STATUS_LOADING H5 背景正在加载
TEDU_BOARD_BACKGROUND_H5_STATUS_LOAD_FINISH H5 背景加载完成

TEduBoardContentFitMode

白板内容自适应模式

枚举 含义
TEDU_BOARD_CONTENT_FIT_MODE_NONE 不使用内容自适应,默认模式,不自动调整白板宽高比,内容等比例缩放居中显示,内容宽高 <= 白板宽高
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_INSIDE 自动调整白板宽高比与内容一致,内容铺满白板,白板等比例缩放居中显示,白板宽高 <= 容器宽高
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_COVER 自动调整白板宽高比与内容一致,内容铺满白板,白板等比例缩放居中显示,白板宽高 >= 容器宽高

介绍

内容包括图片、文件、PPT动画

TEduBoardLineType

直线类型

枚举 含义
TEDU_BOARD_LINE_TYPE_SOLID 实线
TEDU_BOARD_LINE_TYPE_DOTTED 虚线

TEduBoardArrowType

箭头类型

枚举 含义
TEDU_BOARD_ARROW_TYPE_NONE 无箭头
TEDU_BOARD_ARROW_TYPE_NORMAL 普通箭头
TEDU_BOARD_ARROW_TYPE_SOLID 实心箭头

TEduBoardOvalDrawMode

椭圆绘制模式

枚举 含义
TEDU_BOARD_OVAL_DRAW_MODE_FIX_START 固定起始点,起始点和终点的中点为圆心
TEDU_BOARD_OVAL_DRAW_MODE_FIX_CENTER 固定圆心,起始点为圆心

TEduBoardFileTranscodeStatus

文件转码状态

枚举 含义
TEDU_BOARD_FILE_TRANSCODE_ERROR 转码错误
TEDU_BOARD_FILE_TRANSCODE_UPLOADING 文件上传中
TEDU_BOARD_FILE_TRANSCODE_CREATED 发起转码任务
TEDU_BOARD_FILE_TRANSCODE_QUEUED 排队中
TEDU_BOARD_FILE_TRANSCODE_PROCESSING 转码中
TEDU_BOARD_FILE_TRANSCODE_FINISHED 转码完成

TEduBoardH5FileStatus

H5 文件状态

枚举 含义
TEDU_BOARD_H5_FILE_STATUS_LOADING 加载中
TEDU_BOARD_H5_FILE_STATUS_LOADED 加载完成

TEduBoardH5PPTStatus

PPT动画文件加载状态

枚举 含义
TEDU_BOARD_H5_PPT_STATUS_LOADING PPT 动画文件加载中
TEDU_BOARD_H5_PPT_STATUS_LOADED PPT 动画文件加载完成
TEDU_BOARD_H5_PPT_STATUS_CANCEL PPT 动画文件取消加载 (本地 PPT 还没有加载完成,就切换到了其他文件)
TEDU_BOARD_H5_PPT_STATUS_TIMEOUT PPT 动画文件加载超时
TEDU_BOARD_H5_PPT_STATUS_RESOURCES_LOADING_ERROR PPT 动画文件加载失败
TEDU_BOARD_H5_PPT_STATUS_RUNTIME_ERROR PPT 动画文件加载内部运行错误

TEduBoardVideoStatus

视频文件状态

枚举 含义
TEDU_BOARD_VIDEO_STATUS_ERROR 播放错误
TEDU_BOARD_VIDEO_STATUS_LOADING 加载中
TEDU_BOARD_VIDEO_STATUS_LOADED 加载完成
TEDU_BOARD_VIDEO_STATUS_PLAYED 开始播放
TEDU_BOARD_VIDEO_STATUS_TIMEUPDATE 时间更新
TEDU_BOARD_VIDEO_STATUS_PAUSED 暂停
TEDU_BOARD_VIDEO_STATUS_SEEKED 跳转
TEDU_BOARD_VIDEO_STATUS_ENDED 结束
TEDU_BOARD_VIDEO_STATUS_WAITING 缓冲中
TEDU_BOARD_VIDEO_STATUS_PLAYING 缓冲结束

TEduBoardAudioStatus

音频状态

枚举 含义
TEDU_BOARD_AUDIO_STATUS_ERROR 播放错误
TEDU_BOARD_AUDIO_STATUS_LOADING 加载中
TEDU_BOARD_AUDIO_STATUS_LOADED 加载完成
TEDU_BOARD_AUDIO_STATUS_PLAYED 开始播放
TEDU_BOARD_AUDIO_STATUS_TIMEUPDATE 时间更新
TEDU_BOARD_AUDIO_STATUS_PAUSED 暂停
TEDU_BOARD_AUDIO_STATUS_SEEKED 跳转
TEDU_BOARD_AUDIO_STATUS_ENDED 结束
TEDU_BOARD_AUDIO_STATUS_WAITING 缓冲中
TEDU_BOARD_AUDIO_STATUS_PLAYING 缓冲结束

TEduBoardKeyEventType

键盘事件类型

枚举 含义
TEDU_BOARD_KEYEVENT_RAWKEYDOWN 表示一个按键从弹起到按下的状态转换过程
TEDU_BOARD_KEYEVENT_KEYDOWN 表示一个按键被按下,根据键盘和语言类型不同,按键会被映射成不同的字符,因此当需要输入字符时应该使用 TEDU_BOARD_KEYEVENT_CHAR 事件
TEDU_BOARD_KEYEVENT_KEYUP 表示一个按键被释放
TEDU_BOARD_KEYEVENT_CHAR 表示一个符号被输入,按键被按下事件根据键盘、区域、操作系统不同,会产生不同的字符,因此请使用该事件用于文本输入

TEduBoardMouseButtonType

鼠标按键类型

枚举 含义
TEDU_BOARD_MOUSEBUTTON_LEFT 鼠标左键
TEDU_BOARD_MOUSEBUTTON_MIDDLE 鼠标中键
TEDU_BOARD_MOUSEBUTTON_RIGHT 鼠标右键

TEduBoardTouchEventType

触摸事件类型

枚举 含义
TEDU_BOARD_TOUCHEVENT_RELEASED 已释放
TEDU_BOARD_TOUCHEVENT_PRESSED 已按下
TEDU_BOARD_TOUCHEVENT_MOVED 已移动
TEDU_BOARD_TOUCHEVENT_CANCELLED 已取消

TEduBoardPointType

点设备类型

枚举 含义
TEDU_BOARD_POINTER_TYPE_TOUCH 手指
TEDU_BOARD_POINTER_TYPE_MOUSE 鼠标
TEDU_BOARD_POINTER_TYPE_PEN
TEDU_BOARD_POINTER_TYPE_ERASER 橡皮
TEDU_BOARD_POINTER_TYPE_UNKNOWN 未知

TEduBoardEventFlag

事件标记位

枚举 含义
TEDU_BOARD_EVENTFLAG_NONE 无标记
TEDU_BOARD_EVENTFLAG_CAPS_LOCK_ON 大写锁定处于打开状态
TEDU_BOARD_EVENTFLAG_SHIFT_DOWN shift 键处于被按下状态
TEDU_BOARD_EVENTFLAG_CONTROL_DOWN ctrl 键处于被按下状态
TEDU_BOARD_EVENTFLAG_ALT_DOWN alt 键处于被按下状态
TEDU_BOARD_EVENTFLAG_LEFT_MOUSE_BUTTON 鼠标左键处于被按下状态
TEDU_BOARD_EVENTFLAG_MIDDLE_MOUSE_BUTTON 鼠标中键处于被按下状态
TEDU_BOARD_EVENTFLAG_RIGHT_MOUSE_BUTTON 鼠标右键处于被按下状态
TEDU_BOARD_EVENTFLAG_COMMAND_DOWN macOS 下 command 键处于被按下状态
TEDU_BOARD_EVENTFLAG_NUM_LOCK_ON 数字锁定处于打开状态
TEDU_BOARD_EVENTFLAG_IS_KEY_PAD 
TEDU_BOARD_EVENTFLAG_IS_LEFT 被按下的是左侧修饰键
TEDU_BOARD_EVENTFLAG_IS_RIGHT 被按下的是右侧修饰键

TEduBoardAccessibleOperation

白板事件类型

枚举 含义
TEDU_BOARD_OPERATION_ALL 全部操作
TEDU_BOARD_OPERATION_MOVE 移动
TEDU_BOARD_OPERATION_DELETE 删除
TEDU_BOARD_OPERATION_SCALE 缩放
TEDU_BOARD_OPERATION_ROTATE 旋转
TEDU_BOARD_OPERATION_SELECTED 选中
TEDU_BOARD_OPERATION_ADD 添加

TEduBoardTextComponentStatus

白板文字工具异常状态码

枚举 含义
TEDU_BOARD_TEXT_COMPONENT_STATUS_INSUFFICIENT_SPACE 空间不足
TEDU_BOARD_TEXT_COMPONENT_STATUS_WORD_LIMIT 文本超出字数限制
TEDU_BOARD_TEXT_COMPONENT_CANNOT_USE_EMOJI 不能使用表情

TEduBoardMathGraphCode

数学函数图像工具状态码

枚举 含义
MATH_EXPRESSION_PARSE_ERROR 函数表达式解析失败

TEduBoardPenFittingMode

画笔自动拟合模式

枚举 含义
NONE 不进行曲线拟合
AUTO 自动识别并拟合图形
RECTANGLE 拟合矩形
POLYGON 拟合多边形
CIRCLE 拟合圆形
ELLIPSE 拟合椭圆

TEduBoardBackgroundType

白板背景类型

枚举 含义
TEDU_BOARD_BACKGROUND_IMAGE 图片类型
TEDU_BOARD_BACKGROUND_H5 网页类型

TEduBoardMathGraphType

几何图形类型

枚举 含义
TEDU_BOARD_MATHGRAPH_NONE 无图形输入,此时可选中几何图形
TEDU_BOARD_MATHGRAPH_POINT
TEDU_BOARD_MATHGRAPH_LINE 直线
TEDU_BOARD_MATHGRAPH_LINE_SEGMENT 线段
TEDU_BOARD_MATHGRAPH_RAY 射线
TEDU_BOARD_MATHGRAPH_CIRCLE
TEDU_BOARD_MATHGRAPH_ANGLE
TEDU_BOARD_MATHGRAPH_POLYGON 多边形
TEDU_BOARD_MATHGRAPH_VECTOR 向量
TEDU_BOARD_MATHGRAPH_ELLIPSE 椭圆
TEDU_BOARD_MATHGRAPH_CUBE 立方体
TEDU_BOARD_MATHGRAPH_CYLINDER 圆柱体
TEDU_BOARD_MATHGRAPH_CIRCULAR_CONE 圆锥体

TEduBoardClassGroupOperationType

白板分组操作

枚举 含义
TEDU_BOARD_GOT_SET_ENABLE 开启分组模式
TEDU_BOARD_GOT_UPDATE 更新分组信息
TEDU_BOARD_GOT_DELETE 删除分组
TEDU_BOARD_GOT_RESET 重置分组
TEDU_BOARD_GOT_ERROR 分组功能发生错误

TEduBoardAuthParam

白板授权参数

属性列表

属性 类型 字段含义
sdkAppId uint32_t SDKAppID
userId const char * 用户 ID
userSig const char * 用户签名

TEduBoardColor

颜色参数

属性列表

属性 类型 字段含义
red uint8_t 红色分量
green uint8_t 绿色分量
blue uint8_t 蓝色分量
alpha uint8_t 透明分量

TEduRoutineConfigInitParam

常规配置参数

属性列表

属性 类型 字段含义
proxyServer const char * 默认为” 为白板服务设置代理服务器,传入一个 JSON 格式字符串。JSON 格式可参考 SetProxyServer 接口
ratio const char * 默认’16:9′ 默认白板宽高比(可传格式如“4:3”、“16:9”的字符串)
progressBarUrl const char * 默认” 自定义加载图标,在 progressEnable = true 时生效,支持 jpg、gif、png、svg
preloadDepth uint32_t 默认5; 图片预加载深度,默认值 5,表示预加载当前页前后5页的图片
scale uint32_t 默认100 白板默认缩放系数,实际缩放倍数为 scale / 100
syncFps uint32_t 默认5 信令同步频率,该值的允许范围为 [5, 20]
scaleRangeBegin uint32_t 默认100 白板缩放范围[100,1600],百分比形式,100表示100,无缩放
scaleRangeEnd uint32_t 默认1600 白板缩放范围[100,1600],百分比形式,100表示100,无缩放
offlineWarningTimeout uint32_t 默认180 白板离线告警时间间隔,单位(秒)
toolType TEduBoardToolType 默认:TEDU_BOARD_TOOL_TYPE_PEN 初始 白板工具类型
boardContentFitMode TEduBoardContentFitMode 默认:TEDU_BOARD_CONTENT_FIT_MODE_NONE 白板内容自适应模式

TEduUserConfigInitParam

用户配置参数

属性列表

属性 类型 字段含义
nickname const char * 默认为” 当前白板用户昵称

TEduStyleConfigInitParam

样式配置参数

属性列表

属性 类型 字段含义
textColor TEduBoardColor 默认’#000000′ 文本颜色
brushColor TEduBoardColor 默认’#ff0000′ 画笔颜色
globalBackgroundColor TEduBoardColor 默认’#ffffff’ 全局背景色
selectBoxColor TEduBoardColor 默认’#ff0000′ 选框颜色,包括选框上的缩放,旋转按钮
windowBackgroundColor TEduBoardColor 窗口背景色,指非白板区域背景色
textStyle TEduBoardTextStyle 默认 TEDU_BOARD_TEXT_STYLE_NORMAL 文本样式;
textSize uint32_t 默认320 文本大小,实际像素值取值(textSize * 白板的高度 / 10000)px
brushThin uint32_t 默认100 画笔粗细,实际像素值取值(brushThin* 白板的高度 / 10000)px

TEduElementOperationAuthority

操作权限参数

属性列表

属性 类型 字段含义
disableRotate bool 默认 false 是否禁用旋转 (文本元素默认为 true,不可更改)
disableMove bool 默认 false 是否禁用移动
disableProportionScale bool 默认 false 是否禁用等比例缩放
disableArbitraryScale bool 默认 false 是否禁用任意缩放 (文本元素默认为 true,不可更改)

TEduMouseToolBehavior

设置鼠标工具行为

属性列表

属性 类型 字段含义
whiteBoard bool 设置鼠标工具在普通白板翻页行为,默认为 true
h5PPT bool 设置鼠标工具在动态 PPT 转码的文件翻页行为,默认为 true
imgPPT bool 设置鼠标工具在静态 PPT 转码文件翻页行为,默认为 true
imgFile bool 设置鼠标工具在图片文件(addImagesFile 接口添加的文件)翻页行为,默认为 true

TEduAuthConfigInitParam

权限配置参数

属性列表

属性 类型 字段含义
drawEnable bool 默认 true 是否允许涂鸦
dataSyncEnable bool 默认 true 是否启用数据同步,禁用后将导致本地白板操作不会被同步给远端
progressEnable bool 默认 false 是否启用 SDK 内置 Loading 图标
systemCursorEnable bool 默认 false 是否启用原生系统光标,该参数说明具体请看 setSystemCursorEnable 接口
enableScaleTool bool 默认 true 是否启用白板缩放移动工具的缩放功能,当设置为 false,切换到缩放移动工具时缩放功能不可用
isAutoHideRemoteCursor bool 默认 false 远端画笔不动2秒后是否自动隐藏
showRemoteSelectBox bool 默认 false 是否显示远端选框
showLocalOperator bool 默认 false 是否显示本地操作信息(选框工具选中白板元素显示白板元素的创建者)
showRemoteOperator bool 默认 false 是否显示远端操作信息(远端使用选框工具时,本地显示远端用户操作的白板元素)
mathGraphEnable bool 默认 false 是否预加载数学函数工具库(若白板历史数据中有数学函数图像元素,会自动加载数学函数工具库)
formulaEnable bool 默认 false 是否预加载公式库
line TEduElementOperationAuthority 画笔涂鸦元素
graph TEduElementOperationAuthority 图形涂鸦元素
text TEduElementOperationAuthority 文本元素
turnPage TEduMouseToolBehavior 设置鼠标工具翻页行为
remoteCursorVisible TEduRemoteCursorVisible 远端画笔是否显示

TEduBoardInitParam

白板初始化参数

属性列表

属性 类型 字段含义
userId const char * 用户名
userSig const char * 登录鉴权信息
id const char * 白板渲染的 dom 节点 ID
experimental const char * 实验性参数集,字典类型 JSON 串
timSync bool 是否使用腾讯云 IMSDK 进行实时数据同步
trtcSync bool 是否启用实时音视频自动对时
imageTimeout uint32_t 图片加载超时时间单位秒默认10s
classId uint32_t 课堂 ID
sdkAppId uint32_t 腾讯云应用的唯一标识
config TEduRoutineConfigInitParam 常规配置参数
userConfig TEduUserConfigInitParam 用户配置参数
styleConfig TEduStyleConfigInitParam 样式配置参数
authConfig TEduAuthConfigInitParam 权限配置参数
audioCallback bool 是否启用音频回调模式(启用后白板内的音频不再播放,而是将 PCM 数据通过回调抛出)

TEduBoardLineStyle

直线样式

属性列表

属性 类型 字段含义
lineType TEduBoardLineType 直线类型
startArrowType TEduBoardArrowType 起点箭头类型
endArrowType TEduBoardArrowType 终点肩头类型

TEduBoardCursorIcon

鼠标样式

属性列表

属性 类型 字段含义
cursor const char * 浏览器内置鼠标指针样式,可取值参考文档,使用自定义图片时,该字段请填写”url”
url const char * 自定义鼠标指针样式的 URL,格式限制参考文档,该字段内容不需要包含”url()”
offsetX uint32_t 自定义鼠标指针样式的横行偏移
offsetY uint32_t 自定义鼠标指针样式的纵向偏移

TEduBoardToolTypeTitleStyle

工具提示语样式

属性列表

属性 类型 字段含义
position TEduBoardPosition 显示位置
color TEduBoardColor 文本颜色
size uint32_t 实际像素值取值(size * 白板的高度 / 10000)px
style TEduBoardTextStyle 文本样式

TEduBoardElementOptions

元素选项

属性列表

属性 类型 字段含义
erasable bool 元素是否可用橡皮擦擦除
left const char * 元素距左边界的偏移,支持像素或百分比,若不填写单位默认按像素计算
top const char * 元素距左边界的偏移,支持像素或百分比,若不填写单位默认按像素计算

TEduBoardSnapshotInfo

快照信息

属性列表

属性 类型 字段含义
path const char * 保存截图的本地路径,编码格式为 UTF8

TEduBoardTranscodeConfig

文件转码参数

属性列表

属性 类型 字段含义
minResolution const char * 指定转码结果最小分辨率,可用于提高转码结果清晰度,格式如960×540,宽高用x分隔
isStaticPPT bool 指定对于 PPT 文件是否启用静态转码(转为静态图片),默认转为 H5 动画(转码耗时较长)
thumbnailResolution const char * 指定为文件生成缩略图的分辨率,默认不生成缩略图(生成缩略图增加额外转码耗时),格式如200×200,宽高用x分隔

TEduBoardTranscodeFileResult

文件转码结果

属性列表

属性 类型 字段含义
taskId char 任务 ID
status TEduBoardFileTranscodeStatus 转码状态
progress double 转码进度,取值范围 [0,100]
title char 文件标题
resolution char 文件分辨率
pages uint32_t 文件总页数
url char 转码结果 URL
thumbnailResolution char 为文件生成缩略图的分辨率
thumbnailUrl char 为文件生成缩略图 URL

TEduBoardInfo

白板信息

属性列表

属性 类型 字段含义
boardId const char * 白板 ID
backgroundUrl const char * 白板背景图或者背景 H5 页面的 URL
backgroundColor TEduBoardColor 白板背景色

TEduAddBoardBase

添加白板元素

TEduAddBoardElementUrl

添加白板元素(类型不包括数学函数图像和数学函数画板)

属性列表

属性 类型 字段含义
strUrl const char * URL 地址

TEduAddBoardElementMathGraph

添加一个数学函数图像

属性列表

属性 类型 字段含义
mathBoardId const char * 
expression const char * 
color TEduBoardColor 
selectedColor TEduBoardColor 

TEduAddBoardElementMathBoard

添加一个数学函数画板

属性列表

属性 类型 字段含义
showControl bool 画板显示区域的左上角和右下角,对应[x1, y1, x2, y2]
enableZoom bool 是否开启鼠标滚轮缩放(需要按住 Shift)
enablePan bool 是否开启鼠标拖拽平移(需要按住 Shift)
axis bool 是否显示坐标轴
grid bool 是否显示网格
leftX int 画板显示区域的左上角x
leftY int 画板显示区域的左上角y
rightX int 画板显示区域的右下角x
rightY int 画板显示区域的右下角y
width const char * 画板宽度,支持像素或百分比,若不填写单位默认按像素计算
height const char * 画板高度,支持像素或百分比,若不填写单位默认按像素计算
axisColor TEduBoardColor 画板坐标系颜色

TEduAddBoardElementFormula

添加一个公式元素

属性列表

属性 类型 字段含义
expression const char * 公式元素

TEduBoardInfoList

白板信息列表

GetCount

获取白板信息个数

virtual uint32_t GetCount() const =0

返回

白板信息个数

GetBoardInfo

获取指定的白板信息

virtual TEduBoardInfo GetBoardInfo(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 白板个数)

返回

白板信息

TEduBoardSelectedElementInfo

元素信息

属性列表

属性 类型 字段含义
elementId std::string 元素 ID
type TEduBoardElementType 元素类型
left int 元素距离白板容器左侧距离
top int 元素距离白板容器顶部距离
width int 元素宽度
height int 元素高度
rotate double 元素旋转角度
boundingbox_left int 元素包围盒距离白板容器左侧距离
boundingbox_top int 元素包围盒距离白板容器顶部距离
boundingbox_width int 元素包围盒宽度
boundingbox_height int 元素包围盒高度

TEduBoardSelectedElementInfoList

选中的白板元素信息列表

GetCount

选中的白板元素信息列表

virtual uint32_t GetCount() const =0

返回

选中的白板元素信息列表个数

GetBoardSelectedElementInfo

获取指定的白板元素信息

virtual TEduBoardSelectedElementInfo GetBoardSelectedElementInfo(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 白板元素信息)

返回

白板元素信息

TEduBoardElementInfo

元素信息

属性列表

属性 类型 字段含义
boardId const char * 白板 ID
elementId const char * 元素 ID
type TEduBoardElementType 元素类型
url const char * 元素地址

TEduBoardElementInfoList

元素信息列表

GetCount

获取元素信息个数

virtual uint32_t GetCount() const =0

返回

元素信息个数

GetElementInfo

获取指定的元素信息

virtual TEduBoardElementInfo GetElementInfo(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 白板个数)

返回

元素信息

Release

释放元素信息列表

virtual void Release()=0

警告

元素信息列表使用完之后,务必调用该接口以释放内存

TEduBoardFileInfo

文件信息

属性列表

属性 类型 字段含义
fileId const char * 文件 ID
title const char * 文件名
downloadUrl const char * 文件下载地址
pageIndex uint32_t 文件当前显示的页数
pageCount uint32_t 文件页数
boardInfoList const TEduBoardInfoList * 白板信息列表
fileType const TEduBoardFileType * 文件类型

TEduBoardKeyEvent

键盘事件

属性列表

属性 类型 字段含义
type TEduBoardKeyEventType 键盘事件类型
modifiers uint32_t 按位描述键盘修饰键状态,取值参考 TEduBoardEventFlag
windowsKeyCode int Windows 按键码,该值用于 DOM 规范,Windows 下它来自系统事件,其他平台下用映射函数确定(参考文档 https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes)
nativeKeyCode int 由平台产生的真实按键码
isSystemKey int 指定该事件是否为”系统按键”事件,只有 Windows 系统下该值才有效
character wchar_t 按键产生的字符
unmodifiedCharacter wchar_t 按键产生的字符,但是忽略修饰键的影响(除了 shift 之外),该值主要用于触发快捷键
focusOnEditableField int 当处于文本编辑区域时,该值为1,该值主要用于判断是否应该拦截某些按键事件的传递

TEduBoardMouseEvent

鼠标事件

属性列表

属性 类型 字段含义
x int 以视图左上角为原点的X坐标轴
y int 以视图左上角为原点的Y坐标轴
modifiers uint32_t 按位描述键盘修饰键状态,取值参考 TEduBoardEventFlag

TEduBoardTouchEvent

触摸事件

属性列表

属性 类型 字段含义
id int 触摸点 ID,可以取-1之外的任意值,注意最多支持同时追踪16个触摸点,超过则会被忽略
x float 以视图左上角为原点的 X 坐标轴
y float 以视图左上角为原点的 Y 坐标轴
radiusX float X轴半径(单位像素),如果不适用,传0
radiusY float Y轴半径(单位像素),如果不适用,传0
rotationAngle float 旋转角度(单位弧度),如果不适用,传0
pressure float 触摸点的归一化压力值,范围 [0,1],如果不适用,传0
type TEduBoardTouchEventType 触摸点状态,触摸由 TEDU_BOARD_TOUCHEVENT_PRESSED 事件开始,后接 0~N 个 TEDU_BOARD_TOUCHEVENT_MOVED 事件,最终以 TEDU_BOARD_TOUCHEVENT_RELEASED 或 TEDU_BOARD_TOUCHEVENT_CANNELLED 事件结束, 不符合该规则的事件将被忽略
modifiers uint32_t 按位描述键盘修饰键状态,取值参考 TEduBoardEventFlag
pointerType TEduBoardPointType 触发事件的设备类型

TEduBoardRect

矩形区域

属性列表

属性 类型 字段含义
x int32_t 矩形起始位置 X 轴坐标
y int32_t 矩形起始位置 Y 轴坐标
width int32_t 矩形宽度
height int32_t 矩形高度

TEduUserInfo

用户信息

属性列表

属性 类型 字段含义
nickname const char * 

TEduBoardFileInfoList

文件信息列表

GetCount

获取文件信息个数

virtual uint32_t GetCount() const =0

返回

文件信息个数

GetFileInfo

获取指定的文件信息

virtual TEduBoardFileInfo GetFileInfo(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 文件个数)

返回

文件信息

Release

释放文件信息列表

virtual void Release()=0

警告

文件信息列表使用完之后,务必调用该接口以释放内存

TEduBoardStringList

字符串列表

GetCount

获取字符串个数

virtual uint32_t GetCount() const =0

返回

字符串个数

GetString

获取指定的字符串

virtual const char* GetString(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 字符串个数)

返回

字符串

警告

返回值内存由 SDK 内部管理,不需要用户自行释放

Release

释放字符串列表

virtual void Release()=0

警告

字符串列表使用完之后,务必调用该接口以释放内存

TEduBoardReMarkInfo

白板备注信息

属性列表

属性 类型 字段含义
boardId const char * 白板 ID
reMark const char * 白板备注

TEduBoardReMarkInfoList

白板备注列表

GetCount

获取白板备注信息个数

virtual uint32_t GetCount() const =0

返回

白板备注信息个数

GetBoardReMarkInfo

获取指定的白板备注信息

virtual TEduBoardReMarkInfo GetBoardReMarkInfo(uint32_t index) const =0

参数

参数 类型 含义
index uint32_t 索引,取值范围 [0, 文件个数)

返回

白板备注信息

Release

释放白板备注信息列表

virtual void Release()=0

警告

白板备注信息列表使用完之后,务必调用该接口以释放内存

TEduBoardClassGroupInfo

组信息

属性列表

属性 类型 字段含义
classGroupId const char * 白板 ID
currentBoardId const char * 
title const char * 
boardIdList const TEduBoardStringList * 
userIdList const TEduBoardStringList * 

TEduBoardLogLevel

日志级别

属性列表

属性 字段含义
TEDU_BOARD_LOG_LEVEL_ALL 全部日志
TEDU_BOARD_LOG_LEVEL_INFO 一般日志
TEDU_BOARD_LOG_LEVEL_WARNING 告警日志
TEDU_BOARD_LOG_LEVEL_ERROR 错误日志
TEDU_BOARD_LOG_LEVEL_OFF 不打印日志

TEduBoardFileType

白板文件类型

属性列表

属性 字段含义
TEDU_FT_WHITEBOARD 默认白板组
TEDU_FT_H5_COURSEWARE 动态转码课件
TEDU_FT_IMAGE_COURSEWARE 静态转码课件
TEDU_FT_VIDEO_FILE 视频文件
TEDU_FT_H5_FILE H5文件
TEDU_FT_IMAGES_FILE 图片组文件

TeduElementOperatorType

白板文件类型

属性列表

属性 字段含义
TEDU_EOP_BOARDER_COLOR 边框颜色
TEDU_EOP_BOARDER_WIDTH 边线宽
TEDU_EOP_BOARDER_LINE_TYPE 边线虚实类型
TEDU_EOP_EL_DELETE 删除元素

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

发表评论