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