RoomioSDK

The reference for the Roomio SDK for iOS. To get a scan running, start with the Quickstart. Every type is in the RoomioSDK module: import RoomioSDK.

Start with Roomio to configure the SDK and start a scan, show the session in RoomioScanView, and follow it through RoomioScanSession.

Types

• Roomio: Entry point for the Roomio SDK.
• RoomioScanSession: A single scan, from starting the camera to exporting the result.
• RoomioScanView: The scanning screen for a RoomioScanSession.
• RoomioBundle: A finished scan, packaged for upload.
• RoomioDiagnostic: A message about a scan, for your own logging or crash reporting.
• RoomioDiagnosticLevel: How serious a RoomioDiagnostic is.
• RoomioDiagnosticsDelegate: Receives RoomioDiagnostics. Register with setDiagnosticsDelegate(_:minimumLevel:). Called on the main thread.
• RoomioError: An error reported by the Roomio SDK.
• RoomioGuidance: What the user should do to get a better scan, from RoomioScanEvent.guidanceChanged(_:). New values may be added in future releases, so include a default case when you switch on them.
• RoomioScanConfig: Options for a scan, passed to startScan(config:).
• RoomioScanEvent: A notification from a RoomioScanSession, delivered through events.
• RoomioScanProgress: Progress of a scan.
• RoomioScanState: The state of a RoomioScanSession, read from state.
• RoomioScanStyle: The colours of RoomioScanView: its buttons, the exit confirmation, the low-storage sheet and the onboarding. The confirmation’s “Yes, exit” and the sheet’s “Continue anyway” stay red whatever you choose.
• RoomioSupport: Whether a device can scan, returned by isSupported().
• RoomioTrackingQuality: How well the device is tracking its position. Use it to show tracking feedback in your own UI.