RtcWhiteboardInterface mixin

The RtcWhiteboard interface class provides all whiteboard methods invoked by the application.

Note The RtcWhiteboard object can be obtained through the RtcEngineKit instance.

RtcWhiteboard 接口类对应用程序提供了所有的白板相关方法。

Note RtcWhiteboard 对象可以通过 RtcEngineKit 实例获取。

Mixin Applications

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addAudioFile(String mediaUrl) Future<ResultCode>
add audio media file to current whiteboard page
addBackgroundImages(List<String> urls) Future<String?>
Add some background images to current whiteboard file
addDoc(WBDocContents contents) Future<String?>
Add a new whiteboard file
addDocWithExternal(WBDocExtContents contents) Future<String?>
Add a new whiteboard file with external contents
addDocWithExtHtml(WBDocExtHtml extHtml) Future<String?>
Add a new whiteboard file with external html
addH5File(String url, {String? downloadUrl}) Future<String?>
Add H5 file URL to current whiteboard file as background
addImageFile(String imageUrl) Future<ResultCode>
Add image file to current whiteboard page
addPage(bool autoSwitch) Future<ResultCode>
Add new page to the end.
addStamp(WBStamp stamp) Future<ResultCode>
Add Stamp Resource
addVideoFile(String mediaUrl) Future<ResultCode>
add video media file to current whiteboard page
broadcastMessage(Uint8List message) Future<ResultCode>
Broadcast message to all users.
clearContents(bool curPage, WBClearType type) Future<ResultCode>
clear whiteboard content
clearDocContents(String fileId, WBClearType type) Future<ResultCode>
Clear whiteboard content by specific file ID.
clearUserContents(String userId, bool curPage, WBClearType type) Future<ResultCode>
clear whiteboard content by specific user ID
close() Future<ResultCode>
Close the whiteboard.
createDocWithFilePath(String filePath, {WBConvertConfig? config}) Future<String?>
Upload local file for transcode and create new whiteboard file
createDocWithImages(List<String> urls) Future<String?>
Create new whiteboard file with some background images
deleteDoc(String fileId) Future<ResultCode>
Delete whiteboard file
enumerateFiles() Future<List<String>?>
Enumerate whiteboard files
getCurrentFileId() Future<String?>
get current whiteboard file ID
getCurrentPageNumber() Future<int>
Get current page number.
getCurrentScaleFactor() Future<double>
Get current whiteboard scale factor.
getCurrentWhiteboardId() Future<String?>
get current Whiteboard Id
getFileInfo(String fileId) Future<WBDocInfo?>
Get whiteboard file information with specific fileId
getToolType() Future<WBToolType>
Get tool type
getTotalNumberOfPages() Future<int>
Get total number of pages.
gotoPage(int pageNo) Future<ResultCode>
Goto the page with the page number.
initVision(WBVisionConfig config) Future<ResultCode>
Configure whiteboard initial size
insertPage(int pageNo, bool autoSwitch) Future<ResultCode>
Add new page after the page number.
leave() Future<ResultCode>
Leave the whiteboard.
nextPage() Future<ResultCode>
Switch to next page.
nextStep() Future<ResultCode>
next step for H5 doc
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open(RtcWhiteboardSurfaceViewModel viewModel) Future<ResultCode>
Open the whiteboard.
prevPage() Future<ResultCode>
Switch to previous page.
prevStep() Future<ResultCode>
previous step for H5 doc
redo() Future<ResultCode>
Redo the last undone operation of the whiteboard.
removePage(int pageNo, {bool switchNext = false}) Future<ResultCode>
goto the page pageNo
resetVision() Future<ResultCode>
Reset vision of current page
saveDocToImages(String fileId, String outputDir) Future<ResultCode>
Save whiteboard file. Save each page to one image.
sendMessage(Uint8List message, String userId) Future<ResultCode>
Send message to the user specified by userId.
sendToExternalHtml(String fileId, String msg) Future<ResultCode>
send custom message to external html
setBackgroundColor(WBColor color) Future<ResultCode>
Set the whiteboard background color.
setBackgroundImage(String imageUrl) Future<ResultCode>
Set the background image of current whiteboard page.
setBackgroundImageScalingMode(WBImageScalingMode mode) Future<ResultCode>
Set background image scaling mode.
setBackgroundImageWithPage(String imageUrl, int pageNo) Future<ResultCode>
Set background image of specified whiteboard page.
setCurrentScaleFactor(double scale) Future<ResultCode>
set current whiteboard scale factor
setFillColor(WBColor color) Future<ResultCode>
Set the whiteboard fill color.
setFillType(WBFillType type) Future<ResultCode>
Set the whiteboard fill type.
setFontSize(int size) Future<ResultCode>
Set the font size.
setFontStyle(WBFontStyle style) Future<ResultCode>
Set the whiteboard font style.
setForegroundColor(WBColor color) Future<ResultCode>
Set the whiteboard foreground color.
setLineWidth(int width) Future<ResultCode>
Set the whiteboard line width.
setOption(dynamic option, WBOptionType type) Future<ResultCode>
Set whiteboard option object.
setRoleType(WBRoleType type) Future<ResultCode>
Set whiteboard role type.
setStamp(String stampId) Future<ResultCode>
Set Stamp Resource
setToolType(WBToolType type) Future<ResultCode>
Set the whiteboard tool.
snapshot(WBSnapshotMode mode, String outputDir) Future<ResultCode>
Save whiteboard contents to image.
startFollowVision() Future<ResultCode>
Start follow vision
startShareVision() Future<ResultCode>
Start share vision
stop() Future<ResultCode>
Stop the whiteboard.
stopFollowVision() Future<ResultCode>
Stop follow vision
stopShareVision() Future<ResultCode>
Stop share vision
switchDoc(String fileId) Future<ResultCode>
Switch whiteboard file
syncVision() Future<ResultCode>
@Sync vision of current page
toString() String
A string representation of this object.
inherited
undo() Future<ResultCode>
Undo the last operation of the whiteboard.

Operators

operator ==(Object other) bool
The equality operator.
inherited