Classes

AAMVA document subfile field.

AAMVA document subfile information.

AAMVA document information.

ScanbotSDKs default data encrypter. Provides AES128 and AES 256 encryption to your data.

A class that describes an aspect ratio for a documents page. *

A class that represents a range of aspect ratios. *

A helper class describing a barcode document type.

Base class for describing recognized and parsed barcode information.

A class that contains additional parameters for barcodes detection and filtering.

A class to parse a raw string value (usually taken from the barcode) into a formatted document of the supported type.

A class to search and decode multiple types of barcodes in a UIImage or SampleBufferRef. Result is incapsulated in an array of SBSDKBarcodeScannerResult instances.

This class encapsulates the result of a barcode detection.

A UIViewController subclass to show a camera screen with the barcode detector. This class cannot be instanced from a storyboard. Instead it is installing itself as a child view controller onto a given parent view controller.

Class that represents a barcode type.

This is the abstract base class for any of the adjustable filters in ScanbotSDK. It provides the basic logic for filtering images using the GPU or the CPU. For GPU-based filtering the SDK uses preferrably Apples Metal API where available and falls back to OpenGLES if Metal is not available. If GPU-based filtering is not supported at all, the slower CPU-based filtering is used.

A basic camera view controller. Can be used for custom video frame detection.

The energy management configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses. ‘SBSDKBaseScannerViewController’ and subclasses sport a customizable energy management system.

Since detectors and recognizers running on a live video feed can put a lot of load onto the CPU and/or GPU of the device, causing the battery to drain quickly and running the device hot, you can customize the energy consumption using this class by configuring the rate of detections/recognitions per second in performance mode as well as in energy saving mode.

In performance mode the detectors/recognizers will be fed with a higher, configurable rate of video frames per second. After a certain, configurable period of inactivity the energy save mode will be engaged and the rate of detections/recognitions will be reduced to a lower (configurable) rate. You can also configure the time of inactivity before the automatic mode switches from performance to energy save mode.

Inactivity here means that both of the following conditions are met: 1) The device did not register significant motion for this period. 2) No positive detector/recognizer results have been registered during this period.

Once in energy save mode the device can only return to performance mode if it is moved significantly or a positive detection/recognition result was registered.

The general configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses.

A highly customizable camera view controller that delivers a basic camera functionality along with video frame extraction and preprocessing, orientation correction and still image capturing.

Additionally you can opt-in several features using the SBSDKBaseScannerXXXConfiguration classes, e.g. zooming, energy management and view finder.

This class provides functions to be used and overwritten by subclasses to implement different detectors and recognizers.

The view finder configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses. Sometimes it is necessary to limit a live video frame detection or recognition to a certain rectangular area with a specific aspect ratio: the region or rectangle of interest. This is where a view finder comes in. It crops the video frame to that region of interest before passing it to any detector or recognizer. Usually the performance of detectors/recognizers gain a benefit from it because less pixels must be processed. Additionally, to guide the user, the view finder visualizes the region of interest by drawing a rectangle around on the user interface.

Since the display resp. the camera view size differs from device to device specifying the region of interest in absolute screen points would require some additional calculations and therefore be inconvenient. Instead a combination of aspect ratio and minimum distances to the view(screen) edges is used.

The zoom configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses. ‘SBSDKBaseScannerViewController’ and subclasses allow the user to zoom the camera. This class lets you customize the zooming user experience.

Class for image blurriness value estimation.

Boarding pass leg field description.

Boarding pass leg information.

Boarding pass document description.

A CAShapeLayer subclass to draw rectangles to mark detected objects.

Adjusts the brightness of an image.

A class specifically designed to deal with images of business cards. It auto-rotates the images and extracts their texts. Can be subclassed and modified to your own needs. Designed to work in conjunction with SBSDKMultipleObjectScannerViewController.

The camera device to be used with a SBSDKCameraSession. To retrieve a list of available devices you can pass to many of SDKs classic or RTU-UI component please use the class functions starting with availableDevices…

This class provides information about the current cameras exposure settings.

An easy-to-use wrapper around the AVFoundations video capture session. Sets up and configures the camera device and the preview layer. Provides functionality to capture still images.

Helper class, that gathers the image, camera and detection metadata of a document scan.

None.

A check compatible with the ASC X9 standard used in the USA.

A check format commonly used in France.

A check format commonly used in Kuwait.

A check compatible with the Australian Paper Clearing System cheque standard.

A check compatible with the CTS-2010 standard issued by the Reserve Bank of India in 2012.

Root document type.

A realtime detector and recognizer for U.S. Checks. It detects checks on CMSampleBufferRef object from an AVFoundation video stream. After successful detection it runs a recognition operation to extract the data fields of the detected check.

The result object of a check recognition.

Classic UI viewcontroller that can be used to detect and recognize bank checks. Can be configured to recognize on video frames or, for better accuracy, on high-res photos that are automatically captured.

A compound image filter to build a filter chain with minimal conversion and maximal performance.

Adjusts the contrast of an image.

A UILabel subclass with rounded corners and content insets to display the status of the current document detection result.

Delivers information about the iOS device.

The metrics and additional properties returned by ‘SBSDKDocumentDetector’. Can be used to make decisions on polygon acceptance, automatic capturing and user guidance.



• A class to detect a document’s outline polygon in a UIImage or CMSampleBufferRef.

This class represents the result of a document detection on an image.

Wraps the texts being displayed as the detection status.

A UIViewController subclass to show a camera screen and run a user guiding document detector. The detection result is visualized using a polygonal bezier path. This class cannot be instanced from a storyboard. Instead it is installing itself as a child view controller onto a given parent view controller. This is a simpler version of ‘SBSDKScannerViewController’ that is more in-line with other classic UI SDK components. As a subclass of ‘SBSDKBaseScannerViewController’ it benefits from all its advantages, e.g. zooming, view finder, and energy management.

Helper class to catch NSExceptions from with Swift code.

A UIView subclass to display a view finder with colored background and transparent cutout with the given aspect ratio.

A simple frame limiter class. An object can use this class to limit the number of events fired per second. E.g. A camera device captures video frames with 60 frames per second and passes them to a detector. Use this class to limit the number of detector runs to a smaller value, like 20 frames per second, skipping the remaining 40 frames per second. As the detector needs lots of CPU power this limit can drastically reduce CPU usage and therefore saves battery.

A class describing a data field of a GS1 code.

The document format of a GS1 code.

A generic documents fields result of OCR text recognition.

A generic documents field type.

A generic documents field.

A generic documents type.

A generic document. Contains fields and sub-documents.

Root document type.

The recognition result of the SBSDKGenericDocumentRecognizer.

A class to recognize and detect the data fields from specific documents, e.g. German passports, ID cards and driver’s licenses in a UIImage or CMSampleBufferRef. In case of success, returns an instance of SBSDKGenericDocumentRecognitionResult holding the generic document with all recognized fields, including their names, values and image excerpts, along with their OCR confidence values.

A UIViewController subclass to recognize documents, e.g. German passports, ID cards and driver’s licenses on video frames.

Base class for strongly-typed SBSDKGenericDocument wrappers

German ID card, front side.

MRZ part of the document.

German ID card, back side.

German travel passport (Reisepass).

German driver license (Führerschein), front side.

A category row from the categories table.

Categories table row container.

German driver license (Führerschein), back side.

A class to recognize one line of text in a small area and run validation on the result. It is intended to be a very generic text-based live video recognizer for tasks that can’t be accomplished with the specialized recognizers in ScanbotSDK.

A descriptor-like class to configure an instance of SBSDKGenericTextLineRecognizer.

A class describing a recognized word, its bounding box and its text recognition confidence.

A class describing the result of the generic text line recognizer.

A UIViewController subclass to show a camera screen with the text line recognizer. A view finder like rectangle shows the area where text is recognized. The camera can be zoomed in and out using an action or a double-tap to make aiming at the desired area easier. Once some text is recognized within the view finder area, the result is delivered to the receivers delegate. A customizable validation routine checks validates the result and sets a flag in the result.

EHIC field data.

The result of EHIC recognition returned by SBSDKHealthInsuranceCardRecognizer

A class to recognize European health insurance cards (EHIC), a.k.a. elektronische Gesundheitskarten (eGK). NOTE: In order to operate, this class requires tesseract languages and trained data to be present in the application bundle.

A UIViewController subclass to scan health insurance cards with the camera.

ID card field description

ID card document description

A UIViewController subclass to show and edit an image. The user can move edge and corner handlers to redefine the polygon manually and rotate the image in 90 degree steps (counter) clockwise. This class cannot be instanced from a storyboard. Instead it is installing itself as a child view controller onto a given parent view controller.

Encapsulates image metadata, e.g. EXIF, TIFF, JFIF in a convenient way. Use SBSDKImageMetadataProcessor to extract metadata from and inject changed metadata into image data.

Helper class to extract image metadata, e.g. EXIF, TIFF, JFIF from any images data. Be cautious: changing an images metadata can break it, e.g. by setting wrong width or height.

Example usage:

1. Use UIImageJPEGRepresentation(UIImage *image, CGFloat compressionFactor) to get the NSData object from an UIImage.

2. Call SBSDKImageMetadataProcessor method extractMetadataFromImageData: to retrieve a SBSDKImageMetadata object from the image data.

3. Modify the metadata object as needed.

4. Call SBSDKImageMetadataProcessor method imageDataByInjectingMetadata to inject the modified metadata into the image data.

5. Create a new UIImage object from the returned image data using UIImage(data:) constructor with the modified metadata.

Class containing the metrics for a single image channel.

• Utility class to extract the metrics for each individual channel of an UIImage.
• Metrics are min, max and mean values of each channel, the variance and standard deviation.
• Along with the metrics this class also extracts histograms and cumulative histograms for each channel.

A class to process images asynchronously: the heart of the Scanbot SDK image processing module. As image processing is most often consuming lots of memory this class processes images on a serial queue ensuring a minimum of large images in memory. Each operation reads the image from the imageURL, processes it and, if outputImageURL is a valid file URL, writes the result to outputImageURL. Upon completion completionHandler is called on main thread in a synchronous matter. After your completionHandler finished executing the next operation is enqueued. Its resultInfo dictionary contains the processed image, the source image URL and the destination image URL if specified.

A simple thread-safe multiple-reader-single-writer index based disk image cache class. Manages images in an array-like fashion.

A simple thread-safe multiple-reader-single-writer key-value fashioned disk image cache class. Manages images in a dictionary-like fashion.

Encapsulates lens and camera properties. Can be used with polygonal image cropping to achieve a very accurate aspect ratio of the resulting image. If created from image image metadata, uses a dictionary of some known devices to lookup the values.

A class to scan a vehicle’s license plate in a UIImage or SampleBufferRef and run a validation on the result. Ideally you use an instance of this class on subsequent video frames. Each scanned frame will raise the confidence of the scan.

A class being used to configure the license plate scanner.

A class describing the result of a license plate scan.

A UIViewController subclass to scan for license plates with the camera.

A camera-enabled UIViewController subclass to scan machine-readable zones. This class cannot be instantiated from a storyboard directly, instead it is installing itself as a child view controller onto a given parent view controller.

A class to recognize machine-readable zones in a UIImage or SampleBufferRef. Result is encapsulated in SBSDKMRZRecognizerResult instance. NOTE: In order to operate, this class requires tesseract languages and trained data to be present in application bundle

A class representing a single data field in a machine-readable-zone.

A class encapsulating a machine-readable-zone recognition result.

Contains information about a single checkdigit.

A class encapsulating machine-readable-zones text line.

Medical certificate field description.

Class for parsing data obtained from QR code on medical certificates.

A class to recognize medical certificates in a UIImage or CMSampleBufferRef. The result is encapsulated in SBSDKMedicalCertificateRecognizerResult instance.

Contains information about recognized medical certificate checkbox.

A class intended to store the configuration options for a medical certificate recognizer.

Class contains date information retrieved by medical certificates recognizer.

This class describes the results of a medical certificate recognition.

This class represents one entry of patient information recognized by medical certificate recognition.

Classic UI viewcontroller that can be used to detect and recognize medical certificates. Can be configured to recognize on video frames or, for better accuracy, on high-res photos that are automatically captured.

German medical plan document subheading prescription information description field.

German medical plan document subheading prescription information description.

German medical plan document medicine substance information description field.

German medical plan document medicine substance information description.

German medical plan document medicine information description field.

German medical plan document medicine information description.

German medical plan document subheading information description field.

German medical plan document subheading information description.

German medical plan document doctor information description field.

German medical plan document doctor information description.

German medical plan document patient information description field.

German medical plan document patient information description.

German medical plan document description structure.

A UIViewController subclass to scan multiple objects on a single captured still image. *

A class to detect multiple non-overlapping rectangular objects in a UIImage or CMSampleBufferRef. Like a bunch of business cards.

This class summarizes the results of an optical character recognition (OCR) operation for a given page. It contains the recognized text, and arrays for each type of SBSDKOCRResultBlock, as well as the result from the page layout analysis. For convenience this immutable class conforms to NSCopying protocol.

This class summarizes the results of an optical character recognition (OCR) operation for number of pages. It contains the array of SBSDKOCRPages. For convenience this immutable class conforms to NSCopying protocol.

Part of the optical character recognitions result. This result contains multiple SBSDKOCRResultBlock objects. Each block represents a text paragraph, a text line or a word and contains information about it, like the found text, the bounding box, where in the image the paragraph/line/word can be found, the confidence value and the type. For convenience this immutable class conforms to NSCopying protocol.

A factory class to enqueue and execute optical character recognition operations: the heart of the Scanbot SDK OCR module. It performs OCR operations on either a single image or a collection of images, see SBSDKImageStoring. Additionally it can perform a standalone page analysis on a single image. All of the operations are dispatched to a single serial queue to ensure low memory footprint and optimum CPU load.

Any text recognition operation will fail with an error if all of the specified languages are missing as language files. If the specified languages are partially available a warning will be logged, but the operation executes without using the missing languages. Please see the section “Optical Character Recognition” of the main SDK documentation for more details about the OCR language files.

The number of languages passed to OCR operations have a significant impact on the performance: the more languages, the slower the recognition process.

Enables reading and writing of PDF metadata attributes like author, creator, title, keywords etc. to PDF files. Caution: If you want to use this feature your app must import the PDFKit module.

Class used to extract pages from a PDF file and returns them in various ways. The synchronous functions of this class are running in the same thread that they are called from, so it is up to you to control the concurrency. The asynchronous functions run in a shared queue to prevent memory pressure when running multiple extractions at the same time. It is recommended to use background queues in most cases. Currently the flattening of the PDF document is user’s responsibility. So if the document will have unflattened annotations (except signs), they will not be exported.

A class to render an ordered collection of images into a basic, non-searchable PDF. Very fast. It does not perform OCR.

Describes the result of a page layout analyzing operation. It contains page orientation, writing direction and text line order as well as a deskew angle. This result can be used to process the input image before running an OCR operation on it, e.g.

• Rotate the image to let the page orientation flip to SBSDKPageOrientationUp,
• Apply a rotation with the deskewAngle to remove distortion and get perfectly aligned text lines.
• Limit recognition languages to languages that use the analyzer results writingDirection and textlineOrder to achieve much better OCR performance. For convenience this immutable class conforms to NSCopying protocol.

This class represents a 4-gon, a polygon with 4 edges. The polygons points are stored in a normalized unit coordinate system from {0, 0} to {1, 1}. To convert to absolute coordinates use the methods that take a size and return absolute values. An absolute space can be any 2-dimensional space with a size, e.g. an image.

Helper class that encapsulates an edge of a polygon and provides geometric helper methods.

A CAShapeLayer subclass that is used to draw bezier paths with fluid animation. The paths stroke color can be customized.

Factory class providing different NSOperationQueues to work on. There are 3 main queues:

• A serial queue for image processing.
• A serial queue for text processing like optical character recognition.
• A concurrent queue for networking operations allowing 4 concurrent operations.

A NSProgress subclass with a simpler update mechanism and linked operation cancelling. To cancel the underlying operation simply call -cancel on the progress object.

A class that manages installation and removal of resources, required by some features. It also manages installation of custom resources that extend some features functionality.

SEPA document field information.

SEPA parsed document information.

Adjusts the saturation of an image.

A filter that separately adjusts the contrast of darker and brighter image areas.

@class SBSDKShutterButton The button class used in the camera view controller to take a snapshot. Animates itself depending on its status.

A wrapper around the more complex SBSDKImageFilterType based filters. Can be used to execute SBSDKImageFilterType based filters at any place in a filter chain built from a SBSDKCompoundFilter.

A class to manage playback of sounds and vibration.

A contrast image filter that works with shifting white and black point.

Descriptor and helper class for describing and creating a directory on the file system.

A class describing one data field of a Swiss QR code.

The document format of a Swiss QR code.

Class used to convert and write images in TIFF format

Class used to define parameters for TIFF format writer.

Class used to describe user-defined TIFF field.

Adjusts the color temperature of an image.

A class, that determines orientation of text on the image. Initialization of this class can be resource-intensive, so in case you want to analyze multiple images, it is better to create instance of SBSDKTextOrientationRecognizer once and use it multiple times.

Adjusts the tint of an image.

A class for a barcode filtering that can be used in barcode scanning RTU-UI components. You can customize the filtering of barcode results coming from RTU-UI barcode scanners by implementing a subclass of this class and pass the instance of your filtering class to the barcode scanning RTU-UI component.

Subclass of SBSDKUIBarcodeFilter that only accepts barcodes with extensions.

A class to store and remove barcode images from SBSDKUIBarcodeScannerViewController.

Class that contains barcode name and description.

Class that contains barcode result and mapped data.

Configuration for the behavior of barcodes.

This class describes the look and feel, as well as the textual contents of the detection screens for barcodes. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the detector screens for barcodes.

Configuration for user interface of the detector screens for barcodes.

A highly customizable camera-based view controller to detect QR and bar codes.

The configuration object for a barcode selection overlay.

Configuration for the behavior of barcodes.

This class describes the look and feel, as well as the textual contents of the detection screens for barcodes. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the detector screens for barcodes.

Configuration for user interface of the detector screens for barcodes.

A highly customizable camera-based view controller to detect barcodes batches.

Configuration for the camera of all RTU-UI components.

A SBSDKUIViewController subclass which adds support for enabled and disabled camera permission.

Configuration for the behavior of the check scanner.

This class describes the look and feel, the behavior and the textual contents of the medical certificate scanner. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

Configuration for the textual contents of the check scanner.

Configuration for the user interface of the check scanner.

A Ready-To-Use viewcontroller to recognize checks using the camera.

The general configuration class for all RTU-UI components. Component specific configurations are subclassed from this class.

Configuration for the accessibility labels and hints.

Configuration for the behavior of the cropping screen.

This class describes the look and feel, as well as the textual contents of the page cropping screen. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual content of the page cropping screen.

Configuration for user interface of the page cropping screen.

A highly customizable view controller to edit a pages polygon or the page’s orientation.

The general style for an action button in a ScanbotSDK alert. Used to customize certain result alerts in SBSDKUI components.

Factory class for creating instances of iOS system style alerts with extended functionality, e.g. displaying an image.

The general style for a dialog in ScanbotSDK. Used to customize certain result dialogs in SBSDKUI components.

A thread-safe, mutable container for scanned pages of type ‘SBSDKUIPage’.

Configuration for the accessibility labels and hints.

Configuration for the behavior of the document scanning screen.

This class describes the look and feel, the behavior, as well as the textual contents of the detection screen for documents. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the document scanning screen.

Configuration for the user interface of the document scanning screen.

A highly customizable camera-based view controller to scan documents. An edge-detection based algorithm finds documents in the camera stream. A manual or automatic high resolution snapshot can be made. Based on the detected area of the document in the photo, the photo is cropped and perspective-corrected, so that a nice flattened image of the document only is created.

The type of the document that should be recognized with SBSDKUIGenericDocumentRecognizerViewController. It is a composition of generic document types.

Configuration for the textual contents of camera based view controllers.

Configuration for the user interface of camera based view controllers.

Configuration for the accessibility labels and hints.

Configuration for the behavior of the document scanning screen.

This class describes the look and feel, the behavior, as well as the textual contents of the detection screen for documents. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the document scanning screen.

Configuration for the user interface of the document scanning screen.

A highly customizable camera-based view controller to scan a single documents of a certain aspect ratio. An edge-detection based algorithm finds documents in the camera stream within the view finder. A manual or automatic high resolution snapshot can be made. Based on the detected area of the document in the photo, the photo is cropped and perspective-corrected, so that a nice flattened image of the document only is created.

Configuration for the behavior of the generic document recognizer.

This class describes the look and feel, the behavior and the textual contents of the generic document recognizers screen. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

Configuration for the textual contents of the generic document recognizer screen.

Configuration for the user interface of the generic document recognizer screens.

A highly customizable camera-based view controller to recognize generic documents.

Configuration for the behavior of Health Insurance Card scanner.

This class describes the look and feel, as well as the textual contents of the detection screen for Health Insurance Card scanner. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the detector screen for Health Insurance Card scanner.

Configuration for user interface of the detector screen for Health Insurance Card scanner.

A view controller for camera-based detection of health insurance cards.

Configuration for the behavior of the license plate scanner.

This class describes the look and feel, the behavior and the textual contents of the detection screens for license plate scanner. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

Configuration for the textual contents of the license plate scanner.

Configuration for the user interface look and feel of the license plate scanner.

A highly customizable camera-based view controller to scan vehicle license plates in realtime. A view finder like rectangle shows the area where the license plate is recognized. Once a license plate has been recognized within the view finder area the result is delivered to the receivers delegate.

Configuration for the behavior of the machine readable zone scanner.

This class describes the look and feel, as well as the textual contents of the detection screens for machine readable zones. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the detector screens for machine readable zones.

Configuration for user interface of the detector screens for machine readable zones.

A highly customizable camera-based view controller to detect machine readable zones.

Factory class for machine readable code types.

Configuration for the behavior of medical certificates scanner.

This class describes the look and feel, the behavior and the textual contents of the medical certificate scanner. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

Configuration for the textual contents of the medical certificate scanner.

Configuration for the user interface of the medical certificate scanner.

A Ready-To-Use viewcontroller to scan medical certificates.

Configuration for the behavior of the document scanning screen.

This class describes the look and feel, the behavior, as well as the textual contents of the detection screen for multiple objects detector. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it.

Configuration for the textual contents of the document scanning screen.

Configuration for user interface of the document scanning screen.

A highly customizable camera-based view controller to scan multiple objects.

A class to render a SBSDKUIDocument into a PDF.

This class represents a scanned documents page.

A class to store and restore images in a memory-efficient way. Stores added images on disk and restores them if requested. Can generate preview images of optimal resolution for the devices screen. Manages two types of images: original images (as from camera or photo library) and document images (cropped and perspective-corrected). Helps you efficiently managing and persisting larger images without keeping them in memory.

Caution: Since all images stored here are being persisted to the disk forever, you are responsible for removing unused images.

A helper class to generate thumbnails from existing UIImage instances.

Configuration for the behavior of text line recognizer.

This class describes the look and feel, the behavior and the textual contents of the detection screens for text line recognizer. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

Defines a single workflow step of ‘SBSDKUITextDataScannerViewController’ flow.

Encapsulates the result of the text recognition of a ‘SBSDKUITextDataScannerViewController’s workflow step.

Configuration for the textual contents of the text line recognizer.

Configuration for the user interface of the text line recognizer.