Classes

The following classes are available globally.

  • AAMVA document subfile field

    See more

    Declaration

    Objective-C

    @interface SBSDKAAMVADocumentSubfileField : NSObject

    Swift

    class SBSDKAAMVADocumentSubfileField : NSObject

  • AAMVA document subfile

    See more

    Declaration

    Objective-C

    @interface SBSDKAAMVADocumentSubfile : NSObject

    Swift

    class SBSDKAAMVADocumentSubfile : NSObject

  • AAMVA document

    See more

    Declaration

    Objective-C

    @interface SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface SBSDKBarCodeScannerDocumentFormat : NSObject

@property (nonatomic) BOOL parsedSuccessful;

- (instancetype)initWithString:(NSString *)rawString;

@end

    Swift

    class SBSDKBarCodeScannerDocumentFormat : NSObject

  • — BETA — This component is a BETA feature and is still under active development and improvement. We will try to keep the API as stable as possible. However, please note that we can’t guarantee that.

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScanner : NSObject

    Swift

    class SBSDKBarcodeScanner : NSObject

  • Class that encapsulates bar code search and decode result.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScannerResult : NSObject

    Swift

    class SBSDKBarcodeScannerResult : NSObject

  • Class that represents a barcode type.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeType : NSObject

    Swift

    class SBSDKBarcodeType : NSObject

  • Boarding pass leg field description

    See more

    Declaration

    Objective-C

    @interface SBSDKBoardingPassLegField : NSObject

    Swift

    class SBSDKBoardingPassLegField : NSObject

  • Boarding pass leg

    See more

    Declaration

    Objective-C

    @interface SBSDKBoardingPassLeg : NSObject

    Swift

    class SBSDKBoardingPassLeg : NSObject

  • Boarding pass document description

    See more

    Declaration

    Objective-C

    @interface SBSDKBoardingPassDocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKBoardingPassDocumentFormat : SBSDKBarCodeScannerDocumentFormat

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBusinessCardsImageProcessor : NSObject

    Swift

    class SBSDKBusinessCardsImageProcessor : NSObject

  • This class provides information about the current cameras exposure settings.

    See more

    Declaration

    Objective-C

    @interface SBSDKCameraExposureSettings : NSObject

    Swift

    class SBSDKCameraExposureSettings : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKCameraSession : NSObject

    Swift

    class SBSDKCameraSession : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKCaptureInfo : NSObject

    Swift

    class SBSDKCaptureInfo : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKChequeRecognizer : NSObject

    Swift

    class SBSDKChequeRecognizer : NSObject

  • Contains the result of a cheque recognition.

    See more

    Declaration

    Objective-C

    @interface SBSDKChequeRecognizerResult : NSObject

    Swift

    class SBSDKChequeRecognizerResult : NSObject

  • A specific subclass of SBSDKMachineReadableCode, that represents a QR code with personal contact information (vCard, MeCard). Upon creation it tries to geocode all contained postal adresses. Before accessing contact property, make sure processing equals 0.

    See more

    Declaration

    Objective-C

    @interface SBSDKContactQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKContactQRCode : SBSDKMachineReadableCode

  • UIViewController subclass showing an image and a polygon The user can move edge and corner handles to redefine the polygon manually. This class cannot be instanced from a storyboard. Instead it is installing itself as a child view controller onto a given parent view controller.

    Deprecated! Use SBSDKImageEditingViewControllerinstead!

    See more

    Declaration

    Objective-C

    
@interface SBSDKCropViewController : UIViewController

    Swift

    class SBSDKCropViewController : UIViewController

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

    Declaration

    Objective-C

    @interface SBSDKDetectionStatusLabel : UILabel

    Swift

    class SBSDKDetectionStatusLabel : UILabel

  • Delivers information about the iOS device.

    See more

    Declaration

    Objective-C

    @interface SBSDKDeviceInformation : NSObject

    Swift

    class SBSDKDeviceInformation : NSObject

  • Field description

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificateDocumentField : NSObject

    Swift

    class SBSDKDisabilityCertificateDocumentField : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificateDocumentFormat
    : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKDisabilityCertificateDocumentFormat : SBSDKBarCodeScannerDocumentFormat

  • Class intended to keep DisabilityCertificateRecognizer configuration options

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificateRecognizerConfigurationOptions : NSObject

    Swift

    class SBSDKDisabilityCertificateRecognizerConfigurationOptions : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificatesRecognizer : NSObject

    Swift

    class SBSDKDisabilityCertificatesRecognizer : NSObject

  • Contains information about recognized Disability certificate checkbox.

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificatesRecognizerCheckboxResult : NSObject

    Swift

    class SBSDKDisabilityCertificatesRecognizerCheckboxResult : NSObject

  • Class contains date information retrieved by disability certificates recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificatesRecognizerDateResult : NSObject

    Swift

    class SBSDKDisabilityCertificatesRecognizerDateResult : NSObject

  • Class contains disability certificates recognizer retrieved information.

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificatesRecognizerResult : NSObject

    Swift

    class SBSDKDisabilityCertificatesRecognizerResult : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface SBSDKDisabilityCertificatesRecognizerResultPatientField : NSObject

@property (nonatomic) SBSDKDisabilityCertificatesRecognizerResultPatientFieldType type;

@property (nonatomic, strong) NSString *value;

@end

    Swift

    class SBSDKDisabilityCertificatesRecognizerResultPatientField : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKDocumentDetectionMetrics : NSObject <NSCopying>

    Swift

    class SBSDKDocumentDetectionMetrics : NSObject, NSCopying

  • 

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

    Declaration

    Objective-C

    @interface SBSDKDocumentDetector : NSObject

    Swift

    class SBSDKDocumentDetector : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKDocumentDetectorResult : NSObject <NSCopying>

    Swift

    class SBSDKDocumentDetectorResult : NSObject, NSCopying

  • A specific subclass of SBSDKMachineReadableCode that represents a QR codes with iCal compatible events (VCALENDER: VEVENT:).

    See more

    Declaration

    Objective-C

    @interface SBSDKEventQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKEventQRCode : SBSDKMachineReadableCode

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

    See more

    Declaration

    Objective-C

    @interface SBSDKFinderLayer : CAShapeLayer

    Swift

    class SBSDKFinderLayer : CAShapeLayer

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

    See more

    Declaration

    Objective-C

    @interface SBSDKFrameLimiter : NSObject

    Swift

    class SBSDKFrameLimiter : NSObject

  • A generic bar code class. An instance of this class is returned from SBSDKMachineReadableCodeManager when no matching parser for this bar code has been found.

    Declaration

    Objective-C

    @interface SBSDKGenericBarcode : SBSDKMachineReadableCode

    Swift

    class SBSDKGenericBarcode : SBSDKMachineReadableCode

  • A generic QR code class. An instance of this class is returned from SBSDKMachineReadableCodeManager when no matching parser for this QR code has been found.

    Declaration

    Objective-C

    @interface SBSDKGenericQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKGenericQRCode : SBSDKMachineReadableCode

  • EHIC field data.

    See more

    Declaration

    Objective-C

    @interface SBSDKHealthInsuranceCardField : NSObject

    Swift

    class SBSDKHealthInsuranceCardField : NSObject

  • The result of EHIC recognition returned by SBSDKHealthInsuranceCardRecognizer

    See more

    Declaration

    Objective-C

    @interface SBSDKHealthInsuranceCardRecognitionResult : NSObject

    Swift

    class SBSDKHealthInsuranceCardRecognitionResult : NSObject

  • Recognizer for German-issued European health insurance cards (EHIC), a.k.a. elektronische Gesundheitskarten (eGK). The recognizer performs validation on the result that is specific to German cards and returns a failure result if any of the fields that can be validated fail validation. NOTE: In order to operate, this class requires tesseract languages and trained data to be present in the application bundle.

    See more

    Declaration

    Objective-C

    @interface SBSDKHealthInsuranceCardRecognizer : NSObject

    Swift

    class SBSDKHealthInsuranceCardRecognizer : NSObject

  • ID card field description

    See more

    Declaration

    Objective-C

    @interface SBSDKIDCardPDF417DocumentField : NSObject

    Swift

    class SBSDKIDCardPDF417DocumentField : NSObject

  • ID card document description

    See more

    Declaration

    Objective-C

    @interface SBSDKIDCardPDF417DocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKIDCardPDF417DocumentFormat : SBSDKBarCodeScannerDocumentFormat

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

    Replaces the deprecated SBSDKCropViewController.

    See more

    Declaration

    Objective-C

    @interface SBSDKImageEditingViewController : UIViewController

    Swift

    class SBSDKImageEditingViewController : UIViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKImageMetadata : NSObject

    Swift

    class SBSDKImageMetadata : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKImageMetadataProcessor : NSObject

    Swift

    class SBSDKImageMetadataProcessor : NSObject

  • Class containing the metrics for a single image channel.

    See more

    Declaration

    Objective-C

    @interface SBSDKImageChannelMetrics : NSObject

    Swift

    class SBSDKImageChannelMetrics : NSObject
    • 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.
    See more

    Declaration

    Objective-C

    @interface SBSDKImageMetricsAnalyzer : NSObject

    Swift

    class SBSDKImageMetricsAnalyzer : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKImageProcessor : NSObject

    Swift

    class SBSDKImageProcessor : NSObject

  • A thread-safe mutable ordered collection of disk-backed UIImage objects. When it comes to image processing with large images it is impossible to hold all the of a collection images in memory. The images have to be backed on disk and reloaded from the file when demanded. This class is a simple wrapper around the described technique. You can add/remove images from the storage, access the storage via an index and retrieve images or image URLs. There is also support for (automatically) creating and caching thumbnails from the storages images. Conforms to NSCopying. When copying the disk-backing-storage is also copied to a different physical location. Accessing the storage and changing properties is implemented with thread-safety using a single-writer/multiple-reader pattern.

    The deallocation of this object removes all images from disk.

    Deprecated! Use SBSDKIndexedImageStorage instead!

    See more

    Declaration

    Objective-C

    
@interface SBSDKImageStorage : NSObject

    Swift

    class SBSDKImageStorage : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKIndexedImageStorage : NSObject <SBSDKImageStoring>

    Swift

    class SBSDKIndexedImageStorage : NSObject, SBSDKImageStoring

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

    See more

    Declaration

    Objective-C

    @interface SBSDKKeyedImageStorage : NSObject

    Swift

    class SBSDKKeyedImageStorage : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKLensCameraProperties : NSObject

    Swift

    class SBSDKLensCameraProperties : NSObject

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code with a geographic locations (geo:). Performs reverse geocoding to get address from longitude and latitude.

    See more

    Declaration

    Objective-C

    @interface SBSDKLocationQRCode : SBSDKMachineReadableCode <MKAnnotation>

    Swift

    class SBSDKLocationQRCode : SBSDKMachineReadableCode, MKAnnotation

  • The base class for a machine readable code. Contains string value and metadata. Provides some basic functions to support sharing, opening and displaying QR- or barcode data.

    Custom machine readable code parsers return subclasses.

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableCode : NSObject

    Swift

    class SBSDKMachineReadableCode : NSObject

  • Helper class to parse and transform SBSDKMachineReadableCodeMetadata into specific SBSDKMachineReadableCode subclass instances. To transform a metadata object into a machine readable code object a matching parser is needed.

    Parsers must conform to the SBSDKMachineReadableCodeParsing protocol and must be registered using the registerParser method.

    Typically a parsers parseMetadata method takes an SBSDKMachineReadableCodeMetadata object, parses its stringValue and eventually returns an instance of a SBSDKMachineReadableCode subclass. If the parsing fails or the stringValue does not match the parsers pattern, the parser should return nil.

    ScanbotSDK comes with some basic default parsers and can be extended with custom machine readable codes and their matching parsers.

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableCodeManager : NSObject

    Swift

    class SBSDKMachineReadableCodeManager : NSObject

  • A class that holds transformed metadata for a detected AVMetadataMachineReadableCodeObject. Pass these objects to SBSDKMachineReadableCodeManager to parse and transform them into more user-friendly representations.

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableCodeMetadata : NSObject

    Swift

    class SBSDKMachineReadableCodeMetadata : NSObject

  • 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

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableZoneRecognizer : NSObject

    Swift

    class SBSDKMachineReadableZoneRecognizer : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableZoneRecognizerField : NSObject

    Swift

    class SBSDKMachineReadableZoneRecognizerField : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableZoneRecognizerResult : NSObject

    Swift

    class SBSDKMachineReadableZoneRecognizerResult : NSObject

  • Contains information about a single checkdigit.

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableZoneRecognizerResultCheckDigit : NSObject

    Swift

    class SBSDKMachineReadableZoneRecognizerResultCheckDigit : NSObject

  • A class encapsulating machine-readable-zones text line.

    See more

    Declaration

    Objective-C

    @interface SBSDKMachineReadableZoneRecognizerTextLine : NSObject

    Swift

    class SBSDKMachineReadableZoneRecognizerTextLine : NSObject

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code containing an email link (mailto: and smtp:).

    See more

    Declaration

    Objective-C

    @interface SBSDKMailMessageQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKMailMessageQRCode : SBSDKMachineReadableCode

  • German medical plan document subheading receipe information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanSubheadingReceipeField : NSObject

    Swift

    class SBSDKMedicalPlanSubheadingReceipeField : NSObject

  • German medical plan document subheading receipe information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanSubheadingReceipe : NSObject

    Swift

    class SBSDKMedicalPlanSubheadingReceipe : NSObject

  • German medical plan document medicine substance information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanMedicineSubstanceField : NSObject

    Swift

    class SBSDKMedicalPlanMedicineSubstanceField : NSObject

  • German medical plan document medicine substance information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanMedicineSubstance : NSObject

    Swift

    class SBSDKMedicalPlanMedicineSubstance : NSObject

  • German medical plan document medicine information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanMedicineField : NSObject

    Swift

    class SBSDKMedicalPlanMedicineField : NSObject

  • German medical plan document medicine information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanMedicine : NSObject

    Swift

    class SBSDKMedicalPlanMedicine : NSObject

  • German medical plan document subheading information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanStandardSubheadingField : NSObject

    Swift

    class SBSDKMedicalPlanStandardSubheadingField : NSObject

  • German medical plan document subheading information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanStandardSubheading : NSObject

    Swift

    class SBSDKMedicalPlanStandardSubheading : NSObject

  • German medical plan document doctor information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanDoctorField : NSObject

    Swift

    class SBSDKMedicalPlanDoctorField : NSObject

  • German medical plan document doctor information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanDoctorInformation : NSObject

    Swift

    class SBSDKMedicalPlanDoctorInformation : NSObject

  • German medical plan document patient information description field

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanPatientField : NSObject

    Swift

    class SBSDKMedicalPlanPatientField : NSObject

  • German medical plan document patient information description

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanPatientInformation : NSObject

    Swift

    class SBSDKMedicalPlanPatientInformation : NSObject

  • German medical plan document description structure

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanDocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKMedicalPlanDocumentFormat : SBSDKBarCodeScannerDocumentFormat

  • A view controller for scanning multiple objects on a single captured still image. *

    See more

    Declaration

    Objective-C

    @interface SBSDKMultipleObjectScannerViewController : UIViewController

    Swift

    class SBSDKMultipleObjectScannerViewController : UIViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKMultipleObjectsDetector : NSObject

    Swift

    class SBSDKMultipleObjectsDetector : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKOCRPage : NSObject <NSCopying>

    Swift

    class SBSDKOCRPage : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKOCRResult : NSObject <NSCopying>

    Swift

    class SBSDKOCRResult : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKOCRResultBlock : NSObject <NSCopying>

    Swift

    class SBSDKOCRResultBlock : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKOpticalTextRecognizer : NSObject

    Swift

    class SBSDKOpticalTextRecognizer : NSObject

  • A static class that renders an ordered collection of images into a basic, none-searchable PDF. Very fast. It does not perform OCR.

    See more

    Declaration

    Objective-C

    @interface SBSDKPDFRenderer : NSObject

    Swift

    class SBSDKPDFRenderer : NSObject

  • 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.
    See more

    Declaration

    Objective-C

    @interface SBSDKPageAnalyzerResult : NSObject <NSCopying>

    Swift

    class SBSDKPageAnalyzerResult : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPageAspectRatio : NSObject

    Swift

    class SBSDKPageAspectRatio : NSObject

SBSDKPayFormToken

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPayFormToken : NSObject

    Swift

    class SBSDKPayFormToken : NSObject

SBSDKPayFormRecognizedField

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPayFormRecognizedField : NSObject

    Swift

    class SBSDKPayFormRecognizedField : NSObject

SBSDKPayFormRecognitionResult

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPayFormRecognitionResult : NSObject

    Swift

    class SBSDKPayFormRecognitionResult : NSObject

SBSDKPayFormScanner

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPayFormScanner : NSObject

    Swift

    class SBSDKPayFormScanner : NSObject

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code with call-a-number links (tel:).

    See more

    Declaration

    Objective-C

    @interface SBSDKPhoneNumberQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKPhoneNumberQRCode : SBSDKMachineReadableCode

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPolygon : NSObject <NSCopying>

    Swift

    class SBSDKPolygon : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPolygonEdge : NSObject <NSCopying>

    Swift

    class SBSDKPolygonEdge : NSObject, NSCopying

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPolygonLayer : CAShapeLayer

    Swift

    class SBSDKPolygonLayer : CAShapeLayer

  • 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.
    See more

    Declaration

    Objective-C

    @interface SBSDKProcessingQueueFactory : NSObject

    Swift

    class SBSDKProcessingQueueFactory : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKProgress : NSProgress

    Swift

    class SBSDKProgress : Progress

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

    See more

    Declaration

    Objective-C

    @interface SBSDKResourcesManager : NSObject

    Swift

    class SBSDKResourcesManager : NSObject

  • SEPA field

    See more

    Declaration

    Objective-C

    @interface SBSDKSEPADocumentField : NSObject

    Swift

    class SBSDKSEPADocumentField : NSObject

  • SEPA parsed document information

    See more

    Declaration

    Objective-C

    @interface SBSDKSEPADocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKSEPADocumentFormat : SBSDKBarCodeScannerDocumentFormat

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

    See more

    Declaration

    Objective-C

    @interface SBSDKScannerViewController : UIViewController

    Swift

    class SBSDKScannerViewController : UIViewController

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code contianing an SMS links (sms: and SMSTO:).

    See more

    Declaration

    Objective-C

    @interface SBSDKShortMessageQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKShortMessageQRCode : SBSDKMachineReadableCode

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

    See more

    Declaration

    Objective-C

    @interface SBSDKShutterButton : UIButton

    Swift

    class SBSDKShutterButton : UIButton

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

    See more

    Declaration

    Objective-C

    @interface SBSDKStorageLocation : NSObject

    Swift

    class SBSDKStorageLocation : NSObject

  • Class used to convert and write images in TIFF format

    See more

    Declaration

    Objective-C

    @interface SBSDKTIFFImageWriter : NSObject

    Swift

    class SBSDKTIFFImageWriter : NSObject

  • Class used to define parameters for TIFF format writer.

    See more

    Declaration

    Objective-C

    @interface SBSDKTIFFImageWriterParameters : NSObject

    Swift

    class SBSDKTIFFImageWriterParameters : NSObject

  • Class used to describe user-defined TIFF field.

    See more

    Declaration

    Objective-C

    @interface SBSDKTIFFImageWriterUserDefinedField : NSObject

    Swift

    class SBSDKTIFFImageWriterUserDefinedField : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKTextOrientationRecognizer : NSObject

    Swift

    class SBSDKTextOrientationRecognizer : NSObject

  • A configurable view controller for camera-based detection of QR and bar codes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUICameraViewController : SBSDKUIViewController

    Swift

    class SBSDKUICameraViewController : SBSDKUIViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenConfiguration : NSObject

  • Subconfiguration for the textual content of the page cropping screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenTextConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenTextConfiguration : NSObject

  • Subconfiguration for user interface of the page cropping screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenUIConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenUIConfiguration : NSObject

  • A configurable view controller to edit a pages polygon or the orientation of the page.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingViewController : SBSDKUIViewController

    Swift

    class SBSDKUICroppingViewController : SBSDKUIViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocument : NSObject

    Swift

    class SBSDKUIDocument : NSObject

  • Subconfiguration for the behavior of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIDocumentScannerBehaviorConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerConfiguration : NSObject

    Swift

    class SBSDKUIDocumentScannerConfiguration : NSObject

  • Subconfiguration for the textual contents of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerTextConfiguration
    : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIDocumentScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration

  • Subconfiguration for user interface of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIDocumentScannerUIConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController

  • Subconfiguration for the textual contents of camera based view controllers.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIEnableCameraTextConfiguration : NSObject

    Swift

    class SBSDKUIEnableCameraTextConfiguration : NSObject

  • Subconfiguration for the user interface of camera based view controllers.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIEnableCameraUIConfiguration : NSObject

    Swift

    class SBSDKUIEnableCameraUIConfiguration : NSObject

  • Subconfiguration for the behavior of Health Insurance Card scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIHealthInsuranceCardScannerBehaviorConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerConfiguration : NSObject

    Swift

    class SBSDKUIHealthInsuranceCardScannerConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerTextConfiguration
    : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIHealthInsuranceCardScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIHealthInsuranceCardScannerUIConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerViewController
    : SBSDKUICameraViewController

    Swift

    class SBSDKUIHealthInsuranceCardScannerViewController : SBSDKUICameraViewController

  • A view controller for camera-based detection of machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIMRZScannerViewController : SBSDKUICameraViewController

  • Subconfiguration for the behavior of bar codes, QR codes and machine readable zones scanners.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMachineCodeScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIMachineCodeScannerBehaviorConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMachineCodeScannerConfiguration : NSObject

    Swift

    class SBSDKUIMachineCodeScannerConfiguration : NSObject

  • Subconfiguration for the textual contents of the detector screens for bar codes, QR codes and machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMachineCodeScannerTextConfiguration
    : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIMachineCodeScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration

  • Subconfiguration for user interface of the detector screens for bar codes, QR codes and machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMachineCodeScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIMachineCodeScannerUIConfiguration : NSObject

  • Factory class for machine readable code types.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMachineCodesCollection : NSObject

    Swift

    class SBSDKUIMachineCodesCollection : NSObject

  • Renders a ‘SBSDKUIDocument’ into a PDF.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIPDFRenderer : NSObject

    Swift

    class SBSDKUIPDFRenderer : NSObject

  • This class represents a scanned documents page.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIPage : NSObject

    Swift

    class SBSDKUIPage : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIPageFileStorage : NSObject

    Swift

    class SBSDKUIPageFileStorage : NSObject

  • A helper class to generate thumbnails from existing UIImage instances.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIPageStoragePreviewImageCreator : NSObject

    Swift

    class SBSDKUIPageStoragePreviewImageCreator : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIScanBarCodeWorkflowStep : SBSDKUIWorkflowStep

    Swift

    class SBSDKUIScanBarCodeWorkflowStep : SBSDKUIWorkflowStep

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIScanDisabilityCertificateWorkflowStep : SBSDKUIWorkflowStep

    Swift

    class SBSDKUIScanDisabilityCertificateWorkflowStep : SBSDKUIWorkflowStep

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIScanDocumentPageWorkflowStep : SBSDKUIWorkflowStep

    Swift

    class SBSDKUIScanDocumentPageWorkflowStep : SBSDKUIWorkflowStep

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIScanMachineReadableZoneWorkflowStep : SBSDKUIWorkflowStep

    Swift

    class SBSDKUIScanMachineReadableZoneWorkflowStep : SBSDKUIWorkflowStep

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIScanPayFormWorkflowStep : SBSDKUIWorkflowStep

    Swift

    class SBSDKUIScanPayFormWorkflowStep : SBSDKUIWorkflowStep

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIViewController : UIViewController

    Swift

    class SBSDKUIViewController : UIViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflow : NSObject

    Swift

    class SBSDKUIWorkflow : NSObject

  • Behaviour configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIWorkflowScannerBehaviorConfiguration : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowScannerConfiguration : NSObject

    Swift

    class SBSDKUIWorkflowScannerConfiguration : NSObject

  • Text configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowScannerTextConfiguration
    : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIWorkflowScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration

  • User interface configuration object for a ‘SBSDKUIWorkflowScannerViewController’.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIWorkflowScannerUIConfiguration : NSObject

  • View controller that processes a workflow.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIWorkflowScannerViewController : SBSDKUICameraViewController

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowStep : NSObject

    Swift

    class SBSDKUIWorkflowStep : NSObject

  • This class represents the result of one workflow step

    See more

    Declaration

    Objective-C

    @interface SBSDKUIWorkflowStepResult : NSObject

    Swift

    class SBSDKUIWorkflowStepResult : NSObject

  • vCard document field description

    See more

    Declaration

    Objective-C

    @interface SBSDKVCardDocumentField : NSObject

    Swift

    class SBSDKVCardDocumentField : NSObject

  • vCard document description

    See more

    Declaration

    Objective-C

    @interface SBSDKVCardDocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKVCardDocumentFormat : SBSDKBarCodeScannerDocumentFormat

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code containing http or https links.

    See more

    Declaration

    Objective-C

    @interface SBSDKWebURLQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKWebURLQRCode : SBSDKMachineReadableCode

  • A specific subclass of SBSDKMachineReadableCode that represents a QR code containing information about a WiFi hotspot (WIFI:).

    See more

    Declaration

    Objective-C

    @interface SBSDKWiFiHotspotQRCode : SBSDKMachineReadableCode

    Swift

    class SBSDKWiFiHotspotQRCode : SBSDKMachineReadableCode

  • Main class of Scanbot SDK. Lets you install the license and allows basic configuration.

    See more

    Declaration

    Objective-C

    @interface ScanbotSDK

    Swift

    class ScanbotSDK