Package-level declarations
Types
| Name | Summary |
|---|---|
| Roomio | object Roomio Entry point for the Roomio SDK. |
| RoomioBundle | data class RoomioBundle(val file: File, val sizeBytes: Long, val scanId: String? = null) A finished scan, packaged for upload. |
| RoomioDiagnostic | data class RoomioDiagnostic(val timestampMillis: Long, val level: RoomioDiagnosticLevel, val code: String, val message: String, val scanId: String?) A message about a scan, for your own logging or crash reporting. |
| RoomioDiagnosticLevel | enum RoomioDiagnosticLevel : Enum<RoomioDiagnosticLevel> How serious a RoomioDiagnostic is. |
| RoomioDiagnosticsListener | fun interface RoomioDiagnosticsListener Receives RoomioDiagnostics. Register with Roomio.setDiagnosticsListener. Called on the main thread. |
| RoomioError | class RoomioError(val code: RoomioError.Code, val severity: RoomioError.Severity, val isRetryable: Boolean, message: String, val underlying: Throwable? = null) : Exception An error reported by the Roomio SDK. |
| RoomioGuidance | @JvmInline value class RoomioGuidance(val raw: String) What the user should do to get a better scan, from RoomioScanEvent.GuidanceChanged. New values may be added in future releases, so include an else branch when you match on them. |
| RoomioScanConfig | class RoomioScanConfig(val showsOnboarding: Boolean = true) Options for a scan, passed to Roomio.startScan. |
| RoomioScanEvent | sealed interface RoomioScanEvent A notification from a RoomioScanSession, delivered through RoomioScanSession.events. |
| RoomioScanProgress | data class RoomioScanProgress(val distanceTravelledMetres: Float) Progress of a scan. |
| RoomioScanSession | class RoomioScanSession A single scan, from starting the camera to exporting the result. |
| RoomioScanState | sealed interface RoomioScanState The state of a RoomioScanSession, read from RoomioScanSession.state. |
| RoomioScanStyle | class RoomioScanStyle(@ColorIntval primaryColor: Int = 0xFF2C268D.toInt(), @ColorIntval secondaryColor: Int = 0xFFEFEFFB.toInt()) The colours of RoomioScanView: its buttons, the exit confirmation, the low-storage sheet and the onboarding, as ARGB ints. The confirmation's "Yes, exit" and the sheet's "Continue anyway" stay red whatever you choose. |
| RoomioScanView | class RoomioScanView@JvmOverloadsconstructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout The scanning screen for a RoomioScanSession. |
| RoomioSupport | enum RoomioSupport : Enum<RoomioSupport> Whether a device can scan, returned by Roomio.isSupported. |
| RoomioTrackingQuality | enum RoomioTrackingQuality : Enum<RoomioTrackingQuality> How well the device is tracking its position. Use it to show tracking feedback in your own UI. |