RoomPlanScanner class

Starts and stops RoomPlan captures on supported iOS devices.

Constructors

RoomPlanScanner({RoomPlanChannel? roomPlanChannel})

Properties

hashCode → int
The hash code for this object.
no setterinherited
onScanResult → Stream<ScanResult?>
Emits the latest room geometry while a capture is active.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

dispose() → void
Closes the native event stream used by this scanner.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startMultiRoomScanning() → Future<MultiRoomScanResult>
Scans connected rooms and exports them as one USDZ structure.
startScanning() → Future<ScanResult?>
Opens the native capture interface and returns the final room scan.
stopScanning() → Future<void>
Ends the active capture and returns control to the Flutter app.
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

isMultiRoomSupported() → Future<bool>
Indicates whether the current device can scan and merge multiple rooms. Multi-room RoomPlan capture requires iOS 17 or later.
isSupported() → Future<bool>
Indicates whether the current device can run RoomPlan.