Classes
The following classes are available globally.
-
AAMVA document subfile field.
See moreDeclaration
Objective-C
@interface SBSDKAAMVADocumentSubfileField : NSObject
Swift
class SBSDKAAMVADocumentSubfileField : NSObject
-
AAMVA document subfile information.
See moreDeclaration
Objective-C
@interface SBSDKAAMVADocumentSubfile : NSObject
Swift
class SBSDKAAMVADocumentSubfile : NSObject
-
AAMVA document information.
See moreDeclaration
Objective-C
@interface SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
ScanbotSDKs default data encrypter. Provides AES128 and AES 256 encryption to your data.
Note: For maximum security the key that is used for encryption and decryption should contain 16 UTF8 characters for AES128 and 32 UTF8 characters for AES256. If possible don’t use alphanumeric characters exclusively. If the key is shorter than the recommended key phrase length it will be padded automatically. Longer keys will be truncated.
See moreDeclaration
Objective-C
@interface SBSDKAESEncrypter : NSObject <SBSDKStorageCrypting>
Swift
class SBSDKAESEncrypter : NSObject, SBSDKStorageCrypting
-
A class that describes an aspect ratio for a documents page. *
See moreDeclaration
Objective-C
@interface SBSDKAspectRatio : NSObject
Swift
class SBSDKAspectRatio : NSObject
-
A class that represents a range of aspect ratios. *
See moreDeclaration
Objective-C
@interface SBSDKAspectRatioRange : NSObject
Swift
class SBSDKAspectRatioRange : NSObject
-
Base class for describing recognized and parsed barcode information.
See moreDeclaration
Objective-C
@interface SBSDKBarCodeScannerDocumentFormat : NSObject
Swift
class SBSDKBarCodeScannerDocumentFormat : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKBarcodeScanner : NSObject
Swift
class SBSDKBarcodeScanner : NSObject
-
Class that encapsulates bar code search and decode result.
See moreDeclaration
Objective-C
@interface SBSDKBarcodeScannerResult : NSObject
Swift
class SBSDKBarcodeScannerResult : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKBarcodeScannerViewController : SBSDKBaseCameraViewController
Swift
class SBSDKBarcodeScannerViewController : SBSDKBaseCameraViewController
-
Class that represents a barcode type.
See moreDeclaration
Objective-C
@interface SBSDKBarcodeType : NSObject
Swift
class SBSDKBarcodeType : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKBaseAdjustableFilter : NSObject
Swift
class SBSDKBaseAdjustableFilter : NSObject
-
A basic camera view controller. Can be used for custom video frame detection.
See moreDeclaration
Objective-C
@interface SBSDKBaseCameraViewController : UIViewController
Swift
class SBSDKBaseCameraViewController : UIViewController
-
Class for image blurriness value estimation.
See moreDeclaration
Objective-C
@interface SBSDKBlurrinessEstimator : NSObject
Swift
class SBSDKBlurrinessEstimator : NSObject
-
Boarding pass leg field description.
See moreDeclaration
Objective-C
@interface SBSDKBoardingPassLegField : NSObject
Swift
class SBSDKBoardingPassLegField : NSObject
-
Boarding pass leg information.
See moreDeclaration
Objective-C
@interface SBSDKBoardingPassLeg : NSObject
Swift
class SBSDKBoardingPassLeg : NSObject
-
Boarding pass document description.
See moreDeclaration
Objective-C
@interface SBSDKBoardingPassDocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKBoardingPassDocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
A CAShapeLayer subclass to draw rectangles to mark detected objects.
See moreDeclaration
Objective-C
@interface SBSDKBoxesLayer : CAShapeLayer
Swift
class SBSDKBoxesLayer : CAShapeLayer
-
Adjusts the brightness of an image.
See moreDeclaration
Objective-C
@interface SBSDKBrightnessFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKBrightnessFilter : SBSDKBaseAdjustableFilter
-
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 moreDeclaration
Objective-C
@interface SBSDKBusinessCardsImageProcessor : NSObject
Swift
class SBSDKBusinessCardsImageProcessor : NSObject
-
This class provides information about the current cameras exposure settings.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKCameraSession : NSObject
Swift
class SBSDKCameraSession : NSObject
-
Helper class, that gathers the image, camera and detection metadata of a document scan.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKChequeRecognizer : NSObject
Swift
class SBSDKChequeRecognizer : NSObject
-
Class contains information about recognized cheque field.
See moreDeclaration
Objective-C
@interface SBSDKChequeRecognizerResultField : NSObject
Swift
class SBSDKChequeRecognizerResultField : NSObject
-
Contains the result of a cheque recognition.
See moreDeclaration
Objective-C
@interface SBSDKChequeRecognizerResult : NSObject
Swift
class SBSDKChequeRecognizerResult : NSObject
-
A compound image filter to build a filter chain with minimal conversion and maximal performance.
See moreDeclaration
Objective-C
@interface SBSDKCompoundFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKCompoundFilter : SBSDKBaseAdjustableFilter
-
Adjusts the contrast of an image.
See moreDeclaration
Objective-C
@interface SBSDKContrastFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKContrastFilter : SBSDKBaseAdjustableFilter
-
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
See moreSBSDKImageEditingViewController
instead!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 moreDeclaration
Objective-C
@interface SBSDKDeviceInformation : NSObject
Swift
class SBSDKDeviceInformation : NSObject
-
DC field description.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificateDocumentField : NSObject
Swift
class SBSDKDisabilityCertificateDocumentField : NSObject
-
Class for parsing data obtained from QR code on disability certificates.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificateDocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKDisabilityCertificateDocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
Class intended to keep DisabilityCertificateRecognizer configuration options
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificatesRecognizer : NSObject
Swift
class SBSDKDisabilityCertificatesRecognizer : NSObject
-
Contains information about recognized Disability certificate checkbox.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificatesRecognizerCheckboxResult : NSObject
Swift
class SBSDKDisabilityCertificatesRecognizerCheckboxResult : NSObject
-
Class contains date information retrieved by disability certificates recognizer.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificatesRecognizerDateResult : NSObject
Swift
class SBSDKDisabilityCertificatesRecognizerDateResult : NSObject
-
This class describes the results of a disability certificate recognition.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificatesRecognizerResult : NSObject
Swift
class SBSDKDisabilityCertificatesRecognizerResult : NSObject
-
This class represents one entry of patient information recognized by disability certificate recognition.
See moreDeclaration
Objective-C
@interface SBSDKDisabilityCertificatesRecognizerResultPatientField : NSObject
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 moreDeclaration
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.
Declaration
Objective-C
@interface SBSDKDocumentDetector : NSObject
Swift
class SBSDKDocumentDetector : NSObject
-
This class represents the result of a document detection on an image.
See moreDeclaration
Objective-C
@interface SBSDKDocumentDetectorResult : NSObject <NSCopying>
Swift
class SBSDKDocumentDetectorResult : NSObject, NSCopying
-
Helper class to catch NSExceptions from with Swift code.
See moreDeclaration
Objective-C
@interface SBSDKExceptionHandler : NSObject
Swift
class SBSDKExceptionHandler : NSObject
-
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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKFrameLimiter : NSObject
Swift
class SBSDKFrameLimiter : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKGenericTextLineRecognizer : NSObject
Swift
class SBSDKGenericTextLineRecognizer : NSObject
-
A descriptor-like class to configure an instance of SBSDKGenericTextLineRecognizer.
See moreDeclaration
Objective-C
@interface SBSDKGenericTextLineRecognizerConfiguration : NSObject
Swift
class SBSDKGenericTextLineRecognizerConfiguration : NSObject
-
A class describing a recognized word, its bounding box and its text recognition confidence.
See moreDeclaration
Objective-C
@interface SBSDKGenericTextLineRecognizerResultWordBox : NSObject <SBSDKBoxedObject>
Swift
class SBSDKGenericTextLineRecognizerResultWordBox : NSObject, SBSDKBoxedObject
-
A class describing the result of the generic text line recognizer.
See moreDeclaration
Objective-C
@interface SBSDKGenericTextLineRecognizerResult : NSObject
Swift
class SBSDKGenericTextLineRecognizerResult : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKGenericTextLineRecognizerViewController : SBSDKBaseCameraViewController
Swift
class SBSDKGenericTextLineRecognizerViewController : SBSDKBaseCameraViewController
-
EHIC field data.
See moreDeclaration
Objective-C
@interface SBSDKHealthInsuranceCardField : NSObject
Swift
class SBSDKHealthInsuranceCardField : NSObject
-
The result of EHIC recognition returned by SBSDKHealthInsuranceCardRecognizer
See moreDeclaration
Objective-C
@interface SBSDKHealthInsuranceCardRecognitionResult : NSObject
Swift
class SBSDKHealthInsuranceCardRecognitionResult : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKHealthInsuranceCardRecognizer : NSObject
Swift
class SBSDKHealthInsuranceCardRecognizer : NSObject
-
Generic class that represents generic card. Is used for subclassing only. Contains only fields, that are common for all EU cards.
See moreDeclaration
Objective-C
@interface SBSDKIDCard : NSObject
Swift
class SBSDKIDCard : NSObject
-
Class that represents German identification card. A subclass of
See moreSBSDKIDCard
Declaration
Objective-C
@interface SBSDKIDCardGerman : SBSDKIDCard
Swift
class SBSDKIDCardGerman : SBSDKIDCard
-
ID card field description
See moreDeclaration
Objective-C
@interface SBSDKIDCardPDF417DocumentField : NSObject
Swift
class SBSDKIDCardPDF417DocumentField : NSObject
-
ID card document description
See moreDeclaration
Objective-C
@interface SBSDKIDCardPDF417DocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKIDCardPDF417DocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
Class that represents German international passport. A subclass of
See moreSBSDKIDCard
Declaration
Objective-C
@interface SBSDKIDCardPassportGerman : SBSDKIDCard
Swift
class SBSDKIDCardPassportGerman : 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.
See moreDeclaration
Objective-C
@interface SBSDKIDCardRecognizer : NSObject
Swift
class SBSDKIDCardRecognizer : NSObject
-
Contents of one data field of a personal ID card.
See moreDeclaration
Objective-C
@interface SBSDKIDCardRecognizerResultField : NSObject
Swift
class SBSDKIDCardRecognizerResultField : NSObject
-
The result of an ID card detection or recognition. Summarizes general information from the ID card scan and individual data fields.
See moreDeclaration
Objective-C
@interface SBSDKIDCardRecognizerResult : NSObject
Swift
class SBSDKIDCardRecognizerResult : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKIDCardScannerViewController : SBSDKBaseCameraViewController
Swift
class SBSDKIDCardScannerViewController : SBSDKBaseCameraViewController
-
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
See moreSBSDKCropViewController
.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 moreDeclaration
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:
Use UIImageJPEGRepresentation(UIImage *image, CGFloat compressionFactor) to get the NSData object from an UIImage.
Call SBSDKImageMetadataProcessor method extractMetadataFromImageData: to retrieve a SBSDKImageMetadata object from the image data.
Modify the metadata object as needed.
Call SBSDKImageMetadataProcessor method imageDataByInjectingMetadata to inject the modified metadata into the image data.
Create a new UIImage object from the returned image data using UIImage(data:) constructor with the modified metadata.
Declaration
Objective-C
@interface SBSDKImageMetadataProcessor : NSObject
Swift
class SBSDKImageMetadataProcessor : NSObject
-
Class containing the metrics for a single image channel.
See moreDeclaration
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.
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 moreDeclaration
Objective-C
@interface SBSDKImageProcessor : NSObject
Swift
class SBSDKImageProcessor : NSObject
-
A simple thread-safe multiple-reader-single-writer index based disk image cache class. Manages images in an array-like fashion.
See moreDeclaration
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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKLensCameraProperties : NSObject
Swift
class SBSDKLensCameraProperties : 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 moreDeclaration
Objective-C
@interface SBSDKMachineReadableZoneRecognizer : NSObject
Swift
class SBSDKMachineReadableZoneRecognizer : NSObject
-
A class representing a single data field in a machine-readable-zone.
See moreDeclaration
Objective-C
@interface SBSDKMachineReadableZoneRecognizerField : NSObject
Swift
class SBSDKMachineReadableZoneRecognizerField : NSObject
-
A class encapsulating a machine-readable-zone recognition result.
See moreDeclaration
Objective-C
@interface SBSDKMachineReadableZoneRecognizerResult : NSObject
Swift
class SBSDKMachineReadableZoneRecognizerResult : NSObject
-
Contains information about a single checkdigit.
See moreDeclaration
Objective-C
@interface SBSDKMachineReadableZoneRecognizerResultCheckDigit : NSObject
Swift
class SBSDKMachineReadableZoneRecognizerResultCheckDigit : NSObject
-
A class encapsulating machine-readable-zones text line.
See moreDeclaration
Objective-C
@interface SBSDKMachineReadableZoneRecognizerTextLine : NSObject
Swift
class SBSDKMachineReadableZoneRecognizerTextLine : NSObject
-
German medical plan document subheading prescription information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanSubheadingPrescriptionField : NSObject
Swift
class SBSDKMedicalPlanSubheadingPrescriptionField : NSObject
-
German medical plan document subheading prescription information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanSubheadingPrescription : NSObject
Swift
class SBSDKMedicalPlanSubheadingPrescription : NSObject
-
German medical plan document medicine substance information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanMedicineSubstanceField : NSObject
Swift
class SBSDKMedicalPlanMedicineSubstanceField : NSObject
-
German medical plan document medicine substance information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanMedicineSubstance : NSObject
Swift
class SBSDKMedicalPlanMedicineSubstance : NSObject
-
German medical plan document medicine information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanMedicineField : NSObject
Swift
class SBSDKMedicalPlanMedicineField : NSObject
-
German medical plan document medicine information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanMedicine : NSObject
Swift
class SBSDKMedicalPlanMedicine : NSObject
-
German medical plan document subheading information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanStandardSubheadingField : NSObject
Swift
class SBSDKMedicalPlanStandardSubheadingField : NSObject
-
German medical plan document subheading information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanStandardSubheading : NSObject
Swift
class SBSDKMedicalPlanStandardSubheading : NSObject
-
German medical plan document doctor information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanDoctorField : NSObject
Swift
class SBSDKMedicalPlanDoctorField : NSObject
-
German medical plan document doctor information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanDoctorInformation : NSObject
Swift
class SBSDKMedicalPlanDoctorInformation : NSObject
-
German medical plan document patient information description field.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanPatientField : NSObject
Swift
class SBSDKMedicalPlanPatientField : NSObject
-
German medical plan document patient information description.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanPatientInformation : NSObject
Swift
class SBSDKMedicalPlanPatientInformation : NSObject
-
German medical plan document description structure.
See moreDeclaration
Objective-C
@interface SBSDKMedicalPlanDocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKMedicalPlanDocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
A view controller for scanning multiple objects on a single captured still image. *
See moreDeclaration
Objective-C
@interface SBSDKMultipleObjectScannerViewController : SBSDKBaseCameraViewController
Swift
class SBSDKMultipleObjectScannerViewController : SBSDKBaseCameraViewController
-
Detects multiple non-overlapping rectangular objects within an image. Like a bunch of business cards.
See moreDeclaration
Objective-C
@interface SBSDKMultipleObjectsDetector : NSObject
Swift
class SBSDKMultipleObjectsDetector : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKNFCDatagroup : NSObject
Swift
class SBSDKNFCDatagroup : NSObject
-
Data group 1 or DG1. Contains general information about the passport and its holder.
See moreDeclaration
Objective-C
@interface SBSDKNFCDatagroupDG1 : SBSDKNFCDatagroup
Swift
class SBSDKNFCDatagroupDG1 : SBSDKNFCDatagroup
-
Data group 2 or DG2. Contains visual biometric data of the passports holder.
See moreDeclaration
Objective-C
@interface SBSDKNFCDatagroupDG2 : SBSDKNFCDatagroup
Swift
class SBSDKNFCDatagroupDG2 : SBSDKNFCDatagroup
-
A class for reading out the data of a passports Near Field Communication (NFC) chip.
Notes:
Requires
Requires iOS 13.0+- 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”
Declaration
Objective-C
@interface SBSDKNFCPassportReader : NSObject
Swift
class SBSDKNFCPassportReader : 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 moreDeclaration
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 moreDeclaration
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 moreDeclaration
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 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.
See moreDeclaration
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 moreDeclaration
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.
Declaration
Objective-C
@interface SBSDKPageAnalyzerResult : NSObject <NSCopying>
Swift
class SBSDKPageAnalyzerResult : NSObject, NSCopying
-
Describes the position and the type of a text box within the image being detected or recognized.
See moreDeclaration
Objective-C
@interface SBSDKPayFormToken : NSObject
Swift
class SBSDKPayFormToken : NSObject
-
Resulting element of the SBSDKPayFormScanners recognizer. Holds a token and its recognized text value after recognition.
See moreDeclaration
Objective-C
@interface SBSDKPayFormRecognizedField : NSObject
Swift
class SBSDKPayFormRecognizedField : NSObject
-
Result class of SBSDKPayFormScanners recognizer part. Encapsulates the recognized text fields.
See moreDeclaration
Objective-C
@interface SBSDKPayFormRecognitionResult : NSObject
Swift
class SBSDKPayFormRecognitionResult : NSObject
-
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 moreDeclaration
Objective-C
@interface SBSDKPayFormScanner : NSObject
Swift
class SBSDKPayFormScanner : NSObject
-
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 moreDeclaration
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 moreDeclaration
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 moreDeclaration
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.
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
See more-cancel
on the progress object.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 moreDeclaration
Objective-C
@interface SBSDKResourcesManager : NSObject
Swift
class SBSDKResourcesManager : NSObject
-
SEPA document field information.
See moreDeclaration
Objective-C
@interface SBSDKSEPADocumentField : NSObject
Swift
class SBSDKSEPADocumentField : NSObject
-
SEPA parsed document information.
See moreDeclaration
Objective-C
@interface SBSDKSEPADocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKSEPADocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
Adjusts the saturation of an image.
See moreDeclaration
Objective-C
@interface SBSDKSaturationFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKSaturationFilter : SBSDKBaseAdjustableFilter
-
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 moreDeclaration
Objective-C
@interface SBSDKScannerViewController : SBSDKBaseCameraViewController
Swift
class SBSDKScannerViewController : SBSDKBaseCameraViewController
-
A filter that separately adjusts the contrast of darker and brighter image areas.
See moreDeclaration
Objective-C
@interface SBSDKShadowsHighlightsFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKShadowsHighlightsFilter : SBSDKBaseAdjustableFilter
-
@class SBSDKShutterButton The button class used in the camera view controller to take a snapshot. Animates itself depending on its status.
See moreDeclaration
Objective-C
@interface SBSDKShutterButton : UIButton
Swift
class SBSDKShutterButton : UIButton
-
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.
See moreDeclaration
Objective-C
@interface SBSDKSmartFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKSmartFilter : SBSDKBaseAdjustableFilter
-
A contrast image filter that works with shifting white and black point.
See moreDeclaration
Objective-C
@interface SBSDKSpecialContrastFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKSpecialContrastFilter : SBSDKBaseAdjustableFilter
-
Descriptor and helper class for describing and creating a directory on the file system.
See moreDeclaration
Objective-C
@interface SBSDKStorageLocation : NSObject
Swift
class SBSDKStorageLocation : NSObject
-
Class used to convert and write images in TIFF format
See moreDeclaration
Objective-C
@interface SBSDKTIFFImageWriter : NSObject
Swift
class SBSDKTIFFImageWriter : NSObject
-
Class used to define parameters for TIFF format writer.
See moreDeclaration
Objective-C
@interface SBSDKTIFFImageWriterParameters : NSObject
Swift
class SBSDKTIFFImageWriterParameters : NSObject
-
Class used to describe user-defined TIFF field.
See moreDeclaration
Objective-C
@interface SBSDKTIFFImageWriterUserDefinedField : NSObject
Swift
class SBSDKTIFFImageWriterUserDefinedField : NSObject
-
Adjusts the color temperature of an image.
See moreDeclaration
Objective-C
@interface SBSDKTemperatureFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKTemperatureFilter : SBSDKBaseAdjustableFilter
-
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.
See moreDeclaration
Objective-C
@interface SBSDKTextOrientationRecognizer : NSObject
Swift
class SBSDKTextOrientationRecognizer : NSObject
-
Adjusts the tint of an image.
See moreDeclaration
Objective-C
@interface SBSDKTintAdjustFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKTintAdjustFilter : SBSDKBaseAdjustableFilter
-
Class which handles storing and removing barcode images from
See moreSBSDKUIBarcodeScannerViewController
.Declaration
Objective-C
@interface SBSDKUIBarcodeImageStorage : NSObject
Swift
class SBSDKUIBarcodeImageStorage : NSObject
-
Class that contains barcode name and description.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodeMappedData : NSObject
Swift
class SBSDKUIBarcodeMappedData : NSObject
-
Class that contains barcode result and mapped data.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodeMappedResult : NSObject
Swift
class SBSDKUIBarcodeMappedResult : NSObject
-
A configurable view controller for camera-based detection of QR and bar codes.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController
-
Subconfiguration for the behavior of barcodes.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodesBatchScannerBehaviorConfiguration : NSObject
Swift
class SBSDKUIBarcodesBatchScannerBehaviorConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodesBatchScannerConfiguration : NSObject
Swift
class SBSDKUIBarcodesBatchScannerConfiguration : NSObject
-
Subconfiguration for the textual contents of the detector screens for barcodes.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodesBatchScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIBarcodesBatchScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the detector screens for barcodes.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodesBatchScannerUIConfiguration : NSObject
Swift
class SBSDKUIBarcodesBatchScannerUIConfiguration : NSObject
-
A configurable view controller for camera-based detection of barcodes batches.
See moreDeclaration
Objective-C
@interface SBSDKUIBarcodesBatchScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIBarcodesBatchScannerViewController : SBSDKUICameraViewController
-
A SBSDKUIViewController subclass which adds support for enabled and disabled camera permission.
See moreDeclaration
Objective-C
@interface SBSDKUICameraViewController : SBSDKUIViewController
Swift
class SBSDKUICameraViewController : SBSDKUIViewController
-
Subconfiguration for the behavior of the cropping screen.
See moreDeclaration
Objective-C
@interface SBSDKUICroppingScreenBehaviorConfiguration : NSObject
Swift
class SBSDKUICroppingScreenBehaviorConfiguration : NSObject
-
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 moreDeclaration
Objective-C
@interface SBSDKUICroppingScreenConfiguration : NSObject
Swift
class SBSDKUICroppingScreenConfiguration : NSObject
-
Subconfiguration for the textual content of the page cropping screen.
See moreDeclaration
Objective-C
@interface SBSDKUICroppingScreenTextConfiguration : NSObject
Swift
class SBSDKUICroppingScreenTextConfiguration : NSObject
-
Subconfiguration for user interface of the page cropping screen.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUICroppingViewController : SBSDKUIViewController
Swift
class SBSDKUICroppingViewController : SBSDKUIViewController
-
A thread-safe, mutable container for scanned pages of type ‘SBSDKUIPage’.
See moreDeclaration
Objective-C
@interface SBSDKUIDocument : NSObject
Swift
class SBSDKUIDocument : NSObject
-
Subconfiguration for the behavior of the document scanning screen.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIDocumentScannerConfiguration : NSObject
Swift
class SBSDKUIDocumentScannerConfiguration : NSObject
-
Subconfiguration for the textual contents of the document scanning screen.
See moreDeclaration
Objective-C
@interface SBSDKUIDocumentScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIDocumentScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the document scanning screen.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController
-
Subconfiguration for the textual contents of camera based view controllers.
See moreDeclaration
Objective-C
@interface SBSDKUIEnableCameraTextConfiguration : NSObject
Swift
class SBSDKUIEnableCameraTextConfiguration : NSObject
-
Subconfiguration for the user interface of camera based view controllers.
See moreDeclaration
Objective-C
@interface SBSDKUIEnableCameraUIConfiguration : NSObject
Swift
class SBSDKUIEnableCameraUIConfiguration : NSObject
-
Subconfiguration for the behavior of Health Insurance Card scanner.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIHealthInsuranceCardScannerConfiguration : NSObject
Swift
class SBSDKUIHealthInsuranceCardScannerConfiguration : NSObject
-
Subconfiguration for the textual contents of the detector screen for Health Insurance Card scanner.
See moreDeclaration
Objective-C
@interface SBSDKUIHealthInsuranceCardScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIHealthInsuranceCardScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the detector screen for Health Insurance Card scanner.
See moreDeclaration
Objective-C
@interface SBSDKUIHealthInsuranceCardScannerUIConfiguration : NSObject
Swift
class SBSDKUIHealthInsuranceCardScannerUIConfiguration : NSObject
-
A view controller for camera-based detection of health insurance card.
See moreDeclaration
Objective-C
@interface SBSDKUIHealthInsuranceCardScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIHealthInsuranceCardScannerViewController : SBSDKUICameraViewController
-
Subconfiguration for the behavior of ID card scanner.
See moreDeclaration
Objective-C
@interface SBSDKUIIDCardScannerBehaviorConfiguration : NSObject
Swift
class SBSDKUIIDCardScannerBehaviorConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUIIDCardScannerConfiguration : NSObject
Swift
class SBSDKUIIDCardScannerConfiguration : NSObject
-
Subconfiguration for the textual contents of the ID card detector screen.
See moreDeclaration
Objective-C
@interface SBSDKUIIDCardScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIIDCardScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the ID cards detector screens.
See moreDeclaration
Objective-C
@interface SBSDKUIIDCardScannerUIConfiguration : NSObject
Swift
class SBSDKUIIDCardScannerUIConfiguration : NSObject
-
A configurable view controller for camera-based detection of ID cards.
See moreDeclaration
Objective-C
@interface SBSDKUIIDCardScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIIDCardScannerViewController : SBSDKUICameraViewController
-
Class which handles storing and removing ID card images from
See moreSBSDKUIIDCardScannerViewController
.Declaration
Objective-C
@interface SBSDKUIIDCardStorage : NSObject
Swift
class SBSDKUIIDCardStorage : NSObject
-
A view controller for camera-based detection of machine readable zones.
See moreDeclaration
Objective-C
@interface SBSDKUIMRZScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIMRZScannerViewController : SBSDKUICameraViewController
-
Subconfiguration for the behavior of bar codes, QR codes and machine readable zones scanners.
See moreDeclaration
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 moreDeclaration
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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIMachineCodeScannerUIConfiguration : NSObject
Swift
class SBSDKUIMachineCodeScannerUIConfiguration : NSObject
-
Factory class for machine readable code types.
See moreDeclaration
Objective-C
@interface SBSDKUIMachineCodesCollection : NSObject
Swift
class SBSDKUIMachineCodesCollection : NSObject
-
Subconfiguration for the behavior of the document scanning screen.
See moreDeclaration
Objective-C
@interface SBSDKUIMultipleObjectScannerBehaviorConfiguration : NSObject
Swift
class SBSDKUIMultipleObjectScannerBehaviorConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUIMultipleObjectScannerConfiguration : NSObject
Swift
class SBSDKUIMultipleObjectScannerConfiguration : NSObject
-
Subconfiguration for the textual contents of the document scanning screen.
See moreDeclaration
Objective-C
@interface SBSDKUIMultipleObjectScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIMultipleObjectScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the document scanning screen.
See moreDeclaration
Objective-C
@interface SBSDKUIMultipleObjectScannerUIConfiguration : NSObject
Swift
class SBSDKUIMultipleObjectScannerUIConfiguration : NSObject
-
A configurable view controller for camera based multiple objects scanning.
See moreDeclaration
Objective-C
@interface SBSDKUIMultipleObjectScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUIMultipleObjectScannerViewController : SBSDKUICameraViewController
-
Subconfiguration for the behavior of NFC reader.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderBehaviorConfiguration : NSObject
Swift
class SBSDKUINFCPassportReaderBehaviorConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderConfiguration : NSObject
Swift
class SBSDKUINFCPassportReaderConfiguration : NSObject
-
The result of a passport reading operation.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderResult : NSObject
Swift
class SBSDKUINFCPassportReaderResult : NSObject
-
Class which handles storing and removing images from
See moreSBSDKUINFCPassportReaderViewController
.Declaration
Objective-C
@interface SBSDKUINFCPassportReaderStorage : NSObject
Swift
class SBSDKUINFCPassportReaderStorage : NSObject
-
Subconfiguration for the textual contents of the NFC reader screens.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUINFCPassportReaderTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the NFC reader screen.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderUIConfiguration : NSObject
Swift
class SBSDKUINFCPassportReaderUIConfiguration : NSObject
-
A ready-to-use viewcontroller component to scan the NFC chip of a passport and extract its information.
See moreDeclaration
Objective-C
@interface SBSDKUINFCPassportReaderViewController : SBSDKUICameraViewController
Swift
class SBSDKUINFCPassportReaderViewController : SBSDKUICameraViewController
-
Renders a ‘SBSDKUIDocument’ into a PDF.
See moreDeclaration
Objective-C
@interface SBSDKUIPDFRenderer : NSObject
Swift
class SBSDKUIPDFRenderer : NSObject
-
This class represents a scanned documents page.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIPageFileStorage : NSObject
Swift
class SBSDKUIPageFileStorage : NSObject
-
A helper class to generate thumbnails from existing UIImage instances.
See moreDeclaration
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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIScanDisabilityCertificateWorkflowStep : SBSDKUIWorkflowStep
Swift
class SBSDKUIScanDisabilityCertificateWorkflowStep : SBSDKUIWorkflowStep
-
A ‘SBSDKUIWorkflowStep’ subclass specialized on capturing documents from high-res still images.
See moreDeclaration
Objective-C
@interface SBSDKUIScanDocumentPageWorkflowStep : SBSDKUIWorkflowStep
Swift
class SBSDKUIScanDocumentPageWorkflowStep : SBSDKUIWorkflowStep
-
A ‘SBSDKUIScanHealthInsuranceCardWorkflowStep’ subclass specialized on recognizing health insurance card on low-res video frames (live detection).
See moreDeclaration
Objective-C
@interface SBSDKUIScanHealthInsuranceCardWorkflowStep : SBSDKUIWorkflowStep
Swift
class SBSDKUIScanHealthInsuranceCardWorkflowStep : 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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIScanPayFormWorkflowStep : SBSDKUIWorkflowStep
Swift
class SBSDKUIScanPayFormWorkflowStep : SBSDKUIWorkflowStep
-
Subconfiguration for the behavior of text line recognizer.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerBehaviorConfiguration : NSObject
Swift
class SBSDKUITextDataScannerBehaviorConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerConfiguration : NSObject
Swift
class SBSDKUITextDataScannerConfiguration : NSObject
-
Defines a single workflow step of ‘SBSDKUITextDataScannerViewController’ flow.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerStep : NSObject
Swift
class SBSDKUITextDataScannerStep : NSObject
-
Encapsulates the result of the text recognition of a ‘SBSDKUITextDataScannerViewController’s workflow step.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerStepResult : NSObject
Swift
class SBSDKUITextDataScannerStepResult : NSObject
-
Subconfiguration for the textual contents of the text line recognizer.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUITextDataScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
Subconfiguration for user interface of the text line recognizer.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerUIConfiguration : NSObject
Swift
class SBSDKUITextDataScannerUIConfiguration : NSObject
-
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.
See moreDeclaration
Objective-C
@interface SBSDKUITextDataScannerViewController : SBSDKUICameraViewController
Swift
class SBSDKUITextDataScannerViewController : SBSDKUICameraViewController
-
Abstract base class for SBSDKUI view controllers. Do not use/subclass directly.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIWorkflow : NSObject
Swift
class SBSDKUIWorkflow : NSObject
-
Behavior configuration object for a ‘SBSDKUIWorkflowScannerViewController’.
See moreDeclaration
Objective-C
@interface SBSDKUIWorkflowScannerBehaviorConfiguration : NSObject
Swift
class SBSDKUIWorkflowScannerBehaviorConfiguration : NSObject
-
Configuration object that holds the subconfigurations for a ‘SBSDKUIWorkflowScannerViewController’.
See moreDeclaration
Objective-C
@interface SBSDKUIWorkflowScannerConfiguration : NSObject
Swift
class SBSDKUIWorkflowScannerConfiguration : NSObject
-
Text configuration object for a ‘SBSDKUIWorkflowScannerViewController’.
See moreDeclaration
Objective-C
@interface SBSDKUIWorkflowScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
Swift
class SBSDKUIWorkflowScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
-
User interface configuration object for a ‘SBSDKUIWorkflowScannerViewController’.
See moreDeclaration
Objective-C
@interface SBSDKUIWorkflowScannerUIConfiguration : NSObject
Swift
class SBSDKUIWorkflowScannerUIConfiguration : NSObject
-
View controller that processes a workflow.
See moreDeclaration
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 moreDeclaration
Objective-C
@interface SBSDKUIWorkflowStep : NSObject
Swift
class SBSDKUIWorkflowStep : NSObject
-
This class represents the result of one workflow step
See moreDeclaration
Objective-C
@interface SBSDKUIWorkflowStepResult : NSObject
Swift
class SBSDKUIWorkflowStepResult : NSObject
-
vCard document field description.
See moreDeclaration
Objective-C
@interface SBSDKVCardDocumentField : NSObject
Swift
class SBSDKVCardDocumentField : NSObject
-
vCard document description.
See moreDeclaration
Objective-C
@interface SBSDKVCardDocumentFormat : SBSDKBarCodeScannerDocumentFormat
Swift
class SBSDKVCardDocumentFormat : SBSDKBarCodeScannerDocumentFormat
-
Adjusts the vibrance of an image. Vibrance makes colors more brilliant.
See moreDeclaration
Objective-C
@interface SBSDKVibranceFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKVibranceFilter : SBSDKBaseAdjustableFilter
-
A filter that maps the brightness values of the images to the given black and white points.
See moreDeclaration
Objective-C
@interface SBSDKWhiteAndBlackPointFilter : SBSDKBaseAdjustableFilter
Swift
class SBSDKWhiteAndBlackPointFilter : SBSDKBaseAdjustableFilter
-
Main class of Scanbot SDK. Lets you install the license and allows basic configuration.
See moreDeclaration
Objective-C
@interface ScanbotSDK
Swift
class ScanbotSDK
-
Helper class to configure properties of the ScanbotSDKUI (SBSDKUI) components.
See moreDeclaration
Objective-C
@interface ScanbotSDKUI : NSObject
Swift
class ScanbotSDKUI : NSObject