WhiteRoom class

Inheritance

Constructors

WhiteRoom({required RoomOptions options, required DsBridge dsBridge, RoomStateChangedCallback? onRoomStateChanged, RoomPhaseChangedCallback? onRoomPhaseChanged, RoomDisconnectedCallback? onRoomDisconnected, UndoStepsUpdatedCallback? onCanUndoStepsUpdate, RedoStepsUpdatedCallback? onCanRedoStepsUpdate, RoomKickedCallback? onRoomKicked, RoomErrorCallback? onRoomError})

Properties

disableCameraTransform bool
禁止/允许用户调整(移动或缩放)视角。
no getter
disableDeviceInputs bool
禁止/允许用户操作白板工具。
no getter
disableOperations bool
允许/禁止白板响应用户任何操作。
no getter
disableWindowOperation bool
禁止/允许窗口操作。
no getter
disconnectedBySelf bool
getter/setter pair
dsBridge DsBridge
finalinherited
hashCode int
The hash code for this object.
no setterinherited
observerId int
getter/setter pair
onCanRedoStepsUpdate RedoStepsUpdatedCallback?
getter/setter pair
onCanUndoStepsUpdate UndoStepsUpdatedCallback?
getter/setter pair
onRoomDisconnected RoomDisconnectedCallback?
getter/setter pair
onRoomError RoomErrorCallback?
getter/setter pair
onRoomKicked RoomKickedCallback?
getter/setter pair
onRoomPhaseChanged RoomPhaseChangedCallback?
getter/setter pair
onRoomStateChanged RoomStateChangedCallback?
getter/setter pair
options RoomOptions
final
phase RoomPhase
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state RoomState
getter/setter pair
timeDelay int
getter/setter pair
writable bool
getter/setter pair

Methods

addApp(WindowAppParams appParam) Future<String>
添加窗口
addPage([Scene? scene, bool after = false]) → void
cleanScene(bool retainPPT) → void
completeImageUpload(String uuid, String url) → void
convertToPointInWorld(num x, num y) Future<WhiteBoardPoint>
转换白板上点的坐标。
inherited
copy() → void
复制选中内容。
createRoomInterface() JavaScriptNamespaceInterface
debugInfo() Future<Map<String, dynamic>>
delete() → void
删除选中的内容。
disableEraseImage(bool value) → void
disableSerialization(bool disable) → void
开启/禁止本地序列化。 @param disable 是否禁止本地序列化: - true:(默认)禁止开启本地序列化; - false: 开启本地序列化,即可以对本地操作进行解析。 设置 disableSerialization(true) 后,以下方法将不生效:
disconnect() Future<bool>
dispatchMagixEvent(AkkoEvent eventEntry) → void
发送自定义事件。
duplicate() → void
复制并粘贴选中的内容。
genUuidV4() String
getBroadcastState() Future<BroadcastState>
getEntireScenes(String path) Future<Map<String, List<Scene>>>
inherited
getGlobalState<T extends GlobalState>(GlobalStateParser<T> parser) Future<T>
getMemberState() Future<MemberState>
getObserverId() int
getRoomMembers() Future<List<RoomMember>>
getRoomPhase() Future<String>
getRoomPhaseNative() String
getRoomState() Future<RoomState>
异步获取最新房间状态
getRoomStateNative() RoomState
获取本地缓存的房间状态
getScenePathType(String path) Future<String>
inherited
getScenes() Future<List<Scene>>
getSceneState() Future<WhiteBoardSceneState>
getTimeDelay() int
获取设置得远端白板画面同步延时。单位为秒。
getWritable() bool
getZoomScale() Future<num>
获取当前用户的视野缩放比例。
insertImage(ImageInformation imageInfo) → void
插入图片显示区域
insertImageByUrl(ImageInformation imageInfo, String url) → void
insertText(int x, int y, String text) → void
插入文字
isDisconnectedBySelf() bool
moveCamera(CameraConfig config) → void
inherited
moveCameraToContainer(RectangleConfig config) → void
inherited
moveScene(String sourcePath, String targetDirOrPath) → void
移动场景。
nextPage() Future<bool>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paste() → void
粘贴复制的内容。
postIframeMessage(dynamic object) → void
inherited
pptNextStep() → void
pptPreviousStep() → void
prevPage() Future<bool>
putScenes(String dir, List<Scene> scene, int index) Future<Map<String, dynamic>>
redo() → void
重做,即回退撤销操作。
refreshViewSize() → void
inherited
removeScenes(String dirOrPath) → void
删除场景或者场景组。
scaleIframeToFit() → void
inherited
scalePptToFit([String mode = AnimationMode.Continuous]) → void
inherited
setBackgroundColor(Color color) → void
inherited
setCameraBound(CameraBound cameraBound) → void
inherited
setContainerSizeRatio(double ratio) → void
设置多窗口显示比例 ratio 高与宽比例
setDisableCameraTransform(bool disable) → void
inherited
setGlobalState(GlobalState modifyState) → void
setMemberState(MemberState state) → void
setPrefersColorScheme(WindowPrefersColorScheme colorScheme) → void
设置设置暗色模式
setSceneIndex(int index) Future<bool>
切换至当前场景组下的指定场景。
setScenePath(String path) Future<bool>
切换至指定的场景。
setTimeDelay(int delaySec) → void
设置远端白板画面同步延时。单位为秒。
setViewMode(ViewMode viewMode) → void
setWritable(bool writable) Future<bool>
syncBlockTimestamp(int utcMs) → void
同步时间戳。
toString() String
A string representation of this object.
inherited
undo() → void
撤销上一步操作。

Operators

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

Constants

tag → const String