腾讯云互动白板关键类型定义-教育服务解决方案
TEduBoardErrorCode
出现此错误表示白板已经不可用,白板错误码 TEduBoardErrorCode
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_ERROR_INIT | NSInteger | 1 | 初始化失败 |
TEDU_BOARD_ERROR_AUTH | NSInteger | 2 | 服务鉴权失败,请先购买服务 |
TEDU_BOARD_ERROR_LOAD | NSInteger | 3 | 白板加载失败,监听到此错误,建议进行重试 |
TEDU_BOARD_ERROR_TIM_INVALID | NSInteger | 5 | 互动白板内置 IMSDK 不可用互动白板内部会反射调用 IMSDK 接口,如果 IMSDK 升级了后则会调用失败请参考 TIM 同步信令通道 文档 |
TEDU_BOARD_ERROR_HISTORYDATA | NSInteger | 6 | 同步历史数据失败,监听到此错误,建议进行重试 |
TEDU_BOARD_ERROR_RUNTIME | NSInteger | 7 | 白板运行错误,请检查 sdkAppId、userId、userSig 是否正确;请根据错误信息描述,查阅错误码文档 |
TEDU_BOARD_ERROR_AUTH_TIMEOUT | NSInteger | 8 | 服务鉴权超时,可以存在网络问题,请重试 |
TEDU_BOARD_MAX_BOARD_LIMITED | NSInteger | 10 | 单课堂内白板页数已经到达上限 |
TEDU_BOARD_SIGNATURE_EXPIRED | NSInteger | 11 | userSig 过期, 请生成新的 usersig,并重新初始化白板 |
TEDU_BOARD_ERROR_PATH_INVALID | NSInteger | 102 | 路径非法 |
TEDU_BOARD_ERROR_WRITE_ERROR | NSInteger | 103 | 文件写入错误 |
TEduBoardWarningCode
警告级别,不会影响白板,使用白板警告码 TEduBoardWarningCode
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_WARNING_SYNC_DATA_PARSE_FAILED | NSInteger | 1 | 接收到其他端的同步数据解析错误,出现该警告的原因一般为业务方修改了白板信令数据结构或者将非白板信令也传递给了白板 |
TEDU_BOARD_WARNING_TIM_SEND_MSG_FAILED | NSInteger | 2 | 使用互动白板内部通过反射调用 IM 发送消息失败 |
TEDU_BOARD_WARNING_H5PPT_ALREADY_EXISTS | NSInteger | 3 | 调用 addTranscodeFile 接口时候传入的课件已经存在,msg 中包含了 fileId,可直接使用 switchFile 进行切换 |
TEDU_BOARD_WARNING_ILLEGAL_OPERATION | NSInteger | 5 | 互动白板历史数据加载完成回调(onTEBHistroyDataSyncCompleted)之前禁止调用接口进行操作白板 |
TEDU_BOARD_WARNING_H5FILE_ALREADY_EXISTS | NSInteger | 6 | 调用 addH5File 接口传入的 h5 url 已经存在 |
TEDU_BOARD_WARNING_VIDEO_ALREADY_EXISTS | NSInteger | 7 | 调用 addVideoFile 接口传入的 video url 已经存在 |
TEDU_BOARD_WARNING_IMAGESFILE_ALREADY_EXISTS | NSInteger | 8 | 调用 addImagesFile 接口传入的图片数组数据已经存在 |
TEDU_BOARD_WARNING_CUSTOM_GRAPH_URL_NON_EXISTS | NSInteger | 10 | 自定义图形的 URL 不存在 |
TEDU_BOARD_WARNING_IMAGESFILE_TOO_LARGE | NSInteger | 11 | addImagesFile 接口添加图片集合文件时,文件内容过大 |
TEDU_BOARD_WARNING_IMAGE_COURSEWARE_ALREADY_EXISTS | NSInteger | 12 | addTranscodeFile 接口添加静态转码课件时,要添加的静态转码课件已存在 |
TEDU_BOARD_WARNING_IMAGE_MEDIA_BITRATE_TOO_LARGE | NSInteger | 13 | 添加多媒体资源 多媒体资源码率过大 |
TEduBoardAccessibleOperation
互动白板可操作权限
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_OPERATION_ALL | NSInteger | 0 | 全部操作 |
TEDU_BOARD_OPERATION_MOVE | NSInteger | 1 | 移动 |
TEDU_BOARD_OPERATION_DELETE | NSInteger | 2 | 删除 |
TEDU_BOARD_OPERATION_SCALE | NSInteger | 3 | 缩放 |
TEDU_BOARD_OPERATION_ROTATE | NSInteger | 4 | 旋转 |
TEDU_BOARD_OPERATION_SELECTED | NSInteger | 5 | 选中 |
TEDU_BOARD_OPERATION_ADD | NSInteger | 6 | 添加 |
TEduBoardArrowType
箭头类型
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_ARROW_TYPE_NONE | NSInteger | 1 | 无箭头 |
TEDU_BOARD_ARROW_TYPE_NORMAL | NSInteger | 2 | 普通箭头 |
TEDU_BOARD_ARROW_TYPE_SOLID | NSInteger | 3 | 实线箭头 |
TEduBoardAudioStatus
音频文件状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_AUDIO_STATUS_ERROR | NSInteger | 1 | 播放错误 |
TEDU_BOARD_AUDIO_STATUS_LOADING | NSInteger | 2 | 加载中 |
TEDU_BOARD_AUDIO_STATUS_LOADED | NSInteger | 3 | 加载完成 |
TEDU_BOARD_AUDIO_STATUS_PLAYED | NSInteger | 4 | 开始播放 |
TEDU_BOARD_AUDIO_STATUS_TIMEUPDATE | NSInteger | 5 | 时间更新 |
TEDU_BOARD_AUDIO_STATUS_PAUSED | NSInteger | 6 | 暂停 |
TEDU_BOARD_AUDIO_STATUS_SEEKED | NSInteger | 7 | 跳转 |
TEDU_BOARD_AUDIO_STATUS_ENDED | NSInteger | 8 | 结束 |
TEDU_BOARD_AUDIO_STATUS_WAITING | NSInteger | 9 | 缓冲中 |
TEDU_BOARD_AUDIO_STATUS_PLAYING | NSInteger | 10 | 缓冲结束 |
TEduBoardBackgroundH5Status
H5 背景状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_BACKGROUND_H5_STATUS_LOADING | NSInteger | 1 | H5 背景正在加载 |
TEDU_BOARD_BACKGROUND_H5_STATUS_LOAD_FINISH | NSInteger | 2 | H5 背景加载完成 |
TEduBoardBackgroundType
白板背景类型
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_BACKGROUND_IMAGE | NSInteger | 1 | 图片类型 |
TEDU_BOARD_BACKGROUND_H5 | NSInteger | 2 | 网页类型 |
TEduBoardClassGroupOperationType
白板分组操作
枚举 | 类型 | 值 | 描述 |
TEduBoardClassGroupOperationTypeSET_ENABLE | NSInteger | 0 | 开启分组模式 |
TEduBoardClassGroupOperationTypeUPDATE | NSInteger | 1 | 更新分组信息 |
TEduBoardClassGroupOperationTypeDELETE | NSInteger | 2 | 删除分组 |
TEduBoardClassGroupOperationTypeRESET | NSInteger | 3 | 重置分组 |
TEduBoardClassGroupOperationTypeERROR | NSInteger | 4 | 分组功能发生错误 |
TEduBoardContentFitMode
白板内容自适应模式
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_CONTENT_FIT_MODE_NONE | NSInteger | 0 | 不使用内容自适应,默认模式,不自动调整白板宽高比,内容等比例缩放居中显示,内容宽高 <= 白板宽高 |
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_INSIDE | NSInteger | 1 | 自动调整白板宽高比与内容一致,内容铺满白板,白板等比例缩放居中显示,白板宽高 <= 容器宽高 |
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_COVER | NSInteger | 2 | 自动调整白板宽高比与内容一致,内容铺满白板,白板等比例缩放居中显示,白板宽高 >= 容器宽高 |
TEduBoardElementType
元素类型
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_ELEMENT_IMAGE | NSInteger | 1 | 图片元素 |
TEDU_BOARD_ELEMENT_H5 | NSInteger | 2 | 网页元素 |
TEDU_BOARD_ELEMENT_CUSTOM_GRAPH | NSInteger | 3 | 自定义图形 |
TEDU_BOARD_ELEMENT_AUDIO | NSInteger | 4 | 音频元素,当前白板有效 |
TEDU_BOARD_ELEMENT_GLOBAL_AUDIO | NSInteger | 5 | 全局音频元素,无控制界面,一般为背景音乐 |
TEDU_BOARD_ELEMENT_MATH_BOARD | NSInteger | 6 | 数学函数画板 |
TEDU_BOARD_ELEMENT_MATH_GRAPH | NSInteger | 7 | 数学函数图像 |
TEDU_BOARD_ELEMENT_TEXT | NSInteger | 9 | 文本元素 |
TEDU_BOARD_ELEMENT_MAGIC_LINE | NSInteger | 10 | 魔法笔元素 |
TEDU_BOARD_ELEMENT_FORMULA | NSInteger | 11 | 数学公式元素 |
TEDU_BOARD_ELEMENT_GRAFFITI_LINE | NSInteger | 801 | 画线涂鸦 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_LINE | NSInteger | 802 | 直线涂鸦 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL | NSInteger | 804 | 椭圆涂鸦 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RECT | NSInteger | 803 | 矩形涂鸦 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL | NSInteger | 804 | 椭圆涂鸦 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_ARC | NSInteger | 805 | 圆弧元素 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RIGHT_TRIANGLE | NSInteger | 806 | 直角三角形 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_ISOSCELES_TRIANGLE | NSInteger | 807 | 等腰三角形 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_PARALLELOGRAM | NSInteger | 808 | 平行四边形 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CUBE | NSInteger | 809 | 立方体 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CYLINDER | NSInteger | 810 | 圆柱体 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CONE | NSInteger | 811 | 圆锥体 |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_HIGHLIGHTER | NSInteger | 812 | 荧光笔 |
TEduBoardErasableElementType
白板可擦除元素类型
枚举 | 类型 | 值 | 描述 |
LINE | NSInteger | 0 | 画线元素 |
GRAPH | NSInteger | 1 | 图形元素 |
TEXT | NSInteger | 2 | 文本元素 |
IMAGE | NSInteger | 3 | 图片元素 |
ELEMENT | NSInteger | 4 | 自定义元素 |
TEduBoardFileTranscodeStatus
自2.6.5版本废弃文件转码状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_FILE_TRANSCODE_ERROR | NSInteger | 1 | 转码错误 |
TEDU_BOARD_FILE_TRANSCODE_UPLOADING | NSInteger | 2 | 文件上传中 |
TEDU_BOARD_FILE_TRANSCODE_CREATED | NSInteger | 3 | 发起转码任务 |
TEDU_BOARD_FILE_TRANSCODE_QUEUE | NSInteger | 4 | 排队中 |
TEDU_BOARD_FILE_TRANSCODE_PROCESSING | NSInteger | 5 | 转码中 |
TEDU_BOARD_FILE_TRANSCODE_FINISHED | NSInteger | 6 | 转码完成 |
TEduBoardH5FileStatus
H5 文件状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_H5_FILE_STATUS_LOADING | NSInteger | 1 | 加载中 |
TEDU_BOARD_H5_FILE_STATUS_LOADED | NSInteger | 2 | 加载完成 |
TEduBoardH5PPTStatus
H5PPT 加载状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_H5_PPT_STATUS_LOADING | NSInteger | 1 | 加载中 |
TEDU_BOARD_H5_PPT_STATUS_LOADED | NSInteger | 2 | 加载完成 |
TEDU_BOARD_H5_PPT_STATUS_CANCEL | NSInteger | 3 | 取消加载(当前 PPT 还没有加载完成,则切换到了其他文件) |
TEDU_BOARD_H5_PPT_STATUS_TIMEOUT | NSInteger | 4 | 加载超时 |
TEDU_BOARD_H5_PPT_STATUS_RESOURCES_LOADING_ERROR | NSInteger | 5 | 资源加载失败 |
TEDU_BOARD_H5_PPT_STATUS_RUNTIME_ERROR | NSInteger | 6 | 内部运行错误 |
TEduBoardImageFitMode
白板图片填充对齐模式
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_IMAGE_FIT_MODE_BOTTOM | NSInteger | 7 | 以宽度或者高度为基准底对齐等比例放大 |
TEDU_BOARD_IMAGE_FIT_MODE_CENTER | NSInteger | 0 | 以宽度或者高度为基准居中对齐等比例放大 |
TEDU_BOARD_IMAGE_FIT_MODE_LEFT | NSInteger | 4 | 以宽度或者高度为基准左对齐等比例放大 |
TEDU_BOARD_IMAGE_FIT_MODE_RIGHT | NSInteger | 6 | 以宽度或者高度为基准右对齐等比例放大 |
TEDU_BOARD_IMAGE_FIT_MODE_TOP | NSInteger | 5 | 以宽度或者高度为基准顶对齐等比例放大 |
TEduBoardImageStatus
白板图片加载状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_IMAGE_STATUS_LOADING | NSInteger | 1 | 背景图片正在加载 |
TEDU_BOARD_IMAGE_STATUS_LOAD_DONE | NSInteger | 2 | 背景图片加载完成 |
TEDU_BOARD_IMAGE_STATUS_LOAD_ABORT | NSInteger | 3 | 背景图片加载中断 |
TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR | NSInteger | 4 | 背景图片加载错误 |
TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT | NSInteger | 5 | 背景图片加载超时 |
TEDU_BOARD_IMAGE_STATUS_LOAD_CANCEL | NSInteger | 6 | 背景图片取消加载 |
TEDU_BOARD_IMAGE_STATUS_READ_ERROR | NSInteger | 7 | 本地图片加载错误 |
TEduBoardLineType
工具直线类型
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_LINE_TYPE_SOLID | NSInteger | 1 | 实线 |
TEDU_BOARD_LINE_TYPE_DOTTED | NSInteger | 2 | 虚线 |
TEduBoardMathGraphCode
数学函数图像工具状态码
枚举 | 类型 | 值 | 描述 |
MATH_EXPRESSION_PARSE_ERROR | NSInteger | -1 | 函数表达式解析失败 |
TEduBoardMathGraphType
数学图形类型
枚举 | 类型 | 值 | 描述 |
NONE | NSInteger | 0 | 无图形输入,此时可选中几何图形 |
PONSInteger | NSInteger | 1 | 点 |
LINE | NSInteger | 2 | 直线 |
LINE_SEGMENT | NSInteger | 3 | 线段 |
RAY | NSInteger | 4 | 射线 |
CIRCLE | NSInteger | 5 | 圆 |
ANGLE | NSInteger | 6 | 角 |
POLYGON | NSInteger | 7 | 多边形 |
TEduBoardOvalDrawMode
椭圆绘制模式
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_OVAL_DRAW_MODE_FIX_START | NSInteger | 1 | 固定起始点,起始点和终点的中点为圆心 |
TEDU_BOARD_OVAL_DRAW_MODE_FIX_CENTER | NSInteger | 2 | 固定圆心,起始点为圆心 |
TEduBoardPenFittingMode
画笔拟合类型
枚举 | 类型 | 值 | 描述 |
NONE | NSString | none | 不拟合 |
AUTO | NSString | auto | 自动识别并拟合图形 |
CIRCLE | NSString | circle | 拟合圆形 |
ELLIPSE | NSString | ellipse | 拟合椭圆 |
POLYGON | NSString | polygon | 拟合多边形 |
RECTANGLE | NSString | rectangle | 拟合矩形 |
TEduBoardPosition
显示位置常量
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_POSITION_LEFT_BOTTOM | NSInteger | 4 | 左下 |
TEDU_BOARD_POSITION_LEFT_TOP | NSInteger | 1 | 左上 |
TEDU_BOARD_POSITION_RIGHT_BOTTOM | NSInteger | 3 | 右下 |
TEDU_BOARD_POSITION_RIGHT_TOP | NSInteger | 2 | 右上 |
TEduBoardTextComponentStatus
白板文字工具异常状态码
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_TEXT_COMPONENT_STATUS_INSUFFICIENT_SPACE | NSInteger | 1 | 空间不足,文本框无法显示 |
TEDU_BOARD_TEXT_COMPONENT_STATUS_WORD_LIMIT | NSInteger | 2 | 文本超出字数限制 |
TEduBoardTextStyle
白板文本样式
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_TEXT_STYLE_BOLD | NSInteger | 0 | 粗体样式 |
TEDU_BOARD_TEXT_STYLE_BOLD_ITALIC | NSInteger | 1 | 粗斜体样式 |
TEDU_BOARD_TEXT_STYLE_ITALIC | NSInteger | 2 | 斜体样式 |
TEDU_BOARD_TEXT_STYLE_NORMAL | NSInteger | 3 | 常规样式 |
TEduBoardToolType
白板工具类型
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_TOOL_TYPE_MOUSE | NSInteger | 0 | 鼠标,默认鼠标工具点击白板会进行翻页,如果不需要此功能,可以调用 setMouseToolBehavior 接口设置,也可以通过初始化参数设置 |
TEDU_BOARD_TOOL_TYPE_PEN | NSInteger | 1 | 画笔 |
TEDU_BOARD_TOOL_TYPE_ERASER | NSInteger | 2 | 橡皮擦 |
TEDU_BOARD_TOOL_TYPE_LASER | NSInteger | 3 | 激光笔 |
TEDU_BOARD_TOOL_TYPE_LINE | NSInteger | 4 | 直线 可设置画直线,虚线,箭头 |
TEDU_BOARD_TOOL_TYPE_OVAL | NSInteger | 5 | 空心椭圆 |
TEDU_BOARD_TOOL_TYPE_OVAL_SOLID | NSInteger | 7 | 实心椭圆 |
TEDU_BOARD_TOOL_TYPE_RECT | NSInteger | 6 | 空心矩形 |
TEDU_BOARD_TOOL_TYPE_RECT_SOLID | NSInteger | 8 | 实心矩形 |
TEDU_BOARD_TOOL_TYPE_PONSInteger_SELECT | NSInteger | 9 | 点选工具(已经与框选工具合并,保留一个即可) |
TEDU_BOARD_TOOL_TYPE_RECT_SELECT | NSInteger | 10 | 框选工具(已经与点选工具合并,保留一个即可) |
TEDU_BOARD_TOOL_TYPE_TEXT | NSInteger | 11 | 文本工具 |
TEDU_BOARD_TOOL_TYPE_ZOOM_DRAG | NSInteger | 12 | 缩放和移动工具,从2.6.4点版本起,支持初始化传入 pinchToZoomEnable 开启在任意工具下进行缩放白板 |
TEDU_BOARD_TOOL_TYPE_SQUARE | NSInteger | 13 | 空心正方形 |
TEDU_BOARD_TOOL_TYPE_SQUARE_SOLID | NSInteger | 14 | 实心正方形 |
TEDU_BOARD_TOOL_TYPE_CIRCLE | NSInteger | 15 | 空心正圆形 |
TEDU_BOARD_TOOL_TYPE_CIRCLE_SOLID | NSInteger | 16 | 实心正圆形 |
TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH | NSInteger | 17 | 自定义图形 |
TEduBoardUploadStatus
白板上传状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_UPLOAD_STATUS_SUCCEED | NSInteger | 1 | 上传成功 |
TEDU_BOARD_UPLOAD_STATUS_FAILED | NSInteger | 2 | 上传失败 |
TEduBoardVideoStatus
视频文件状态
枚举 | 类型 | 值 | 描述 |
TEDU_BOARD_VIDEO_STATUS_ERROR | NSInteger | 1 | 播放错误 |
TEDU_BOARD_VIDEO_STATUS_LOADING | NSInteger | 2 | 加载中 |
TEDU_BOARD_VIDEO_STATUS_LOADED | NSInteger | 3 | 加载完成 |
TEDU_BOARD_VIDEO_STATUS_PLAYED | NSInteger | 4 | 开始播放 |
TEDU_BOARD_VIDEO_STATUS_TIMEUPDATE | NSInteger | 5 | 时间状态更新 |
TEDU_BOARD_VIDEO_STATUS_PAUSED | NSInteger | 6 | 暂停 |
TEDU_BOARD_VIDEO_STATUS_SEEKED | NSInteger | 7 | 跳转 |
TEDU_BOARD_VIDEO_STATUS_ENDED | NSInteger | 8 | 结束 |
TEDU_BOARD_VIDEO_STATUS_WAITING | NSInteger | 9 | 缓冲中 |
TEDU_BOARD_VIDEO_STATUS_PLAYING | NSInteger | 10 | 缓冲结束 |
TEduBoardFileType
文件类型
枚举 | 类型 | 值 | 描述 |
TEduBoardWHITEBOARD | NSInteger | 1 | 默认白板组 |
TEduBoardH5_COURSEWARE | NSInteger | 2 | 动态转码课件 |
TEduBoardIMAGE_COURSEWARE | NSInteger | 3 | 静态转码课件 |
TEduBoardVIDEO_FILE | NSInteger | 4 | 视频文件 |
TEduBoardH5_FILE | NSInteger | 5 | H5文件 |
TEduBoardIMAGES_FILE | NSInteger | 6 | 图片组文件 |
TEduBoardLogLevel
日志级别
枚举 | 类型 | 值 | 描述 |
TEduBoardLogLevelALL | NSInteger | 0 | 全部日志 |
TEduBoardLogLevelINFO | NSInteger | 1 | 一般日志 |
TEduBoardLogLevelWARNING | NSInteger | 2 | 告警日志 |
TEduBoardLogLevelERROR | NSInteger | 3 | 错误日志 |
TEduBoardLogLevelOFF | NSInteger | 4 | 不打印日志 |
TEduBoardAddElementOptions
显示位置常量
属性 | 类型 | 描述 |
erasable | BOOL | 元素是否支持橡皮擦擦除 默认为 true |
left | NSString | 元素距左边界的偏移,支持像素或百分比,若不填写单位默认按像素计算 |
top | NSString | 元素距上边界的偏移,支持像素或百分比,若不填写单位默认按像素计算 |
TEduBoardAuthParam
互动白板初始化授权参数
属性 | 类型 | 描述 |
sdkAppId | NSInteger | SDKAppID |
userId | NSString | 用户 ID |
userSig | NSString | 用户签名 |
TEduBoardCursorIcon
鼠标样式
属性 | 类型 | 描述 |
cursor | NSString | 浏览器内置鼠标指针样式,可取值参考文档 |
url | NSString | 自定义鼠标指针样式的 URL,格式限制参考文档 |
offsetY | NSInteger | 自定义鼠标指针样式的纵向偏移 |
offsetX | NSInteger | 自定义鼠标指针样式的横向偏移 |
TEduBoardElementInfo
白板元素信息
属性 | 类型 | 描述 |
boardId | NSString | 白板 ID |
elementId | NSString | 元素 ID |
type | NSInteger | 元素类型 |
url | NSString | 元素地址 |
TEduBoardElementMathBoard
函数画板参数
属性 | 类型 | 描述 |
axis | BOOL | 是否显示坐标轴 |
axisColor | TEColor | 画板坐标系颜色 #ffffff; |
boundingbox | TEEdgeInsets | 画板显示区域的左下角和右下角 对应[x1,y1,x2,y2] |
enablePan | BOOL | 是否开启鼠标拖拽平移 |
enableZoom | BOOL | 否开启鼠标滚轮缩放 |
grid | BOOL | 是否显示网格 |
height | NSString | 画板高度,支持像素或百分比 |
showControl | BOOL | 是否显示控制栏 |
width | NSString | 画板宽度,支持像素或百分比 |
TEduBoardElementMathGraph
数学函数信息
属性 | 类型 | 描述 |
color | TEColor | 数学函数图像颜色 |
expression | NSString | 数学函数表达式 |
mathBoardId | NSString | 函数画板的元素 ID |
selectedColor | TEColor | 数学函数图像选中时的颜色 |
TEduBoardElementOperationAuthority
单个元素具有的操作权限
属性 | 类型 | 描述 |
disableArbitraryScale | BOOL | 是否禁用任意缩放 (文本元素默认为 true,不可更改) |
disableMove | BOOL | 是否禁用移动 |
disableProportionScale | BOOL | 是否禁用等比例缩放 |
disableRotate | BOOL | 是否禁用旋转 (文本元素默认为 true,不可更改) |
TEduBoardFileInfo
文件信息
属性 | 类型 | 描述 |
boardInfoList | NSArray TEduBoardInfo | 白板信息列表 |
downloadURL | NSString | 文件下载地址 |
fileId | NSString | 文件 ID |
pageCount | NSInteger | 文件页数 |
pageIndex | NSInteger | 文件当前显示的页数 |
title | NSString | 文件名 |
fileType | NSInteger | 文件类型 TEduBoardFileType |
TEduBoardInfo
白板信息
属性 | 类型 | 描述 |
backgroundColor | TEColor | 白板背景色 |
backgroundUrl | NSString | 背景图或者背景 H5 页面的 URL |
boardId | NSString | 白板 ID |
TEduBoardInitAuthConfig
白板初始化鉴权参数
属性 | 类型 | 描述 |
dataSyncEnable | BOOL | 是否启用数据同步,禁用后将导致本地白板操作不会被同步给远端 |
drawEnable | BOOL | 是否允许涂鸦,默认 YES |
enableScaleTool | BOOL | 是否启用白板缩放移动工具的缩放功能,默认为 true |
formulaEnable | BOOL | 是否预加载公式库 |
isAutoHideRemoteCursor | BOOL | 远端画笔不动2秒后是否自动隐藏 |
mathGraphEnable | BOOL | 是否预加载数学函数图像库 |
pinchToZoomEnable | BOOL | 在任意工具下开启双指缩放 |
progressEnable | BOOL | 是否启用 SDK 内置 Loading 图标 |
showCursorOnTouch | BOOL | 是否在移动端上显示画笔 |
showLocalOperator | BOOL | 是否显示本地操作信息(选框工具选中白板元素显示白板元素的创建者) |
showRemoteOperator | BOOL | 是否显示远端操作信息(远端使用选框工具时,本地显示远端用户操作的白板元素) |
showRemoteSelectBox | BOOL | 是否显示远端选框 |
systemCursorEnable | BOOL | 是否启用原生系统光标,默认 false |
elementOperationAuthority | TEduBoardOperationAuthority | 设置白板元素操作权限 |
mouseToolBehavior | TEduBoardMouseToolBehavior | 设置鼠标工具行为 |
remoteCursorVisible | TEduBoardCursorVisible | 远端画笔是否显示 |
TEduBoardInitConfig
白板初始化参数
属性 | 类型 | 描述 |
autoHideRemoteCursorTimeout | UInt32 | 远端隐藏画笔时间(毫秒) |
boardContentFitMode | TEduBoardContentFitMode | 白板内容自适应模式,默认 TEDU_BOARD_CONTENT_FIT_MODE_NONE |
offlineWarningTimeout | NSInteger | 白板离线告警时间间隔,单位(秒) |
preloadDepth | NSInteger | 图片预加载深度,默认值5,表示预加载当前页前后5页的图片 |
progressBarUrl | NSString | 自定义加载图标,在 progressEnable = true 时生效,支持 jpg、gif、png、svg |
ratio | NSString | 默认白板宽高比,可传格式如“4:3”、“16:9”的字符串,默认“16:9” |
scale | UInt32 | 白板默认缩放系数,实际缩放倍数为 scale/100 |
scaleRange | NSArray | 白板缩放范围,百分比形式,100表示100%,无缩放,默认值 @[@100, @1600] |
syncFps | NSInteger | 信令同步频率,该值的允许范围为[5, 20],默认5 |
toolType | TEduBoardToolType | 白板工具,默认 TEDU_BOARD_TOOL_TYPE_PEN |
TEduBoardInitParam
白板初始化参数
属性 | 类型 | 描述 |
authConfig | TEduBoardInitAuthConfig | 权限配置参数 |
config | TEduBoardInitConfig | 常规配置参数 |
imageTimeout | int | 图片加载超时时间,单位秒默认10s |
smoothLevel | float | 平滑系数,默认0,范围[0,1] |
styleConfig | TEduBoardInitStyleConfig | 样式配置参数 |
timSync | BOOL | 是否使用腾讯云 IMSDK 进行实时数据同步,默认 YES |
userConfig | TEduBoardInitUserConfig | 用户配置参数 |
TEduBoardInitStyleConfig
白板初始化参数-styleConfig
属性 | 类型 | 描述 |
brushColor | TEColor | 画笔颜色 |
brushThin | int | 画笔粗细,默认100 |
cursorSize | NSArray | 画笔大小限制 |
globalBackgroundColor | TEColor | 全局背景色 |
selectAnchorColor | TEColor | 选框缩放控制点颜色 |
selectBoxColor | TEColor | 选框颜色,包括选框上的缩放,旋转按钮 |
textColor | TEColor | 文本颜色 |
textSize | int | 文本粗细,默认320 |
textStyle | TEduBoardTextStyle | 文本样式,默认 TEDU_BOARD_TEXT_STYLE_NORMAL |
TEduBoardInitUserConfig
白板初始化参数-userConfig
属性 | 类型 | 描述 |
nickname | NSString | 当前白板用户昵称 |
TEduBoardLineStyle
直线类型
属性 | 类型 | 描述 |
lineType | TEduBoardLineType | 直线类型,默认 TEDU_BOARD_LINE_TYPE_SOLID |
endArrowType | TEduBoardArrowType | 终点箭头类型,默认 TEDU_BOARD_ARROW_TYPE_NONE |
startArrowType | TEduBoardArrowType | 起点箭头类型,默认 TEDU_BOARD_ARROW_TYPE_NONE |
TEduBoardMouseToolBehavior
鼠标工具行为
属性 | 类型 | 描述 |
turnPage | TEduBoardMouseToolTurnPage | 翻页行为 |
TEduBoardMouseToolTurnPage
鼠标工具翻页行为
属性 | 类型 | 描述 |
h5PPT | BOOL | 动态 PPT 转码的文件点击可翻页 |
imgFile | BOOL | 图片文件(addImagesFile 接口添加的文件)点击不可翻页 |
imgPPT | BOOL | 静态 PPT 转码文件点击不可翻页 |
whiteBoard | BOOL | 普通白板点击可翻页 |
TEduBoardOperationAuthority
白板元素操作权限
属性 | 类型 | 描述 |
graph | TEduBoardElementOperationAuthority | 图形涂鸦元素 |
line | TEduBoardElementOperationAuthority | 画笔涂鸦元素 |
text | TEduBoardElementOperationAuthority | 文本元素 |
TEduBoardSnapshotInfo
快照信息
属性 | 类型 | 描述 |
path | NSString | 快照文件存储的本地路径,包括文件名和后缀,只支持 png,例如:aaa/bbb/ccc/xxx.png |
TEduBoardToolTypeTitleStyle
白板工具提示语样式
属性 | 类型 | 描述 |
color | TEColor | 文本颜色 |
position | TEduBoardPosition | 显示位置 |
size | UInt32 | 实际像素值取值(size * 白板的高度 / 10000)px |
style | TEduBoardTextStyle | 文本样式 |
TEduBoardTranscodeConfig
转码配置
属性 | 类型 | 描述 |
isStaticPPT | BOOL | 指定对于 PPT 文件是否启用静态转码(转为静态图片),默认转为 H5 动画(转码耗时较长) |
minResolution | NSString | 指定转码结果最小分辨率,可用于提高转码结果清晰度,如960×540,宽高分隔符为x |
thumbnailResolution | NSString | 指定文件生成缩略图分辨率,默认不生成缩略图(生成缩略图增加额外转码消耗),如200×200,宽高分隔符为x |
TEduBoardTranscodeFileResult
转码结果
属性 | 类型 | 描述 |
pages | NSInteger | 文件总页数 |
progress | NSInteger | 转码进度(百分比) |
resolution | NSString | 文件分辨率,如@“1024×768” |
status | TEduBoardFileTranscodeStatus | 转码状态 |
taskId | NSString | 任务 ID |
thumbnailResolution | NSString | 文件生成缩略图的分辨率,如@“200×200” |
thumbnailUrl | NSString | 文件生成缩略图 URL |
title | NSString | 文件标题 |
url | NSString | 转码结果 URL |
TEduBoardUserInfo
用户信息
属性 | 类型 | 描述 |
nickname | NSString | 用户昵称 |
TEduMathToolType
元素样式类型
枚举 | 类型 | 值 | 描述 |
RULER | NSInteger | 1 | 直尺教具 |
TRIANGLE | NSInteger | 2 | 直角三角形 |
ISOSCELES_TRIANGLE | NSInteger | 3 | 等腰直角三角形 |
PROTRACTOR | NSInteger | 4 | 量角器 |
COMPASSES | NSInteger | 5 | 圆规 |
TEduElementOperatorType
元素样式类型
枚举 | 类型 | 值 | 描述 |
TEduElementOperatorTypeBOARDER_COLOR | NSInteger | 1 | border颜色 |
TEduElementOperatorTypeBOARDER_WIDTH | NSInteger | 2 | border宽度 |
TEduElementOperatorTypeBOARDER_LINE_TYPE | NSInteger | 3 | 实线/虚线 |
TEduElementOperatorTypeEL_DELETE | NSInteger | 4 | 删除元素 |
腾讯云官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
发表评论