腾讯云互动白板关键类型定义-教育服务解决方案
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 | 缩放移动白板工具 |
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 | 背景图片加载错误 |
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 | 固定圆心,起始点为圆心 |
TEduBoardInitParam
白板初始化参数
属性列表
| 属性 | 类型 | 字段含义 |
| id | String | 必填白板渲染的 dom 节点 ID,需保证该节点有 position: relative 样式,否则可能引起白板定位异常的问题 |
| classId | Number | 必填课堂 ID |
| sdkAppId | Number | 必填腾讯云应用的唯一标识,可登录 实时音视频控制台 查看 |
| userId | String | 必填用户名 |
| userSig | String | 必填登录鉴权信息 |
| ratio | String | 可选默认白板宽高比(可传格式如“4:3”、“16:9”的字符串),默认值 “16:9” |
| drawEnable | Boolean | 可选是否允许涂鸦,默认值 true |
| textStyle | TEduBoardTextStyle | 可选文本样式(0:常规;1:粗体;2:斜体;3:粗斜体),默认值 0 |
| textSize | Number | 可选文本大小,默认值 320 |
| textColor | Color | 可选文本颜色,默认值 #000000 |
| brushColor | Color | 可选画笔颜色,默认值 #ff0000 |
| brushThin | Number | 可选画笔粗细,默认值 100 |
| toolType | TEduBoardToolType | 可选白板工具,默认值 TEDU_BOARD_TOOL_TYPE_PEN |
| globalBackgroundColor | Color | 可选全局背景色,默认值 #ffffff |
| contentFitMode | TEduBoardContentFitMode | 可选内容自适应模式,默认值 TEDU_BOARD_CONTENT_FIT_MODE_NONE |
| dataSyncEnable | Boolean | 可选是否启用数据同步,禁用后将导致本地白板操作不会被同步给远端,默认值 true |
| scale | Number | 可选白板默认缩放系数,实际缩放倍数为 scale/100,默认值 100 |
| preloadDepth | Number | 可选图片预加载深度,默认值 5,表示预加载当前页前后5页的图片 |
| smoothLevel | Number | 可选笔迹平滑系数,默认0.1,范围 [0,1],默认值 0.1 |
| progressEnable | Boolean | 可选是否启用 SDK 内置 Loading 图标,默认值 false |
TEduBoardLineStyle
直线样式
属性列表
| 属性 | 类型 | 字段含义 |
| lineType | TEduBoardLineType | 可选直线类型,默认值 TEDU_BOARD_LINE_TYPE_SOLID |
| startArrowType | TEduBoardArrowType | 可选起点箭头类型,默认值 TEDU_BOARD_ARROW_TYPE_NONE |
| endArrowType | TEduBoardArrowType | 可选终点箭头类型,默认值 TEDU_BOARD_ARROW_TYPE_NONE |
TEduBoardCursorIcon
鼠标样式
属性列表
| 属性 | 类型 | 字段含义 |
| cursor | String | 必填浏览器内置鼠标指针样式,可取值参考文档 |
| url | String | 可选自定义鼠标指针样式的URL,默认值 “”,格式限制参考文档 |
| offsetX | Number | 可选自定义鼠标指针样式的横行偏移,默认值 0 |
| offsetY | Number | 可选自定义鼠标指针样式的纵向偏移,默认值 0 |
TEduBoardTranscodeConfig
文件转码参数
属性列表
| 属性 | 类型 | 字段含义 |
| minResolution | String | 可选指定转码结果最小分辨率,可用于提高转码结果清晰度,格式如960 x 540,宽高用x分隔 |
| isStaticPPT | Boolean | 可选指定对于 PPT 文件是否启用静态转码(转为静态图片),默认转为H5动画(转码耗时较长) |
| thumbnailResolution | String | 可选指定为文件生成缩略图的分辨率,默认不生成缩略图(生成缩略图增加额外转码耗时),格式如200 x 200,宽高用x分隔 |
TEduBoardTranscodeFileResult
文件转码结果
属性列表
| 属性 | 类型 | 字段含义 |
| code | String | 错误码 |
| message | String | 错误信息 |
| taskId | String | 任务ID |
| status | String | 转码状态,”ERROR”: 转码错误,”UPLOADING”: 文件上传中,”CREATED”: 发起转码任务,”QUEUED”: 排队中,”PROCESSING”: 转码中,”FINISHED”: 转码完成 |
| progress | Number | 转码进度 |
| title | String | 文件标题 |
| resolution | String | 文件分辨率 |
| pages | Number | 文件总页数 |
| resultUrl | String | 转码结果 URL |
| thumbnailResolution | String | 为文件生成缩略图的分辨率 |
| thumbnailUrl | String | 为文件生成缩略图 URL |
| userData | String | 透传神奇转码接口的 userData |
TEduBoardInfo
白板信息
属性列表
| 属性 | 类型 | 字段含义 |
| boardId | String | 白板 ID |
| backgroundUrl | String | 白板背景图或者背景 H5 页面的 URL |
| backgroundColor | Color | 白板背景色 |
TEduBoardFileInfo
文件信息
属性列表
| 属性 | 类型 | 字段含义 |
| fileId | String | 文件 ID |
| title | String | 文件名 |
| downloadUrl | String | 文件下载地址 |
| pageIndex | Number | 文件当前显示的页数 |
| pageCount | Number | 文件页数 |
| boardInfoList | Array | 白板信息列表 |
腾讯云官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
发表评论