Scanbot SDK UI Components

RTU UI Components

The Ready-To-Use UI (RTU UI) is a set of easy to integrate and customize high-level UI components (View Controllers) for the most common tasks in Scanbot SDK:

• Document Scanner - SBSDKUIDocumentScannerViewController
• Cropping - SBSDKUICroppingViewController
• MRZ Scanner - SBSDKUIMRZScannerViewController
• Barcode and QR-Code Scanner - SBSDKUIBarcodeScannerViewController

The design and behavior of these RTU UI View Controllers are based on our long years of experience as well as the feedback from our SDK customers.

Customization

• UI: All colors and text resources (localization)
• Behavior: Enable or disable features like Multi-Page Scanning, Auto Snapping, Torch Light

Please note: The main idea of the RTU UI is to provide a simple-to-integrate and simple-to-customize View Controllers. Due to this idea there are some limitations with the possibilities of customization. If you need more customization options you have to implement custom View Controllers using our Classical UI Components.

RTU UI Example App

Please see the project ReadyToUseUIDemo in our GitHub repository scanbot-sdk-example-ios.

Workflows

The Workflow Components are also part of the RTU UI Components. A Workflow represents a set of multiple scanning steps. You can combine Document Scanning with QR code detection or MRZ recognition on an ID card image, for example. Workflow Steps can be run on a captured still image or a video frame, so a step can either be a live-detection or a still-image capturing step. You can validate each step result, present an error message to the user if the validation fails and restart a step. By subclassing SBSDKUIWorkflowStep the creation of custom steps is possible.

Following predefined Workflow Step classes are provided:

• SBSDKUIScanDocumentPageWorkflowStep - Specialized for capturing documents from high-res still images.
• SBSDKUIScanBarCodeWorkflowStep - Recognition of Barcodes/QR codes on low-res video frames (live detection).
• SBSDKUIScanMachineReadableZoneWorkflowStep - For scanning of ID cards or passports with MRZ recognition.
• SBSDKUIScanDisabilityCertificateWorkflowStep - For recognition and data extraction from Disability Certificates (DC) forms.
• SBSDKUIScanPayFormWorkflowStep - For recognition and data extraction from SEPA Payforms.

For more details please see the corresponding API docs of the classes as well as our example app.

Workflows Example App

Please see the project ReadyToUseUIDemo in our GitHub repository scanbot-sdk-example-ios.

Classical UI Components

Our Classical UI Components allows you to build your custom UI View Controllers which are very flexible and fully customizable. It is a set of easy to integrate and customize View Controllers which can be embedded and extended in your custom View Controllers.

• SBSDKScannerViewController - View Controller to build a custom Scanning UI for Documents, Barcodes, etc.
• SBSDKImageEditingViewController - View Controller to implement a custom Cropping UI - SBSDKMultipleObjectScannerViewController - View Controller for scanning multiple objects on a single captured still image (e.g. scanning multiple business cards)

Please also see the section Modules in Detail.

Classical UI Example App

Please see the project ScanbotSDKDemo in our GitHub repository scanbot-sdk-example-ios.