RoomioScanState

sealed interface RoomioScanState

The state of a RoomioScanSession, read from RoomioScanSession.state.

Inheritors

Idle
Starting
Scanning
Paused
Recovering
Saving
Finished
Cancelled
Failed

Types

Name Summary
Cancelled data object Cancelled : RoomioScanState
The user exited the scan, or you called RoomioScanSession.cancel. Nothing was saved; call RoomioScanSession.close and dismiss the scanning screen.
Failed data class Failed(val error: RoomioError) : RoomioScanState
The scan failed with the given error.
Finished data object Finished : RoomioScanState
Recording has finished. Call RoomioScanSession.export to get the result.
Idle data object Idle : RoomioScanState
Not recording yet.
Paused data object Paused : RoomioScanState
Paused, either by RoomioScanSession.pause or because the app went to the background. Nothing is recorded.
Recovering data object Recovering : RoomioScanState
Tracking was lost and the scan is recovering.
Saving data object Saving : RoomioScanState
Recording has stopped and the scan is being saved. Moves to Finished, or Failed if saving fails.
Scanning data class Scanning(val tracking: RoomioTrackingQuality) : RoomioScanState
Recording, with the current tracking quality.
Starting data object Starting : RoomioScanState
The camera is starting up.

Cancelled

data object Cancelled : RoomioScanState

The user exited the scan, or you called RoomioScanSession.cancel. Nothing was saved; call RoomioScanSession.close and dismiss the scanning screen.

Finished

data object Finished : RoomioScanState

Recording has finished. Call RoomioScanSession.export to get the result.

Idle

data object Idle : RoomioScanState

Not recording yet.

Paused

data object Paused : RoomioScanState

Paused, either by RoomioScanSession.pause or because the app went to the background. Nothing is recorded.

Recovering

data object Recovering : RoomioScanState

Tracking was lost and the scan is recovering.

Saving

data object Saving : RoomioScanState

Recording has stopped and the scan is being saved. Moves to Finished, or Failed if saving fails.

Starting

data object Starting : RoomioScanState

The camera is starting up.

Roomio SDK 0.0.15