Key Type Definition
For the definition of interactive whiteboard structure and constants, please refer to the Key Type Definition Document.
TEduBoardToolType
Whiteboard tools
Enumeration | Meaning |
TEDU_BOARD_TOOL_TYPE_MOUSE | Mouse |
TEDU_BOARD_TOOL_TYPE_PEN | Brush |
TEDU_BOARD_TOOL_TYPE_ERASER | Eraser |
TEDU_BOARD_TOOL_TYPE_LASER | Laser pointer |
TEDU_BOARD_TOOL_TYPE_LINE | Line |
TEDU_BOARD_TOOL_TYPE_OVAL | Hollow Ellipse |
TEDU_BOARD_TOOL_TYPE_RECT | Hollow Rectangle |
TEDU_BOARD_TOOL_TYPE_OVAL_SOLID | Solid Ellipse |
TEDU_BOARD_TOOL_TYPE_RECT_SOLID | Solid Rectangle |
TEDU_BOARD_TOOL_TYPE_POINT_SELECT | Point selection tool |
TEDU_BOARD_TOOL_TYPE_RECT_SELECT | Selection tool |
TEDU_BOARD_TOOL_TYPE_TEXT | Text tool |
TEDU_BOARD_TOOL_TYPE_ZOOM_DRAG | Zoom and move whiteboard tool |
TEDU_BOARD_TOOL_TYPE_SQUARE | Hollow Square |
TEDU_BOARD_TOOL_TYPE_SQUARE_SOLID | Solid Square |
TEDU_BOARD_TOOL_TYPE_CIRCLE | Hollow Circle |
TEDU_BOARD_TOOL_TYPE_CIRCLE_SOLID | Solid Circle |
TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH | Custom graphics, please use with the AddElement (TEDU_BOARD_ELEMENT_CUSTOM_GRAPH, 'Custom Graphic URL') interface |
TEDU_BOARD_TOOL_TYPE_ARC | Arc |
TEDU_BOARD_TOOL_TYPE_HIGHLIGHTER | highlighter |
TEDU_BOARD_TOOL_TYPE_RIGHT_TRIANGLE | Right triangle |
TEDU_BOARD_TOOL_TYPE_ISOSCELES_TRIANGLE | isosceles triangle |
TEDU_BOARD_TOOL_TYPE_PARALLELOGRAM | parallelogram |
TEDU_BOARD_TOOL_TYPE_CUBE | Cube |
TEDU_BOARD_TOOL_TYPE_CYLINDER | Cylinder |
TEDU_BOARD_TOOL_TYPE_CONE | Cone |
TEduBoardElementType
Enumeration | Meaning |
TEDU_BOARD_ELEMENT_IMAGE | Image element |
TEDU_BOARD_ELEMENT_H5 | H5 element |
TEDU_BOARD_ELEMENT_CUSTOM_GRAPH | Custom graphics, please use with the custom graphics tool TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH |
TEDU_BOARD_ELEMENT_AUDIO | Audio element, currently effective on the whiteboard |
TEDU_BOARD_ELEMENT_GLOBAL_AUDIO | Global audio element, no control interface, usually background music |
TEDU_BOARD_ELEMENT_MATH_BOARD | Mathematical function whiteboard |
TEDU_BOARD_ELEMENT_MATH_GRAPH | Mathematical function graph |
TEDU_BOARD_ELEMENT_GRAFFITI_LINE | Line doodle |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_LINE | Straight line doodle |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RECT | Rectangle doodle |
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL | Ellipse doodle |
TEDU_BOARD_ELEMENT_TEXT | Text element |
TEDU_BOARD_ELEMENT_MAGIC_LINE | Magic pen element |
TEDU_BOARD_ELEMENT_FORMULA | Mathematical formula element |
TEduBoardErasableElementType
Enumeration | Meaning |
TEDU_BOARD_ERASABLE_ELEMENT_LINE | Line element |
TEDU_BOARD_ERASABLE_ELEMENT_GRAPH | Shape element |
TEDU_BOARD_ERASABLE_ELEMENT_TEXT | Text element |
TEDU_BOARD_ERASABLE_ELEMENT_IMAGE | Image element |
TEDU_BOARD_ERASABLE_ELEMENT_ELEMENT | Custom element |
TEduBoardImageFitMode
Enumeration | Meaning |
TEDU_BOARD_IMAGE_FIT_MODE_CENTER | Center align and proportionally enlarge based on width or height |
TEDU_BOARD_IMAGE_FIT_MODE_LEFT | Left align and proportionally enlarge based on width or height |
TEDU_BOARD_IMAGE_FIT_MODE_TOP | Top align and proportionally enlarge based on width or height |
TEDU_BOARD_IMAGE_FIT_MODE_RIGHT | Right align and proportionally enlarge based on width or height |
TEDU_BOARD_IMAGE_FIT_MODE_BOTTOM | Bottom align and proportionally enlarge based on width or height |
Description
When proportionally enlarging based on width, left, and right alignments have the same effect as center alignment; when proportionally enlarging based on height, top and bottom alignments have the same effect as center alignment.
TEduBoardImageStatus
Enumeration | Meaning |
TEDU_BOARD_IMAGE_STATUS_LOADING | Background image loading |
TEDU_BOARD_IMAGE_STATUS_LOAD_DONE | Background image loaded |
TEDU_BOARD_IMAGE_STATUS_LOAD_ABORT | Background image loading interrupted |
TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR | Background image loading error |
TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT | Background image loading timeout |
TEDU_BOARD_IMAGE_STATUS_LOAD_CANCEL | Background image loading canceled |
TEDU_BOARD_IMAGE_STATUS_READ_ERROR | Failed to load background image. |
TEduBoardPosition
Enumeration | Meaning |
TEDU_BOARD_POSITION_LEFT_TOP | Top Left |
TEDU_BOARD_POSITION_RIGHT_TOP | Top Right |
TEDU_BOARD_POSITION_RIGHT_BOTTOM | Bottom Right |
TEDU_BOARD_POSITION_LEFT_BOTTOM | Bottom Left |
TEduBoardTextStyle
Enumeration | Meaning |
TEDU_BOARD_TEXT_STYLE_NORMAL | Regular style |
TEDU_BOARD_TEXT_STYLE_BOLD | Bold style |
TEDU_BOARD_TEXT_STYLE_ITALIC | Italic style |
TEDU_BOARD_TEXT_STYLE_BOLD_ITALIC | Bold italic style |
TEduBoardUploadStatus
Enumeration | Meaning |
TEDU_BOARD_UPLOAD_STATUS_SUCCEED | Upload successful |
TEDU_BOARD_UPLOAD_STATUS_FAILED | Upload failed |
TEduBoardBackgroundH5Status
Enumeration | Meaning |
TEDU_BOARD_BACKGROUND_H5_STATUS_LOADING | H5 background loading |
TEDU_BOARD_BACKGROUND_H5_STATUS_LOAD_FINISH | H5 background loaded |
TEduBoardContentFitMode
Enumeration | Meaning |
TEDU_BOARD_CONTENT_FIT_MODE_NONE | Do not use content adaptive mode, default mode, do not automatically adjust whiteboard aspect ratio, content is proportionally scaled and centered, content width and height <= whiteboard width and height |
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_INSIDE | Automatically adjust whiteboard aspect ratio to match content, content fills the whiteboard, whiteboard is proportionally scaled and centered, whiteboard width and height <= container width and height |
TEDU_BOARD_CONTENT_FIT_MODE_CENTER_COVER | Automatically adjust whiteboard aspect ratio to match content, content fills the whiteboard, whiteboard is proportionally scaled and centered, whiteboard width and height >= container width and height |
Description
Content includes images, files, and PPT animations.
TEduBoardLineType
Enumeration | Meaning |
TEDU_BOARD_LINE_TYPE_SOLID | Solid line |
TEDU_BOARD_LINE_TYPE_DOTTED | Dashed line |
TEduBoardArrowType
Arrow Type
Enumeration | Meaning |
TEDU_BOARD_ARROW_TYPE_NONE | No arrow |
TEDU_BOARD_ARROW_TYPE_NORMAL | Normal arrow |
TEDU_BOARD_ARROW_TYPE_SOLID | Solid arrow |
TEduBoardOvalDrawMode
Ellipse Drawing Mode
Enumeration | Meaning |
TEDU_BOARD_OVAL_DRAW_MODE_FIX_START | Fix the starting point, the midpoint between the starting point and the endpoint is the center |
TEDU_BOARD_OVAL_DRAW_MODE_FIX_CENTER | Fix the center, the starting point is the center |
TEduBoardFileTranscodeStatus
File transcoding status
Enumeration | Meaning |
TEDU_BOARD_FILE_TRANSCODE_ERROR | Transcoding Error |
TEDU_BOARD_FILE_TRANSCODE_UPLOADING | File Uploading |
TEDU_BOARD_FILE_TRANSCODE_CREATED | Initiating Transcoding Task |
TEDU_BOARD_FILE_TRANSCODE_QUEUED | Queuing |
TEDU_BOARD_FILE_TRANSCODE_PROCESSING | Transcoding |
TEDU_BOARD_FILE_TRANSCODE_FINISHED | Transcoding Completed |
TEduBoardH5FileStatus
H5 file status
Enumeration | Meaning |
TEDU_BOARD_H5_FILE_STATUS_LOADING | Loading |
TEDU_BOARD_H5_FILE_STATUS_LOADED | Load complete |
TEduBoardH5PPTStatus
PPT animation file loading status
Enumeration | Meaning |
TEDU_BOARD_H5_PPT_STATUS_LOADING | PPT animation file loading |
TEDU_BOARD_H5_PPT_STATUS_LOADED | PPT animation file loaded |
TEDU_BOARD_H5_PPT_STATUS_CANCEL | PPT animation file loading canceled (local PPT not yet loaded, switched to another file) |
TEDU_BOARD_H5_PPT_STATUS_TIMEOUT | PPT animation file loading timeout |
TEDU_BOARD_H5_PPT_STATUS_RESOURCES_LOADING_ERROR | Failed to load the PPT animation file |
TEDU_BOARD_H5_PPT_STATUS_RUNTIME_ERROR | Internal error during PPT animation file loading |
TEduBoardVideoStatus
Video file status
Enumeration | Meaning |
TEDU_BOARD_VIDEO_STATUS_ERROR | Playback error |
TEDU_BOARD_VIDEO_STATUS_LOADING | Loading |
TEDU_BOARD_VIDEO_STATUS_LOADED | Load complete |
TEDU_BOARD_VIDEO_STATUS_PLAYED | Start playback |
TEDU_BOARD_VIDEO_STATUS_TIMEUPDATE | Time update |
TEDU_BOARD_VIDEO_STATUS_PAUSED | Pause |
TEDU_BOARD_VIDEO_STATUS_SEEKED | Redirect |
TEDU_BOARD_VIDEO_STATUS_ENDED | End |
TEDU_BOARD_VIDEO_STATUS_WAITING | Buffering |
TEDU_BOARD_VIDEO_STATUS_PLAYING | Buffering ended |
TEduBoardAudioStatus
Audio status
Enumeration | Meaning |
TEDU_BOARD_AUDIO_STATUS_ERROR | Playback error |
TEDU_BOARD_AUDIO_STATUS_LOADING | Loading |
TEDU_BOARD_AUDIO_STATUS_LOADED | Load complete |
TEDU_BOARD_AUDIO_STATUS_PLAYED | Start playback |
TEDU_BOARD_AUDIO_STATUS_TIMEUPDATE | Time update |
TEDU_BOARD_AUDIO_STATUS_PAUSED | Pause |
TEDU_BOARD_AUDIO_STATUS_SEEKED | Redirect |
TEDU_BOARD_AUDIO_STATUS_ENDED | End |
TEDU_BOARD_AUDIO_STATUS_WAITING | Buffering |
TEDU_BOARD_AUDIO_STATUS_PLAYING | Buffering ended |
TEduBoardKeyEventType
Keyboard event type
Enumeration | Meaning |
TEDU_BOARD_KEYEVENT_RAWKEYDOWN | Indicates the state transition process of a key from up to down |
TEDU_BOARD_KEYEVENT_KEYDOWN | Indicates a key is pressed, the key will be mapped to different characters based on keyboard and language type, so use the TEDU_BOARD_KEYEVENT_CHAR event when character input is needed |
TEDU_BOARD_KEYEVENT_KEYUP | Indicates a key is released |
TEDU_BOARD_KEYEVENT_CHAR | Indicates a symbol is input, the key press event will generate different characters based on keyboard, region, and operating system, so use this event for text input |
TEduBoardMouseButtonType
Mouse button type
Enumeration | Meaning |
TEDU_BOARD_MOUSEBUTTON_LEFT | Left mouse button |
TEDU_BOARD_MOUSEBUTTON_MIDDLE | Middle mouse button |
TEDU_BOARD_MOUSEBUTTON_RIGHT | Right mouse button |
TEduBoardTouchEventType
Touch event type
Enumeration | Meaning |
TEDU_BOARD_TOUCHEVENT_RELEASED | Released |
TEDU_BOARD_TOUCHEVENT_PRESSED | Pressed |
TEDU_BOARD_TOUCHEVENT_MOVED | Moved |
TEDU_BOARD_TOUCHEVENT_CANCELLED | Canceled |
TEduBoardPointType
Pointing device type
Enumeration | Meaning |
TEDU_BOARD_POINTER_TYPE_TOUCH | Finger |
TEDU_BOARD_POINTER_TYPE_MOUSE | Mouse |
TEDU_BOARD_POINTER_TYPE_PEN | Pen |
TEDU_BOARD_POINTER_TYPE_ERASER | Eraser |
TEDU_BOARD_POINTER_TYPE_UNKNOWN | Unknown |
TEduBoardEventFlag
Event flag
Enumeration | Meaning |
TEDU_BOARD_EVENTFLAG_NONE | No tag |
TEDU_BOARD_EVENTFLAG_CAPS_LOCK_ON | Caps lock is on |
TEDU_BOARD_EVENTFLAG_SHIFT_DOWN | Shift key is pressed |
TEDU_BOARD_EVENTFLAG_CONTROL_DOWN | Ctrl key is pressed |
TEDU_BOARD_EVENTFLAG_ALT_DOWN | Alt key is pressed |
TEDU_BOARD_EVENTFLAG_LEFT_MOUSE_BUTTON | Left mouse button is pressed |
TEDU_BOARD_EVENTFLAG_MIDDLE_MOUSE_BUTTON | Middle mouse button is pressed |
TEDU_BOARD_EVENTFLAG_RIGHT_MOUSE_BUTTON | Right mouse button is pressed |
TEDU_BOARD_EVENTFLAG_COMMAND_DOWN | Command key is pressed on macOS |
TEDU_BOARD_EVENTFLAG_NUM_LOCK_ON | Num lock is on |
TEDU_BOARD_EVENTFLAG_IS_KEY_PAD | |
TEDU_BOARD_EVENTFLAG_IS_LEFT | Left modifier key is pressed |
TEDU_BOARD_EVENTFLAG_IS_RIGHT | Right modifier key is pressed |
TEduBoardAccessibleOperation
Whiteboard event type
Enumeration | Meaning |
TEDU_BOARD_OPERATION_ALL | All operations |
TEDU_BOARD_OPERATION_MOVE | China Mobile |
TEDU_BOARD_OPERATION_DELETE | Delete |
TEDU_BOARD_OPERATION_SCALE | Scaling |
TEDU_BOARD_OPERATION_ROTATE | Rotation |
TEDU_BOARD_OPERATION_SELECTED | Selected |
TEDU_BOARD_OPERATION_ADD | Add |
TEduBoardTextComponentStatus
Whiteboard text tool error code
Enumeration | Meaning |
TEDU_BOARD_TEXT_COMPONENT_STATUS_INSUFFICIENT_SPACE | Insufficient space |
TEDU_BOARD_TEXT_COMPONENT_STATUS_WORD_LIMIT | Text exceeds character limit |
TEDU_BOARD_TEXT_COMPONENT_CANNOT_USE_EMOJI | Cannot use emojis |
TEduBoardMathGraphCode
Math function graph tool status code
Enumeration | Meaning |
MATH_EXPRESSION_PARSE_ERROR | Function expression parsing failed |
TEduBoardPenFittingMode
Pen automatic fitting mode
Enumeration | Meaning |
NONE | No curve fitting |
AUTO | Automatically recognize and fit shapes |
RECTANGLE | Fit Rectangle |
POLYGON | Fit Polygon |
CIRCLE | Fit Circle |
ELLIPSE | Fit Ellipse |
TEduBoardBackgroundType
Whiteboard background type
Enumeration | Meaning |
TEDU_BOARD_BACKGROUND_IMAGE | Image type |
TEDU_BOARD_BACKGROUND_H5 | Webpage type |
TEduBoardMathGraphType
Types of Geometric Shapes
Enumeration | Meaning |
TEDU_BOARD_MATHGRAPH_NONE | No graphic input, geometric shapes can be selected at this time |
TEDU_BOARD_MATHGRAPH_POINT | Point |
TEDU_BOARD_MATHGRAPH_LINE | Line |
TEDU_BOARD_MATHGRAPH_LINE_SEGMENT | Line |
TEDU_BOARD_MATHGRAPH_RAY | Ray |
TEDU_BOARD_MATHGRAPH_CIRCLE | round |
TEDU_BOARD_MATHGRAPH_ANGLE | Angle |
TEDU_BOARD_MATHGRAPH_POLYGON | Polygon |
TEDU_BOARD_MATHGRAPH_VECTOR | Vector |
TEDU_BOARD_MATHGRAPH_ELLIPSE | Ellipse |
TEDU_BOARD_MATHGRAPH_CUBE | Cube |
TEDU_BOARD_MATHGRAPH_CYLINDER | Cylinder |
TEDU_BOARD_MATHGRAPH_CIRCULAR_CONE | Cone |
TEduBoardClassGroupOperationType
Whiteboard Group Operations
Enumeration | Meaning |
TEDU_BOARD_GOT_SET_ENABLE | Enable Group Mode |
TEDU_BOARD_GOT_UPDATE | Update group information |
TEDU_BOARD_GOT_DELETE | Node Group Deletion |
TEDU_BOARD_GOT_RESET | Reset group |
TEDU_BOARD_GOT_ERROR | Group feature error occurred |
TEduBoardAuthParam
Whiteboard Authorization Parameters
Attribute list
Attribute | Type | Field Description |
sdkAppId | uint32_t | SDKAppID |
userId | const char * | User ID |
userSig | const char * | User’s signature |
TEduBoardColor
Color Parameters
Attribute list
Attribute | Type | Field Description |
red | uint8_t | Red component |
green | uint8_t | Green component |
blue | uint8_t | Blue component |
alpha | uint8_t | Alpha component |
TEduRoutineConfigInitParam
General Configuration Parameter
Attribute list
Attribute | Type | Field Description |
proxyServer | const char * | Default is '' for whiteboard service setting proxy server, pass in a JSON format string. Refer to the setproxyserver interface for JSON format |
ratio | const char * | Default '16:9' default whiteboard aspect ratio (can pass strings like "4:3", "16:9") |
progressBarUrl | const char * | Default '' customize loading icon, effective when progressEnable = true, supports jpg, gif, png, svg |
preloadDepth | uint32_t | Default 5; image preloading depth, default value 5, means preloading images of 5 pages before and after the current page |
scale | uint32_t | Default 100 whiteboard default zoom factor, actual zoom factor is scale / 100 |
syncFps | uint32_t | Default 5 signaling synchronization frequency, the allowed range is [5, 20] |
scaleRangeBegin | uint32_t | Default 100 whiteboard scaling range [100,1600], in percentage form, 100 means 100, no scaling |
scaleRangeEnd | uint32_t | Default 1600 whiteboard scaling range [100,1600], in percentage form, 100 means 100, no scaling |
offlineWarningTimeout | uint32_t | Default 180 whiteboard offline alarm time interval, unit (seconds) |
toolType | TEduBoardToolType | Default: tedu_board_tool_type_pen initial whiteboard tool type |
boardContentFitMode | TEduBoardContentFitMode | Default: tedu_board_content_fit_mode_none whiteboard content adaptive mode |
TEduUserConfigInitParam
User configuration parameters
Attribute list
Attribute | Type | Field Description |
nickname | const char * | Default is '' current whiteboard user nickname |
TEduStyleConfigInitParam
Style configuration parameters
Attribute list
Attribute | Type | Field Description |
textColor | TEduBoardColor | Default '#000000' text color |
brushColor | TEduBoardColor | Default '#ff0000' brush color |
globalBackgroundColor | TEduBoardColor | Default '#ffffff' global background color |
selectBoxColor | TEduBoardColor | Default '#ff0000' selection box color, including scaling on selection box, rotation button |
windowBackgroundColor | TEduBoardColor | Window background color, refers to non-whiteboard area background color |
textStyle | TEduBoardTextStyle | Default tedu_board_text_style_normal text style; |
textSize | uint32_t | Default 320 text size, actual pixel value (textSize * whiteboard height / 10000)px |
brushThin | uint32_t | Default 100 brush thickness, actual pixel value (brushThin * whiteboard height / 10000)px |
TEduElementOperationAuthority
Operation Permission Parameters
Attribute list
Attribute | Type | Field Description |
disableRotate | bool | Default false: Disable rotation (text elements default to true, cannot be changed) |
disableMove | bool | Default false: Disable movement |
disableProportionScale | bool | Default false: Disable proportional scaling |
disableArbitraryScale | bool | Default false: Disable arbitrary scaling (text elements default to true, cannot be changed) |
TEduMouseToolBehavior
Configuring Mouse Tool Behavior
Attribute list
Attribute | Type | Field Description |
whiteBoard | bool | Set mouse tool behavior for page turning in regular whiteboard, default is true |
h5PPT | bool | Set mouse tool behavior for page turning in dynamic PPT transcoded files, default is true |
imgPPT | bool | Set mouse tool behavior for page turning in static PPT transcoded files, default is true |
imgFile | bool | Set mouse tool behavior for page turning in image files (files added via addImagesFile interface), default is true |
TEduAuthConfigInitParam
Permission Configuration Parameter
Attribute list
Attribute | Type | Field Description |
drawEnable | bool | Default true: Allow doodling |
dataSyncEnable | bool | Default true: Enable data synchronization, disabling will prevent local whiteboard operations from being synced to remote |
progressEnable | bool | Default false: Enable SDK built-in loading icon |
systemCursorEnable | bool | Default false: Enable native system cursor, see setSystemCursorEnable interface for details |
enableScaleTool | bool | Default true: Enable zoom function of whiteboard zoom and move tool, when set to false, zoom function is unavailable when switching to zoom and move tool |
isAutoHideRemoteCursor | bool | Default false: Auto-hide remote brush after 2 seconds of inactivity |
showRemoteSelectBox | bool | Default false: Show remote selection box |
showLocalOperator | bool | Default false: Show local operation information (selection tool shows the creator of the whiteboard element) |
showRemoteOperator | bool | Default false: Show remote operation information (when remote uses selection tool, show remote user's operation on whiteboard element locally) |
mathGraphEnable | bool | Default false: Preload math function tool library (if there are math function image elements in whiteboard history data, math function tool library will be loaded automatically) |
formulaEnable | bool | Default false: Preload formula library |
line | TEduElementOperationAuthority | Brush doodle elements |
graph | TEduElementOperationAuthority | Shape doodle elements |
text | TEduElementOperationAuthority | Text element |
turnPage | TEduMouseToolBehavior | Configuring Mouse Tool Page Turning Behavior |
remoteCursorVisible | TEduRemoteCursorVisible | Whether to display remote brush |
TEduBoardInitParam
Whiteboard Initialization Parameters
Attribute list
Attribute | Type | Field Description |
userId | const char * | Username |
userSig | const char * | Login Authentication Information |
id | const char * | DOM Node ID for Whiteboard Rendering |
experimental | const char * | Experimental Parameter Set, Dictionary Type JSON String |
timSync | bool | Whether to use Tencent Cloud IMSDK for real-time data synchronization |
trtcSync | bool | Enable TRTC Auto-Sync |
imageTimeout | uint32_t | Image Load Timeout in Seconds, Default 10s |
classId | uint32_t | Classroom ID |
sdkAppId | uint32_t | Unique Identifier for Tencent Cloud Application |
config | TEduRoutineConfigInitParam | General Configuration Parameter |
userConfig | TEduUserConfigInitParam | User configuration parameters |
styleConfig | TEduStyleConfigInitParam | Style configuration parameters |
authConfig | TEduAuthConfigInitParam | Permission Configuration Parameter |
audioCallback | bool | Enable Audio Callback Mode (When enabled, audio within the whiteboard will not play, and PCM data will be thrown through the callback) |
TEduBoardLineStyle
Line Style
Attribute list
Attribute | Type | Field Description |
lineType | TEduBoardLineType | Line type |
startArrowType | TEduBoardArrowType | Starting point arrow type |
endArrowType | TEduBoardArrowType | Endpoint shoulder type |
TEduBoardCursorIcon
Mouse style
Attribute list
Attribute | Type | Field Description |
cursor | const char * | Built-in Browser Mouse Pointer Style, Reference Documentation for Possible Values, when using a custom image, set this field to "url" |
url | const char * | URL for Custom Mouse Pointer Style, Reference Documentation for Format Restrictions, this field does not need to include "url()" |
offsetX | uint32_t | Horizontal Offset for Custom Mouse Pointer Style |
offsetY | uint32_t | Vertical offset for custom mouse pointer styles |
TEduBoardToolTypeTitleStyle
Tooltip style
Attribute list
Attribute | Type | Field Description |
position | TEduBoardPosition | Display Position |
color | TEduBoardColor | Text color |
size | uint32_t | Actual pixel value: (size * Whiteboard's height / 10000)px |
style | TEduBoardTextStyle | Text style |
TEduBoardElementOptions
Element options
Attribute list
Attribute | Type | Field Description |
erasable | bool | Whether the Element Can Be Erased by the Eraser |
left | const char * | Offset of the element from the left boundary. Supports pixels or percentage. If the unit is not specified, it is calculated in pixels by default |
top | const char * | Offset of the element from the left boundary. Supports pixels or percentage. If the unit is not specified, it is calculated in pixels by default |
TEduBoardSnapshotInfo
Snapshot information
Attribute list
Attribute | Type | Field Description |
path | const char * | Local path for saving screenshots, which is UTF8-coded |
TEduBoardTranscodeConfig
File transcoding parameters
Attribute list
Attribute | Type | Field Description |
minResolution | const char * | Specify the minimum resolution for transcoding results to improve clarity. Format: 960x540, width and height separated by x. |
isStaticPPT | bool | Specify whether to enable static transcoding for PPT files (convert to static images). By default, it is converted to H5 animation (transcoding takes longer). |
thumbnailResolution | const char * | Specify the resolution for generating thumbnails for the file. By default, thumbnails are not generated (generating thumbnails adds extra transcoding time). Format: 200x200, width and height separated by x. |
TEduBoardTranscodeFileResult
File transcoding result
Attribute list
Attribute | Type | Field Description |
taskId | char | Task ID |
status | TEduBoardFileTranscodeStatus | Transcoding Status |
progress | double | Transcoding progress, value range [0,100] |
title | char | File title |
resolution | char | File resolution |
pages | uint32_t | Total number of pages |
url | char | Transcoding result URL |
thumbnailResolution | char | Resolution for generating thumbnails for the file |
thumbnailUrl | char | URL for generating thumbnails for the file |
TEduBoardInfo
Whiteboard information
Attribute list
Attribute | Type | Field Description |
boardId | const char * | Whiteboard ID |
backgroundUrl | const char * | URL of the whiteboard background image or background H5 page |
backgroundColor | TEduBoardColor | Whiteboard background color |
TEduAddBoardBase
Add whiteboard elements
TEduAddBoardElementUrl
Add whiteboard elements (excluding mathematical function images and mathematical function boards)
Attribute list
Attribute | Type | Field Description |
strUrl | const char * | URL address |
TEduAddBoardElementMathGraph
Add a Math Function Image
Attribute list
Attribute | Type | Field Description |
mathBoardId | const char * | |
expression | const char * | |
color | TEduBoardColor | |
selectedColor | TEduBoardColor | |
TEduAddBoardElementMathBoard
Add a Math Function Board
Attribute list
Attribute | Type | Field Description |
showControl | bool | Upper left and bottom right corners of the canvas display area, corresponding to [x1, y1, x2, y2] |
enableZoom | bool | Enable mouse wheel zoom (press and hold Shift) |
enablePan | bool | Enable mouse drag to pan (press and hold Shift) |
axis | bool | Whether to display axes |
grid | bool | Whether to display the grid |
leftX | int | Upper left corner x of the canvas display area |
leftY | int | Upper left corner y of the canvas display area |
rightX | int | Bottom right corner x of the canvas display area |
rightY | int | Bottom right corner y of the canvas display area |
width | const char * | Canvas width, supports pixels or percentage, if no unit is specified, calculated in pixels by default |
height | const char * | Canvas height, supports pixels or percentage, if no unit is specified, calculated in pixels by default |
axisColor | TEduBoardColor | Canvas coordinate system color |
TEduAddBoardElementFormula
Add a formula element
Attribute list
Attribute | Type | Field Description |
expression | const char * | Formula element |
TEduBoardInfoList
Whiteboard information list
GetCount
Retrieve number of whiteboard information
virtual uint32_t GetCount() const =0
Return
Number of whiteboard information
GetBoardInfo
Retrieve specified whiteboard information
virtual TEduBoardInfo GetBoardInfo(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, number of whiteboards) |
Return
Whiteboard information
TEduBoardSelectedElementInfo
Element information
Attribute list
Attribute | Type | Field Description |
elementId | std::string | Element ID |
type | TEduBoardElementType | Element type |
left | int | Element distance from left side of whiteboard container |
top | int | Element distance from top of whiteboard container |
width | int | Element width |
height | int | Element height |
rotate | double | Element rotation angle |
boundingbox_left | int | Distance from the bounding box of the element to the left side of the whiteboard container |
boundingbox_top | int | Distance from the bounding box of the element to the top of the whiteboard container |
boundingbox_width | int | Width of the bounding box of the element |
boundingbox_height | int | Height of the bounding box of the element |
TEduBoardSelectedElementInfoList
List of selected whiteboard elements
GetCount
List of selected whiteboard elements
virtual uint32_t GetCount() const =0
Return
Number of selected whiteboard element information list
GetBoardSelectedElementInfo
Get specified whiteboard element information
virtual TEduBoardSelectedElementInfo GetBoardSelectedElementInfo(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, whiteboard element information) |
Return
Whiteboard Element Information
TEduBoardElementInfo
Element information
Attribute list
Attribute | Type | Field Description |
boardId | const char * | Whiteboard ID |
elementId | const char * | Element ID |
type | TEduBoardElementType | Element type |
url | const char * | Element address |
TEduBoardElementInfoList
Element information list
GetCount
Get the number of element information
virtual uint32_t GetCount() const =0
Return
Number of element information
GetElementInfo
Get specified element information
virtual TEduBoardElementInfo GetElementInfo(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, number of whiteboards) |
Return
Element information
Release
Release element information list
virtual void Release()=0
Warning
After using the element information list, be sure to call this interface to release memory.
TEduBoardFileInfo
File information
Attribute list
Attribute | Type | Field Description |
fileId | const char * | File ID |
title | const char * | File Name |
downloadUrl | const char * | File download address |
pageIndex | uint32_t | Current page displayed in the file |
pageCount | uint32_t | Number of pages in the file |
boardInfoList | const TEduBoardInfoList * | Whiteboard information list |
fileType | const TEduBoardFileType * | File Type |
TEduBoardKeyEvent
Keyboard events
Attribute list
Attribute | Type | Field Description |
type | TEduBoardKeyEventType | Keyboard event type |
modifiers | uint32_t | Keyboard Modifier Key Status described by bits, refer to TEduBoardEventFlag for values |
windowsKeyCode | int | Windows key code, this value is used by the DOM standard. On Windows, it comes from system events, while on other platforms it is determined by a mapping function (refer to document ) |
nativeKeyCode | int | Real key code generated by the platform |
isSystemKey | int | Specify whether the event is a "system key" event, which is only effective under the Windows system. |
character | wchar_t | Character generated by the key press |
unmodifiedCharacter | wchar_t | Character generated by the key press, but ignoring the influence of modifier keys (except for shift). This value is mainly used to trigger shortcuts |
focusOnEditableField | int | When in a text editing area, this value is 1. This value is mainly used to determine whether certain key events should be intercepted |
TEduBoardMouseEvent
Mouse events
Attribute list
Attribute | Type | Field Description |
x | int | X coordinate of the top-left origin of the view |
y | int | Y coordinate of the top-left origin of the view |
modifiers | uint32_t | Keyboard Modifier Key Status described by bits, refer to TEduBoardEventFlag for values |
TEduBoardTouchEvent
Touch events
Attribute list
Attribute | Type | Field Description |
id | int | Touch Point ID, can take any value other than -1, note that up to 16 touch points can be tracked simultaneously, any more will be ignored |
x | float | X-axis with the origin at the top-left corner of the view |
y | float | Y-axis with the origin at the top-left corner of the view |
radiusX | float | X-axis Radius (unit: pixels), if not applicable, pass 0 |
radiusY | float | Y-axis Radius (unit: pixels), if not applicable, pass 0 |
rotationAngle | float | Rotation Angle (unit: radians), if not applicable, pass 0 |
pressure | float | Normalized Pressure Value of the touch point, range [0,1], if not applicable, pass 0 |
type | TEduBoardTouchEventType | Touch Point Status, touch starts with TEDU_BOARD_TOUCHEVENT_PRESSED event, followed by 0~N TEDU_BOARD_TOUCHEVENT_MOVED events, and ends with TEDU_BOARD_TOUCHEVENT_RELEASED or TEDU_BOARD_TOUCHEVENT_CANCELLED event. Events not following this rule will be ignored |
modifiers | uint32_t | Keyboard Modifier Key Status described by bits, refer to TEduBoardEventFlag for values |
pointerType | TEduBoardPointType | Device Type that triggers the event |
TEduBoardRect
Rectangle Area
Attribute list
Attribute | Type | Field Description |
x | int32_t | Rectangle Start Position X-axis coordinate |
y | int32_t | Rectangle Start Position Y-axis coordinate |
width | int32_t | Rectangle Width |
height | int32_t | Rectangle Height |
TEduUserInfo
User Information
Attribute list
Attribute | Type | Field Description |
nickname | const char * | |
TEduBoardFileInfoList
File information list
GetCount
Number of File Information Obtained
virtual uint32_t GetCount() const =0
Return
Number of File Information
GetFileInfo
Get specified file information
virtual TEduBoardFileInfo GetFileInfo(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, number of files) |
Return
File information
Release
Release file information list
virtual void Release()=0
Warning
After using the file information list, be sure to call this interface to release memory.
TEduBoardStringList
String List
GetCount
Get number of strings
virtual uint32_t GetCount() const =0
Return
Number of strings
GetString
Get specified string
virtual const char* GetString(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, number of strings) |
Return
New Character String
Warning
The return value memory is managed internally by the SDK, no need for user to release it manually.
Release
Release string list
virtual void Release()=0
Warning
After using the string list, be sure to call this interface to release memory.
TEduBoardReMarkInfo
Whiteboard Remark Information
Attribute list
Attribute | Type | Field Description |
boardId | const char * | Whiteboard ID |
reMark | const char * | Whiteboard remarks |
TEduBoardReMarkInfoList
Whiteboard Remark List
GetCount
Get number of whiteboard remark information
virtual uint32_t GetCount() const =0
Return
Number of whiteboard remark information
GetBoardReMarkInfo
Get specified whiteboard remark information
virtual TEduBoardReMarkInfo GetBoardReMarkInfo(uint32_t index) const =0
Parameters
Parameters | Type | Meaning |
index | uint32_t | Index, value range [0, number of files) |
Return
Whiteboard Remark Information
Release
Release Whiteboard Comment Information List
virtual void Release()=0
Warning
After using the Whiteboard Comment Information List, be sure to call this interface to release the memory.
TEduBoardClassGroupInfo
Group Information
Attribute list
Attribute | Type | Field Description |
classGroupId | const char * | Whiteboard ID |
currentBoardId | const char * | |
title | const char * | |
boardIdList | const TEduBoardStringList * | |
userIdList | const TEduBoardStringList * | |
TEduBoardLogLevel
Log Level
Attribute list
Attribute | Field Description |
TEDU_BOARD_LOG_LEVEL_ALL | All logs |
TEDU_BOARD_LOG_LEVEL_INFO | General logs |
TEDU_BOARD_LOG_LEVEL_WARNING | Warning logs |
TEDU_BOARD_LOG_LEVEL_ERROR | Error Log |
TEDU_BOARD_LOG_LEVEL_OFF | Do not print logs |
TEduBoardFileType
Whiteboard File Type
Attribute list
Attribute | Field Description |
TEDU_FT_WHITEBOARD | Default whiteboard group |
TEDU_FT_H5_COURSEWARE | Dynamic transcoding courseware |
TEDU_FT_IMAGE_COURSEWARE | Static transcoding courseware |
TEDU_FT_VIDEO_FILE | Video files |
TEDU_FT_H5_FILE | H5 File |
TEDU_FT_IMAGES_FILE | Image group file |
TeduElementOperatorType
Whiteboard File Type
Attribute list
Attribute | Field Description |
TEDU_EOP_BOARDER_COLOR | Border color |
TEDU_EOP_BOARDER_WIDTH | Border Width |
TEDU_EOP_BOARDER_LINE_TYPE | Border Line Type |
TEDU_EOP_EL_DELETE | Delete element |