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.

Wrapper class for searching and decoding multiple types of barcodes. Recognition is performed on still UIImage or SampleBufferRef, result is incapsulated in an array of SBSDKBarcodeScannerResult instances.

Class that encapsulates bar code search and decode result.

UIViewController subclass showing a camera screen and 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.

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.

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.

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

Class contains information about recognized cheque field.

Contains the result of a cheque recognition.

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.

DC field description.

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

Class intended to keep DisabilityCertificateRecognizer configuration options

Wrapper class for disability certificates recognition. Recognition is performed on still UIImage or SampleBufferRef, result is incapsulated in SBSDKDisabilityCertificatesRecognizerResult instance.

Contains information about recognized Disability certificate checkbox.

Class contains date information retrieved by disability certificates recognizer.

This class describes the results of a disability certificate recognition.

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

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



• This class provides methods for detecting a documents outline polygon in an UIImage or CMSampleBuffer.

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

Helper class to catch NSExceptions from with Swift code.

A layer class to display a view finder with colored background and transparent cutout with the given aspect ratio. To change the color just set the layers backgroundColor property.

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 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.

The root document type.

A recognizer for documents on an image or on a video stream. Recognizes and extracts data fields from specific documents, e.g. German passports, id cards and driver’s licenses and, in case of success, returns an instance of SBSDKGenericDocument holding all recognized fields with their names, values and image excerpts, along with their OCR confidence values.

A camera based view controller to recognize documents like personal ID cards, driver’s licenses and passports 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), backside.

A class for recognizing one line of text in a small area and running a 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 highly customizable camera-based viewcontroller to recognize and validate a small rectangular text area in realtime. 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

Recognizer for 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.

Generic class that represents generic card. Is used for subclassing only. Contains only fields, that are common for all EU cards.

Class that represents German identification card. A subclass of SBSDKIDCard

ID card field description

ID card document description

Class that represents German international passport. A subclass of SBSDKIDCard

A recognizer for personal ID cards. Detects and recognizes ID cards on images or video frames and extracts the data fields, like names, dates, photos, signatures and machine readable zones.

Detection is a quick way to check, if there is an ID card present on an image or video frame. Recognition is slower but additionally extracts the data fields from the ID card.

Note: Currently limited to German ID cards.

The type of the recognized ID card.

Contents of one data field of a personal ID card.

The result of an ID card detection or recognition. Summarizes general information from the ID card scan and individual data fields.

A camera based view controller to detect and recognize personal ID cards on video frames or automatically captured still images. Currently limited to German ID cards.

UIViewController subclass showing an image and a polygon The user can move edge and corner handles 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 static class that processes 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 for scanning a vehicles license plate in a small area and running 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 camera based view controller to detect license plates on video frames or automatically captured still images.

Wrapper class for machine-readable zones recognition. Recognition is performed on still 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.

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 view controller for scanning multiple objects on a single captured still image. *

Detects multiple non-overlapping rectangular objects within an image. Like a bunch of business cards.

Data on passports NFC chips are chunked in groups. Each group has a specific category and contains a number of elements, each making up a key-value pair. Groups have individual security levels. We are only allowed to extract data groups 1 and 2.

This class is an abstract base class for one data group of a passports NFC chip.

Data group 1 or DG1. Contains general information about the passport and its holder.

Data group 2 or DG2. Contains visual biometric data of the passports holder.

A class for reading out the data of a passports Near Field Communication (NFC) chip.

Notes:

• Your app needs to add the “Near Field Communication Tag Reading” entitlement
• Your apps info.plist needs to define the passport nfc application ID. To do so add the following entry: “com.apple.developer.nfc.readersession.iso7816.select-identifiers” and as the first element add the passport application ID “A0000002471001”

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.

A static class that renders an ordered collection of images into a basic, none-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.

Describes the position and the type of a text box within the image being detected or recognized.

Resulting element of the SBSDKPayFormScanners recognizer. Holds a token and its recognized text value after recognition.

Result class of SBSDKPayFormScanners recognizer part. Encapsulates the recognized text fields.

The main scanner class that performs detection and recognition on either UIImage or CMSampleBufferRef (from camera). The larger the image the better the recognition results. Images are rotated accordingly to either the UIImage imageOrientation property or the given video orientation. Detection and recognition are successful only if the rotated image has natural orientation.

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.

UIViewController subclass showing a camera screen and running a user guiding Document detector. 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.

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 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.

Class which handles storing and removing 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 configurable view controller for camera-based detection of QR and bar codes.

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 configurable view controller for camera-based detection of barcodes batches.

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

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 configurable view controller to edit a pages polygon or the orientation of the page.

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

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 configurable view controller for camera based document scanning. 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 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 configurable view controller for camera-based recognition of 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 card.

Configuration for the behavior of ID card scanner.

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

Configuration for the textual contents of the ID card detector screen.

Configuration for the user interface of the ID cards detector screens.

A configurable view controller for camera-based detection of ID cards.

Class which handles storing and removing ID card images from SBSDKUIIDCardScannerViewController.

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 viewcontroller 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 view controller for camera-based detection of machine readable zones.

Factory class for machine readable code types.

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 configurable view controller for camera based multiple objects scanning.

Configuration for the behavior of NFC reader.

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

The result of a passport reading operation.

Class which handles storing and removing images from SBSDKUINFCPassportReaderViewController.

Configuration for the textual contents of the NFC reader screens.

Configuration for user interface of the NFC reader screen.

A ready-to-use viewcontroller component to scan the NFC chip of a passport and extract its information.

Renders a ‘SBSDKUIDocument’ into a PDF.

This class represents a scanned documents page.

A class for storing and restoring 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.

A helper class to generate thumbnails from existing UIImage instances.

A ‘SBSDKUIWorkflowStep’ subclass specialized on recognizing barcodes/QR codes on low-res video frames (live detection).

A ‘SBSDKUIWorkflowStep’ subclass specialized on recognizing disability certificates (DC) on either high-res still images or low-res video frames (live detection).

A ‘SBSDKUIWorkflowStep’ subclass specialized on capturing documents from high-res still images.

A ‘SBSDKUIScanHealthInsuranceCardWorkflowStep’ subclass specialized on recognizing health insurance card on low-res video frames (live detection).

A ‘SBSDKUIWorkflowStep’ subclass specialized on recognizing machine readable zones (MRZ) on either high-res still images or low-res video frames (live detection).

A ‘SBSDKUIWorkflowStep’ subclass specialized on recognizing payforms on either high-res still images or low-res video frames (live detection).

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.

A highly customizable camera-based viewcontroller to recognize and validate a small rectangular text area in realtime. A view finder like rectangle shows the area where text is recognized. The camera is zoomed in and out automatically. Once some text is recognized within the view finder area the result is delivered to the receivers delegate.

Abstract base class for SBSDKUI view controllers. Do not use/subclass directly.

Represents a scanning workflow, consisting of multiple steps, each of it performing an image scan. You can combine document scanning with QR code detection or machine readable zone recognition. Many 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. In the end, when all steps have finished you can validate all step results in a single block, and restart the whole workflow if the validation fails. By subclassing ‘SBSDKUIWorkflowStep’ the creation of custom steps is possible.

Behavior configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

Configuration object that holds the subconfigurations for a ‘SBSDKUIWorkflowScannerViewController’.

Text configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

User interface configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

View controller that processes a workflow.

A class describing one single step of a workflow. There are some pre-defined workflow steps but you also may may subclass and create your own custom steps.

This class represents the result of one workflow step

vCard document field description.