FastRoomController class
Control a FastRoomView.
A FastRoomController instance can be obtained by setting the FastRoomView.onFastRoomCreated callback for a FastRoomView widget.
- Inheritance
-
- Object
- ChangeNotifier
- ValueNotifier<
FastRoomValue> - FastRoomController
Constructors
- FastRoomController(FastRoomOptions fastRoomOptions)
Properties
- containerSizeRatio ↔ double?
-
getter/setter pair
- fastRoomOptions ↔ FastRoomOptions
-
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- ratioWhenNull → double?
-
no setter
- roomLayoutSize ↔ Size?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useDarkTheme ↔ bool?
-
getter/setter pair
- value ↔ FastRoomValue
-
The current value stored in this notifier.
getter/setter pairinherited
- whiteRoom ↔ WhiteRoom?
-
whiteboard_flutter WhiteRoom instance, export for specific usage
getter/setter pair
- whiteSdk ↔ WhiteSdk?
-
whiteboard_flutter WhiteSdk instance, export for specific usage
getter/setter pair
- zoomScaleDefault ↔ num
-
getter/setter pair
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
addPage(
) → void - add a page current scene dir.
-
changeOverlay(
int key) → void -
cleanScene(
) → void - clean current scene. bath paint element (line, text, etc.) and image
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
override
-
insertDoc(
InsertDocParams params) → Future< String?> - insert a doc(InsertDocParams) into sub_window. window app display InsertDocParams.title.
-
insertImage(
String url, num width, num height) → void -
insert a
url
image with whiteboard size (width
,height
) at whiteboard center point (0, 0) -
insertVideo(
String url, String title) → Future< String?> -
insert a video or audio with
url
into sub_window. window app displaytitle
. -
joinRoom(
) → Future< void> - joins the whiteboard room.
-
joinRoomWithSdk(
WhiteSdk whiteSdk) → Future< void> -
nextPage(
) → void - change to next page;
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyFastError(
WhiteException exception) → void -
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
notifySizeChanged(
Size size) → void -
onError(
) → Stream< FastErrorEvent> - The fast room cause a error.
-
onOverlayChanged(
) → Stream< OverlayChangedEvent> - The fast room overlay has changed. overlay is room extension operation view.
-
onSizeChanged(
) → Stream< SizeChangedEvent> - The fast room view size has changed.
-
prevPage(
) → void - change to preview page.
-
reconnect(
) → Future< void> -
redo(
) → void - redoes an undone action.
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
removePages(
) → void - remove all pages.
-
setAppliance(
FastAppliance fastAppliance) → void -
sets the whiteboard tool currently in use. all tools see FastAppliance.
when
fastAppliance
is FastAppliance.clear, clean scene paint element. -
setContainerSizeRatio(
double ratio) → void -
setStrokeColor(
Color color) → void -
sets element paint stroke color to
color
. -
setStrokeWidth(
num strokeWidth) → void -
sets element paint stroke width to
strokeWidth
. -
setWritable(
bool writable) → Future< bool> - sets whether the user is in interactive mode in the room. true: interactive mode, that is, with read and write permissions. false: subscription mode, that is, with read-only permission.
-
toString(
) → String -
A string representation of this object.
inherited
-
undo(
) → void - undoes an undone action.
-
updateRoomLayoutSize(
Size size) → void -
updateThemeData(
bool useDarkTheme, FastThemeData themeData) → void -
zoomReset(
) → void -
zoomTo(
num zoomScale) → void
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited