The content of this page has been automatically translated by AI. If you encounter any problems while reading, you can view the corresponding content in Chinese.
Help & Documentation>Tencent Interactive Whiteboard>Client APIs>iOS & Mac>Key Type Definition

Key Type Definition

Last updated: 2024-12-23 10:48:21

On this page:

TEduBoardErrorCode

If this error occurs, it means the whiteboard is no longer available. Whiteboard error code TEduBoardErrorCode.
Enumeration
Type
Value
Description
TEDU_BOARD_ERROR_INIT
NSInteger
1
Initialization failed
TEDU_BOARD_ERROR_AUTH
NSInteger
2
Authentication failed. To resolve this issue, please purchase the service first
TEDU_BOARD_ERROR_LOAD
NSInteger
3
Failed to load the whiteboard. It is recommended to retry upon detecting this error.
TEDU_BOARD_ERROR_TIM_INVALID
NSInteger
5
The built-in IMSDK in the interactive whiteboard is unavailable. The interactive whiteboard will internally invoke the IMSDK interface, and if IMSDK is upgraded, the call will fail
Please refer to the TIM Signaling Channel Synchronization document.
TEDU_BOARD_ERROR_HISTORYDATA
NSInteger
6
Failed to sync historical data. It is recommended to retry upon detecting this error.
TEDU_BOARD_ERROR_RUNTIME
NSInteger
7
Whiteboard runtime error. Please check if sdkAppId, userId, and userSig are correct. Refer to the Error Code Document based on the error description.
TEDU_BOARD_ERROR_AUTH_TIMEOUT
NSInteger
8
Service authentication timed out. This problem may result from a network problem. Please try again
TEDU_BOARD_MAX_BOARD_LIMITED
NSInteger
10
The number of whiteboard pages within a single class has reached its limit
TEDU_BOARD_SIGNATURE_EXPIRED
NSInteger
11
userSig has expired, please generate a new userSig and reinitialize the whiteboard
TEDU_BOARD_ERROR_PATH_INVALID
NSInteger
102
The path is invalid
TEDU_BOARD_ERROR_WRITE_ERROR
NSInteger
103
A file write error occurred

TEduBoardWarningCode

Warning level. It will not affect the whiteboard. Use the whiteboard warning code TEduBoardWarningCode.
Enumeration
Type
Value
Description
TEDU_BOARD_WARNING_SYNC_DATA_PARSE_FAILED
NSInteger
1
Failed to parse the synchronization data from the other end. This warning is generally caused by the business side modifying the whiteboard signaling data structure or passing non-whiteboard signaling to the whiteboard.
TEDU_BOARD_WARNING_TIM_SEND_MSG_FAILED
NSInteger
2
Failed to send messages through invoking IM internally in the interactive whiteboard by reflection
TEDU_BOARD_WARNING_H5PPT_ALREADY_EXISTS
NSInteger
3
The courseware passed in when calling the addTranscodeFile interface already exists. The msg contains the fileId, which can be directly used to switch files with switchFile.
TEDU_BOARD_WARNING_ILLEGAL_OPERATION
NSInteger
5
No operation is allowed until the callback for interactive whiteboard historical data loading completion (onTEBHistroyDataSyncCompleted) is received.
TEDU_BOARD_WARNING_H5FILE_ALREADY_EXISTS
NSInteger
6
The h5 URL passed to the addH5File interface already exists.
TEDU_BOARD_WARNING_VIDEO_ALREADY_EXISTS
NSInteger
7
The video URL passed to the addVideoFile interface already exists.
TEDU_BOARD_WARNING_IMAGESFILE_ALREADY_EXISTS
NSInteger
8
The image array data passed to the addImagesFile interface already exists.
TEDU_BOARD_WARNING_CUSTOM_GRAPH_URL_NON_EXISTS
NSInteger
10
The custom graphic URL does not exist.
TEDU_BOARD_WARNING_IMAGESFILE_TOO_LARGE
NSInteger
11
The file content is too large when adding an image collection file via the addImagesFile interface.
TEDU_BOARD_WARNING_IMAGE_COURSEWARE_ALREADY_EXISTS
NSInteger
12
The static transcode courseware to be added already exists when adding static transcode courseware via the addTranscodeFile interface.
TEDU_BOARD_WARNING_IMAGE_MEDIA_BITRATE_TOO_LARGE
NSInteger
13
The multimedia resource bitrate is too high when adding multimedia resources.

TEduBoardAccessibleOperation

Enumeration
Type
Value
Description
TEDU_BOARD_OPERATION_ALL
NSInteger
0
All operations
TEDU_BOARD_OPERATION_MOVE
NSInteger
1
China Mobile
TEDU_BOARD_OPERATION_DELETE
NSInteger
2
Delete
TEDU_BOARD_OPERATION_SCALE
NSInteger
3
Scaling
TEDU_BOARD_OPERATION_ROTATE
NSInteger
4
Rotation
TEDU_BOARD_OPERATION_SELECTED
NSInteger
5
Selected
TEDU_BOARD_OPERATION_ADD
NSInteger
6
Add

TEduBoardArrowType

Enumeration
Type
Value
Description
TEDU_BOARD_ARROW_TYPE_NONE
NSInteger
1
No arrow
TEDU_BOARD_ARROW_TYPE_NORMAL
NSInteger
2
Normal arrow
TEDU_BOARD_ARROW_TYPE_SOLID
NSInteger
3
Solid arrow

TEduBoardAudioStatus

Enumeration
Type
Value
Description
TEDU_BOARD_AUDIO_STATUS_ERROR
NSInteger
1
Playback error
TEDU_BOARD_AUDIO_STATUS_LOADING
NSInteger
2
Loading
TEDU_BOARD_AUDIO_STATUS_LOADED
NSInteger
3
Load complete
TEDU_BOARD_AUDIO_STATUS_PLAYED
NSInteger
4
Start playback
TEDU_BOARD_AUDIO_STATUS_TIMEUPDATE
NSInteger
5
Time update
TEDU_BOARD_AUDIO_STATUS_PAUSED
NSInteger
6
Pause
TEDU_BOARD_AUDIO_STATUS_SEEKED
NSInteger
7
Redirect
TEDU_BOARD_AUDIO_STATUS_ENDED
NSInteger
8
End
TEDU_BOARD_AUDIO_STATUS_WAITING
NSInteger
9
Buffering
TEDU_BOARD_AUDIO_STATUS_PLAYING
NSInteger
10
Buffering ended

TEduBoardBackgroundH5Status

Enumeration
Type
Value
Description
TEDU_BOARD_BACKGROUND_H5_STATUS_LOADING
NSInteger
1
H5 background loading
TEDU_BOARD_BACKGROUND_H5_STATUS_LOAD_FINISH
NSInteger
2
H5 background loaded

TEduBoardBackgroundType

Enumeration
Type
Value
Description
TEDU_BOARD_BACKGROUND_IMAGE
NSInteger
1
Image type
TEDU_BOARD_BACKGROUND_H5
NSInteger
2
Webpage type

TEduBoardClassGroupOperationType

Enumeration
Type
Value
Description
TEduBoardClassGroupOperationTypeSET_ENABLE
NSInteger
0
Enable Group Mode
TEduBoardClassGroupOperationTypeUPDATE
NSInteger
1
Update group information
TEduBoardClassGroupOperationTypeDELETE
NSInteger
2
Node Group Deletion
TEduBoardClassGroupOperationTypeRESET
NSInteger
3
Reset group
TEduBoardClassGroupOperationTypeERROR
NSInteger
4
Group feature error occurred

TEduBoardContentFitMode

Enumeration
Type
Value
Description
TEDU_BOARD_CONTENT_FIT_MODE_NONE
NSInteger
0
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
NSInteger
1
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
NSInteger
2
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

TEduBoardElementType

Enumeration
Type
Value
Description
TEDU_BOARD_ELEMENT_IMAGE
NSInteger
1
Image element
TEDU_BOARD_ELEMENT_H5
NSInteger
2
Webpage element
TEDU_BOARD_ELEMENT_CUSTOM_GRAPH
NSInteger
3
Custom shapes
TEDU_BOARD_ELEMENT_AUDIO
NSInteger
4
Audio element, currently effective on the whiteboard
TEDU_BOARD_ELEMENT_GLOBAL_AUDIO
NSInteger
5
Global audio element, no control interface, usually background music
TEDU_BOARD_ELEMENT_MATH_BOARD
NSInteger
6
Mathematical function whiteboard
TEDU_BOARD_ELEMENT_MATH_GRAPH
NSInteger
7
Mathematical function graph
TEDU_BOARD_ELEMENT_TEXT
NSInteger
9
Text element
TEDU_BOARD_ELEMENT_MAGIC_LINE
NSInteger
10
Magic pen element
TEDU_BOARD_ELEMENT_FORMULA
NSInteger
11
Mathematical formula element
TEDU_BOARD_ELEMENT_GRAFFITI_LINE
NSInteger
801
Line doodle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_LINE
NSInteger
802
Straight line doodle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL
NSInteger
804
Ellipse doodle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RECT
NSInteger
803
Rectangle doodle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_OVAL
NSInteger
804
Ellipse doodle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_ARC
NSInteger
805
arc element
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_RIGHT_TRIANGLE
NSInteger
806
Right triangle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_ISOSCELES_TRIANGLE
NSInteger
807
isosceles triangle
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_PARALLELOGRAM
NSInteger
808
parallelogram
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CUBE
NSInteger
809
Cube
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CYLINDER
NSInteger
810
Cylinder
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_CONE
NSInteger
811
Cone
TEDU_BOARD_ELEMENT_GRAFFITI_GRAPH_HIGHLIGHTER
NSInteger
812
highlighter

TEduBoardErasableElementType

Enumeration
Type
Value
Description
LINE
NSInteger
0
Line element
GRAPH
NSInteger
1
Shape element
TEXT
NSInteger
2
Text element
IMAGE
NSInteger
3
Image element
ELEMENT
NSInteger
4
Custom element

TEduBoardFileTranscodeStatus

Deprecated since version 2.6.5
Enumeration
Type
Value
Description
TEDU_BOARD_FILE_TRANSCODE_ERROR
NSInteger
1
Transcoding Error
TEDU_BOARD_FILE_TRANSCODE_UPLOADING
NSInteger
2
File Uploading
TEDU_BOARD_FILE_TRANSCODE_CREATED
NSInteger
3
Initiating Transcoding Task
TEDU_BOARD_FILE_TRANSCODE_QUEUE
NSInteger
4
Queuing
TEDU_BOARD_FILE_TRANSCODE_PROCESSING
NSInteger
5
Transcoding
TEDU_BOARD_FILE_TRANSCODE_FINISHED
NSInteger
6
Transcoding Completed

TEduBoardH5FileStatus

Enumeration
Type
Value
Description
TEDU_BOARD_H5_FILE_STATUS_LOADING
NSInteger
1
Loading
TEDU_BOARD_H5_FILE_STATUS_LOADED
NSInteger
2
Load complete

TEduBoardH5PPTStatus

Enumeration
Type
Value
Description
TEDU_BOARD_H5_PPT_STATUS_LOADING
NSInteger
1
Loading
TEDU_BOARD_H5_PPT_STATUS_LOADED
NSInteger
2
Load complete
TEDU_BOARD_H5_PPT_STATUS_CANCEL
NSInteger
3
Cancel loading (current PPT not yet loaded, switched to another file)
TEDU_BOARD_H5_PPT_STATUS_TIMEOUT
NSInteger
4
Loading timeout
TEDU_BOARD_H5_PPT_STATUS_RESOURCES_LOADING_ERROR
NSInteger
5
Resource Loading Failure
TEDU_BOARD_H5_PPT_STATUS_RUNTIME_ERROR
NSInteger
6
Internal runtime error

TEduBoardImageFitMode

Enumeration
Type
Value
Description
TEDU_BOARD_IMAGE_FIT_MODE_BOTTOM
NSInteger
7
Bottom align and proportionally enlarge based on width or height
TEDU_BOARD_IMAGE_FIT_MODE_CENTER
NSInteger
0
Center align and proportionally enlarge based on width or height
TEDU_BOARD_IMAGE_FIT_MODE_LEFT
NSInteger
4
Left align and proportionally enlarge based on width or height
TEDU_BOARD_IMAGE_FIT_MODE_RIGHT
NSInteger
6
Right align and proportionally enlarge based on width or height
TEDU_BOARD_IMAGE_FIT_MODE_TOP
NSInteger
5
Top align and proportionally enlarge based on width or height

TEduBoardImageStatus

Enumeration
Type
Value
Description
TEDU_BOARD_IMAGE_STATUS_LOADING
NSInteger
1
Background image loading
TEDU_BOARD_IMAGE_STATUS_LOAD_DONE
NSInteger
2
Background image loaded
TEDU_BOARD_IMAGE_STATUS_LOAD_ABORT
NSInteger
3
Background image loading interrupted
TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR
NSInteger
4
Background image loading error
TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT
NSInteger
5
Background image loading timeout
TEDU_BOARD_IMAGE_STATUS_LOAD_CANCEL
NSInteger
6
Background image loading canceled
TEDU_BOARD_IMAGE_STATUS_READ_ERROR
NSInteger
7
Local image loading error

TEduBoardLineType

Enumeration
Type
Value
Description
TEDU_BOARD_LINE_TYPE_SOLID
NSInteger
1
Solid line
TEDU_BOARD_LINE_TYPE_DOTTED
NSInteger
2
Dashed line

TEduBoardMathGraphCode

Enumeration
Type
Value
Description
MATH_EXPRESSION_PARSE_ERROR
NSInteger
-1
Function expression parsing failed

TEduBoardMathGraphType

Enumeration
Type
Value
Description
NONE
NSInteger
0
No graphic input, geometric shapes can be selected at this time
PONSInteger
NSInteger
1
Point
LINE
NSInteger
2
Line
LINE_SEGMENT
NSInteger
3
Line
RAY
NSInteger
4
Ray
CIRCLE
NSInteger
5
round
ANGLE
NSInteger
6
Angle
POLYGON
NSInteger
7
Polygon

TEduBoardOvalDrawMode

Enumeration
Type
Value
Description
TEDU_BOARD_OVAL_DRAW_MODE_FIX_START
NSInteger
1
Fix the starting point, the midpoint between the starting point and the endpoint is the center
TEDU_BOARD_OVAL_DRAW_MODE_FIX_CENTER
NSInteger
2
Fix the center, the starting point is the center

TEduBoardPenFittingMode

Enumeration
Type
Value
Description
NONE
NSString
none
No fitting
AUTO
NSString
auto
Automatically recognize and fit shapes
CIRCLE
NSString
circle
Fit Circle
ELLIPSE
NSString
ellipse
Fit Ellipse
POLYGON
NSString
polygon
Fit Polygon
RECTANGLE
NSString
rectangle
Fit Rectangle

TEduBoardPosition

Enumeration
Type
Value
Description
TEDU_BOARD_POSITION_LEFT_BOTTOM
NSInteger
4
Bottom Left
TEDU_BOARD_POSITION_LEFT_TOP
NSInteger
1
Top Left
TEDU_BOARD_POSITION_RIGHT_BOTTOM
NSInteger
3
Bottom Right
TEDU_BOARD_POSITION_RIGHT_TOP
NSInteger
2
Top Right

TEduBoardTextComponentStatus

Enumeration
Type
Value
Description
TEDU_BOARD_TEXT_COMPONENT_STATUS_INSUFFICIENT_SPACE
NSInteger
1
Insufficient space, text box cannot be displayed
TEDU_BOARD_TEXT_COMPONENT_STATUS_WORD_LIMIT
NSInteger
2
Text exceeds character limit

TEduBoardTextStyle

Enumeration
Type
Value
Description
TEDU_BOARD_TEXT_STYLE_BOLD
NSInteger
0
Bold style
TEDU_BOARD_TEXT_STYLE_BOLD_ITALIC
NSInteger
1
Bold italic style
TEDU_BOARD_TEXT_STYLE_ITALIC
NSInteger
2
Italic style
TEDU_BOARD_TEXT_STYLE_NORMAL
NSInteger
3
Regular style

TEduBoardToolType

Enumeration
Type
Value
Description
TEDU_BOARD_TOOL_TYPE_MOUSE
NSInteger
0
Mouse, default mouse tool click on whiteboard will page turning, if this feature is not needed, you can call the setMouseToolBehavior interface settings, or through initialization parameter settings
TEDU_BOARD_TOOL_TYPE_PEN
NSInteger
1
Brush
TEDU_BOARD_TOOL_TYPE_ERASER
NSInteger
2
Eraser
TEDU_BOARD_TOOL_TYPE_LASER
NSInteger
3
Laser pointer
TEDU_BOARD_TOOL_TYPE_LINE
NSInteger
4
Straight line can be set to draw straight lines, dashed lines, arrows
TEDU_BOARD_TOOL_TYPE_OVAL
NSInteger
5
Hollow Ellipse
TEDU_BOARD_TOOL_TYPE_OVAL_SOLID
NSInteger
7
Solid Ellipse
TEDU_BOARD_TOOL_TYPE_RECT
NSInteger
6
Hollow Rectangle
TEDU_BOARD_TOOL_TYPE_RECT_SOLID
NSInteger
8
Solid Rectangle
TEDU_BOARD_TOOL_TYPE_PONSInteger_SELECT
NSInteger
9
Selection tool (merged with rectangle selection tool, keep one)
TEDU_BOARD_TOOL_TYPE_RECT_SELECT
NSInteger
10
Rectangle selection tool (merged with selection tool, keep one)
TEDU_BOARD_TOOL_TYPE_TEXT
NSInteger
11
Text tool
TEDU_BOARD_TOOL_TYPE_ZOOM_DRAG
NSInteger
12
Zoom and move tool, from version 2.6.4, supports initializing with pinchToZoomEnable to enable zooming the whiteboard under any tool
TEDU_BOARD_TOOL_TYPE_SQUARE
NSInteger
13
Hollow Square
TEDU_BOARD_TOOL_TYPE_SQUARE_SOLID
NSInteger
14
Solid Square
TEDU_BOARD_TOOL_TYPE_CIRCLE
NSInteger
15
Hollow Circle
TEDU_BOARD_TOOL_TYPE_CIRCLE_SOLID
NSInteger
16
Solid Circle
TEDU_BOARD_TOOL_TYPE_BOARD_CUSTOM_GRAPH
NSInteger
17
Custom shapes

TEduBoardUploadStatus

Enumeration
Type
Value
Description
TEDU_BOARD_UPLOAD_STATUS_SUCCEED
NSInteger
1
Upload successful
TEDU_BOARD_UPLOAD_STATUS_FAILED
NSInteger
2
Upload failed

TEduBoardVideoStatus

Enumeration
Type
Value
Description
TEDU_BOARD_VIDEO_STATUS_ERROR
NSInteger
1
Playback error
TEDU_BOARD_VIDEO_STATUS_LOADING
NSInteger
2
Loading
TEDU_BOARD_VIDEO_STATUS_LOADED
NSInteger
3
Load complete
TEDU_BOARD_VIDEO_STATUS_PLAYED
NSInteger
4
Start playback
TEDU_BOARD_VIDEO_STATUS_TIMEUPDATE
NSInteger
5
Time status update
TEDU_BOARD_VIDEO_STATUS_PAUSED
NSInteger
6
Pause
TEDU_BOARD_VIDEO_STATUS_SEEKED
NSInteger
7
Redirect
TEDU_BOARD_VIDEO_STATUS_ENDED
NSInteger
8
End
TEDU_BOARD_VIDEO_STATUS_WAITING
NSInteger
9
Buffering
TEDU_BOARD_VIDEO_STATUS_PLAYING
NSInteger
10
Buffering ended

TEduBoardFileType

Enumeration
Type
Value
Description
TEduBoardWHITEBOARD
NSInteger
1
Default whiteboard group
TEduBoardH5_COURSEWARE
NSInteger
2
Dynamic transcoding courseware
TEduBoardIMAGE_COURSEWARE
NSInteger
3
Static transcoding courseware
TEduBoardVIDEO_FILE
NSInteger
4
Video files
TEduBoardH5_FILE
NSInteger
5
H5 file
TEduBoardIMAGES_FILE
NSInteger
6
Image group file

TEduBoardLogLevel

Enumeration
Type
Value
Description
TEduBoardLogLevelALL
NSInteger
0
All logs
TEduBoardLogLevelINFO
NSInteger
1
General logs
TEduBoardLogLevelWARNING
NSInteger
2
Warning logs
TEduBoardLogLevelERROR
NSInteger
3
Error Log
TEduBoardLogLevelOFF
NSInteger
4
Do not print logs

TEduBoardAddElementOptions

Attribute
Type
Description
erasable
BOOL
Whether the element supports erasing with an eraser. The default is true
left
NSString
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
NSString
Offset of the element from the top boundary. Supports pixels or percentage. If the unit is not specified, it is calculated in pixels by default

TEduBoardAuthParam

Attribute
Type
Description
sdkAppId
NSInteger
SDKAppID
userId
NSString
User ID
userSig
NSString
User’s signature

TEduBoardCursorIcon

Attribute
Type
Description
cursor
NSString
Built-in mouse pointer styles in the browser, refer to the documentation for possible values
url
NSString
URL for custom mouse pointer styles, refer to the documentation for format restrictions
offsetY
NSInteger
Vertical offset for custom mouse pointer styles
offsetX
NSInteger
Horizontal offset for custom mouse pointer styles

TEduBoardElementInfo

Attribute
Type
Description
boardId
NSString
Whiteboard ID
elementId
NSString
Element ID
type
NSInteger
url
NSString
Element address

TEduBoardElementMathBoard

Attribute
Type
Description
axis
BOOL
Whether to display axes
axisColor
TEColor
Canvas coordinate system color #ffffff;
boundingbox
TEEdgeInsets
Bottom left and right corners of the canvas display area corresponding to [x1,y1,x2,y2]
enablePan
BOOL
Whether to enable mouse drag panning
enableZoom
BOOL
Whether to enable mouse wheel zooming
grid
BOOL
Whether to display the grid
height
NSString
Canvas height, supports pixels or percentage
showControl
BOOL
Whether to display the control bar
width
NSString
Canvas width, supports pixels or percentage

TEduBoardElementMathGraph

Attribute
Type
Description
color
TEColor
Mathematical function graph color
expression
NSString
Mathematical function expression
mathBoardId
NSString
Element ID of the function drawing board
selectedColor
TEColor
Color when the mathematical function graph is selected

TEduBoardElementOperationAuthority

Attribute
Type
Description
disableArbitraryScale
BOOL
Whether to disable arbitrary scaling (text elements default to true and cannot be changed)
disableMove
BOOL
Whether to disable moving
disableProportionScale
BOOL
Whether to disable proportional scaling
disableRotate
BOOL
Whether to disable rotation (text elements default to true and cannot be changed)

TEduBoardFileInfo

Attribute
Type
Description
boardInfoList
Whiteboard information list
downloadURL
NSString
File download address
fileId
NSString
File ID
pageCount
NSInteger
Number of pages in the file
pageIndex
NSInteger
Current page displayed in the file
title
NSString
File Name
fileType
NSInteger

TEduBoardInfo

Attribute
Type
Description
backgroundColor
TEColor
Whiteboard background color
backgroundUrl
NSString
Background image or background H5 page URL
boardId
NSString
Whiteboard ID

TEduBoardInitAuthConfig

Attribute
Type
Description
dataSyncEnable
BOOL
Whether to enable data synchronization, disabling it will result in local whiteboard operations not being synchronized to the remote end
drawEnable
BOOL
Whether to allow doodling, default YES
enableScaleTool
BOOL
Whether to enable the zoom feature of the whiteboard zooming and moving tool, default is true
formulaEnable
BOOL
Preload formula library
isAutoHideRemoteCursor
BOOL
Automatically hide remote brush after 2 seconds of inactivity
mathGraphEnable
BOOL
Whether to preload Mathematical Function Image Library
pinchToZoomEnable
BOOL
Enable two-finger zoom under any tool
progressEnable
BOOL
Whether to enable SDK built-in Loading Icon
showCursorOnTouch
BOOL
Whether to display brush on mobile devices
showLocalOperator
BOOL
Whether to display local operation information (when the selection box tool selects a whiteboard element, the creator of the whiteboard element is displayed)
showRemoteOperator
BOOL
Whether to display remote operation information (when a remote user uses the selection box tool, the whiteboard element operated by the remote user is displayed locally)
showRemoteSelectBox
BOOL
Whether to display remote selection box
systemCursorEnable
BOOL
Whether to enable native system cursor, default is false
elementOperationAuthority
Set whiteboard element operation permissions
mouseToolBehavior
Configuring Mouse Tool Behavior
remoteCursorVisible
Whether to display remote brush

TEduBoardInitConfig

Attribute
Type
Description
autoHideRemoteCursorTimeout
UInt32
Remote hide brush time (milliseconds)
boardContentFitMode
Whiteboard content adaptive mode, default is TEDU_BOARD_CONTENT_FIT_MODE_NONE
offlineWarningTimeout
NSInteger
Whiteboard offline alarm time interval in seconds
preloadDepth
NSInteger
Image preloading depth, default value is 5, which means preloading images of 5 pages before and after the current page
progressBarUrl
NSString
Customize loading icon, effective when progressEnable = true, supports jpg, gif, png, svg
ratio
NSString
Default whiteboard aspect ratio, can be in string formats like "4:3","16:9", default is "16:9"
scale
UInt32
Whiteboard default zoom factor, the actual zoom factor is scale/100
scaleRange
NSArray<NSNumber*>
Whiteboard zoom range, in percentage form, 100 means 100% without zoom, default value is @[@100, @1600]
syncFps
NSInteger
Signaling synchronization frequency, the allowed range for this value is [5, 20], default is 5
toolType
Whiteboard Tool, default is TEDU_BOARD_TOOL_TYPE_PEN

TEduBoardInitParam

Attribute
Type
Description
authConfig
Permission Configuration Parameter
config
General Configuration Parameter
imageTimeout
int
Image loading timeout, unit in seconds, default 10s
smoothLevel
float
Smoothing coefficient, default 0, range [0,1]
styleConfig
Style configuration parameters
timSync
BOOL
Whether to use Tencent Cloud IMSDK for real-time data synchronization, default YES
userConfig
User configuration parameters

TEduBoardInitStyleConfig

Attribute
Type
Description
brushColor
TEColor
Brush color
brushThin
int
Brush thickness, default 100
cursorSize
NSArray<NSNumber*>
Brush size limit
globalBackgroundColor
TEColor
Global background color
selectAnchorColor
TEColor
Selection box zoom control point color
selectBoxColor
TEColor
Selection box color, including the zoom and rotate buttons on the selection box
textColor
TEColor
Text color
textSize
int
Text thickness, default 320
textStyle
Text style, default TEDU_BOARD_TEXT_STYLE_NORMAL

TEduBoardInitUserConfig

Attribute
Type
Description
nickname
NSString
Current whiteboard user nickname

TEduBoardLineStyle

Attribute
Type
Description
lineType
Line type, default TEDU_BOARD_LINE_TYPE_SOLID
endArrowType
End arrow type, default TEDU_BOARD_ARROW_TYPE_NONE
startArrowType
Start arrow type, default TEDU_BOARD_ARROW_TYPE_NONE

TEduBoardMouseToolBehavior

Attribute
Type
Description
turnPage
Page-turning behavior

TEduBoardMouseToolTurnPage

Attribute
Type
Description
h5PPT
BOOL
Dynamic PPT Transcoded files are page turnable on click
imgFile
BOOL
Image file (files added by the addImagesFile interface) are non-page turnable on click
imgPPT
BOOL
Static PPT transcoded file is non-page turnable on click
whiteBoard
BOOL
Ordinary whiteboard is page turnable on click

TEduBoardOperationAuthority

Attribute
Type
Description
graph
Shape doodle elements
line
Brush doodle elements
text
Text element

TEduBoardSnapshotInfo

Attribute
Type
Description
path
NSString
Local path for snapshot file storage, including file name and extension, only supports png, e.g., aaa/bbb/ccc/xxx.png

TEduBoardToolTypeTitleStyle

Attribute
Type
Description
color
TEColor
Text color
position
Display Position
size
UInt32
Actual pixel value: (size * Whiteboard's height / 10000)px
style
Text style

TEduBoardTranscodeConfig

Attribute
Type
Description
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).
minResolution
NSString
Specify the minimum resolution of the transcoding result to improve the clarity of the transcoding result, such as 960x540, with 'x' as the width-height separator
thumbnailResolution
NSString
Specify the resolution of the generated thumbnail, default is non-generation (generating thumbnails will add additional transcoding consumption), such as 200x200, with 'x' as the width-height separator

TEduBoardTranscodeFileResult

Attribute
Type
Description
pages
NSInteger
Total number of pages
progress
NSInteger
Transcoding Progress (Percentage)
resolution
NSString
File resolution, such as @"1024x768"
status
Transcoding Status
taskId
NSString
Task ID
thumbnailResolution
NSString
Thumbnail Generation Resolution of the File, such as @"200x200"
thumbnailUrl
NSString
Thumbnail Generation URL of the File
title
NSString
File title
url
NSString
Transcoding result URL

TEduBoardUserInfo

Attribute
Type
Description
nickname
NSString
User Nickname

TEduMathToolType

Enumeration
Type
Value
Description
RULER
NSInteger
1
Ruler teaching aid
TRIANGLE
NSInteger
2
Right triangle
ISOSCELES_TRIANGLE
NSInteger
3
Isosceles right triangle
PROTRACTOR
NSInteger
4
Protractor
COMPASSES
NSInteger
5
Compass

TEduElementOperatorType

Enumeration
Type
Value
Description
TEduElementOperatorTypeBOARDER_COLOR
NSInteger
1
border color
TEduElementOperatorTypeBOARDER_WIDTH
NSInteger
2
border width
TEduElementOperatorTypeBOARDER_LINE_TYPE
NSInteger
3
solid/dashed
TEduElementOperatorTypeEL_DELETE
NSInteger
4
Delete element
中国站 - English