TEduBoard
Primary Interface Class for Whiteboard Features
Class | Description |
TEduBoard | Whiteboard Controller |
Creating and Terminating an Instance
Setting the TEduBoardCallback Callback
Basic Process Interface
API | Description |
Adding Whiteboard Synchronization Data | |
Getting the SDK Version Number | |
Configuring Whether Data Synchronization is Enabled for the Whiteboard | |
Retrieving Whether Data Synchronization is Enabled for the Whiteboard | |
Reset Whiteboard, Will Clear All Whiteboard Data |
Whiteboard Operation Interface
API | Description |
Confirm Data Sent Successfully | |
Adding Resource Primary and Backup Domain Mapping | |
Refresh Current Page Whiteboard, Trigger TEB_REFRESH Callback | |
Deleting resource primary-backup domain name mapping | |
Configuring Mouse Tool Behavior | |
Configuring Pen Automatic Fitting Mode | |
Set Proxy Server for Service | |
Set Whether the Remote Brush is Visible Locally | |
Move Whiteboard | |
Set the Zoom Ratio for the Zoom Tool | |
Whether to enable native system cursor | |
Syncing locally failed data to the remote and refreshing local data | |
Get Whether Doodling is Allowed on Whiteboard | |
Recalculate Whiteboard Size and Render | |
Set Whether Doodling is Allowed on Whiteboard | |
Set Which Users' Graphics are Allowed for Operations | |
Setting the output log level | |
Setting the visibility of the whiteboard scrollbar | |
Set whether segment erase mode is enabled | |
Getting the status of segment erase mode | |
Setting the eraser size | |
Getting the eraser size | |
Display own alias | |
Use mathematical ruler and compass tools | |
Enable automatic shape fitting during doodling (magic pen) | |
Get element information | |
Setting Element Styles |
File Operation Interface
API | Description |
Adding an H5 Page | |
Batch import images to the whiteboard | |
Adding a File for Transcoding | |
Add video file (internal interface) | |
Deleting Files | |
Proactively check file transcoding progress | |
Getting Current File ID | |
Getting File Information for a Specified File in the Whiteboard | |
Getting a List of File Information for All Uploaded Files in the Whiteboard | |
Getting a List of Whiteboard IDs for a Specified File | |
Getting Thumbnails for a Specified File, Default Files (fileId=#DEFAULT) Not Supported | |
Retrieving Whether Pen Stroke is Enabled for the Whiteboard | |
Set additional parameters for on-demand video, such as plugins, hlsConfig, etc. For details, please refer to VOD Development Documentation | |
Set file zoom ratio | |
Switching Files | |
Configuring Whether Pen Stroke is Enabled for the Whiteboard | |
Mute the transcoded H5PPT | |
Getting Remarks for Specified Courseware |
Whiteboard Page Operation Interface
API | Description |
Add a whiteboard page | |
Add whiteboard elements | |
Delete a whiteboard page | |
Get the adaptive mode of the whiteboard content | |
Get whiteboard element list | |
Get the whiteboard list of all files | |
Get the aspect ratio of the current whiteboard page | |
Get the zoom ratio of the current whiteboard page | |
Get the current whiteboard page ID | |
Go to the specified whiteboard page | |
Next | |
Turn to the next page | |
Back, each Step corresponds to an animation effect in PPT. If there are no currently displayed animation effects, calling this interface will cause the page to turn forward. | |
Turn to the previous page | |
Set the adaptive mode of the whiteboard content | |
Set the aspect ratio of the current whiteboard page | |
Set the zoom ratio of the current whiteboard page | |
Getting whiteboard remarks | |
Setting whiteboard remarks | |
Custom Whiteboard Tool Mouse Style | |
Customize the icon of the zoom tool | |
Jump to Specified Animation Step | |
Get Whiteboard Scroll Position |
Clearing Related
API | Description |
Clearing Doodles on Current Whiteboard Page | |
Clearing All Doodles on Specified File |
Doodling related
API | Description |
Get Whiteboard Tools in Use | |
Get Brush Color | |
Get Brush Thickness | |
Get text color | |
Get text size | |
Get text style | |
Get line style | |
Get ellipse drawing mode | |
Delete whiteboard elements | |
Set Whiteboard Tools to Use | |
Preset text tool content | |
Set Brush Color | |
Set Brush Thickness | |
Set Text Color | |
Set text size | |
Set text style | |
Set line style | |
Set ellipse drawing mode | |
Setting the number of layers erased per use of the eraser | |
Restrict Erasable Whiteboard Element Types | |
Set geometric drawing board elements | |
Set custom fonts | |
Add Custom Fonts | |
Get Current Font | |
Set fluorescent pen color | |
Get Fluorescent Pen Color |
Background Related
API | Description |
Set Background Image of Current Whiteboard Page | |
Set Background Color for All Whiteboards | |
Set Background Color of Current Whiteboard Page | |
Get Global Background Color of Whiteboard | |
Get Background Color of Current Whiteboard Page | |
Set Background H5 Page of Current Whiteboard Page | |
Set Global Background Image | |
Get global background image |
Undoing and Recovering
Interactive Whiteboard Audio and Video File APIs
API | Description |
Add video file | |
Enable audio control panel? Once disabled, the audio elements cannot be controlled through the interface interaction. | |
Get volume | |
Is Audio Muted | |
Pause audio | |
Playing Audio | |
Audio Jump to Specified Position | |
Set audio volume | |
Authorize Video File Playback | |
Whether to Authorize Video File Playback | |
Mutes. | |
Play | |
Pause | |
Hide and Show Default Video Control Bar | |
Internally start timer to periodically sync video status to remote (mp4 only) | |
Redirect (only supports on-demand video) | |
Sync local audio operation status to remote | |
Sync Local Video Operation Status to Remote | |
Stopping Synchronization of Video Status |
Screenshot Blackboards APIs
API | Description |
Creates a whiteboard snapshot. | |
Generate Whiteboard Image |
Group Discussion APIs
API | Description |
Adding Whiteboard to Group | |
Adding User to Group | |
Retrieving All Group IDs | |
Retrieving Group Mode Status | |
Retrieving the Group a User Is In | |
Retrieving Group Information | |
Redirect within Group | |
Remove Whiteboard from Group | |
Node Group Deletion | |
Remove User from Group | |
Resetting All Groups | |
Set Group | |
Enable Group Mode | |
Set Group Title |