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

    See more

    Declaration

    Objective-C

    @interface SBSDKAAMVADocumentSubfile : NSObject

    Swift

    class SBSDKAAMVADocumentSubfile : NSObject
  • AAMVA document information.

    See more

    Declaration

    Objective-C

    @interface SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKAAMVADocumentFormat : SBSDKBarCodeScannerDocumentFormat
  • ScanbotSDKs default data encrypter. Provides AES128 and AES 256 encryption to your data.

    See more

    Declaration

    Objective-C

    @interface SBSDKAESEncrypter : NSObject <SBSDKStorageCrypting>

    Swift

    class SBSDKAESEncrypter : NSObject, SBSDKStorageCrypting
  • A class that describes an aspect ratio for a documents page. *

    See more

    Declaration

    Objective-C

    @interface SBSDKAspectRatio : NSObject

    Swift

    class SBSDKAspectRatio : NSObject
  • A class that represents a range of aspect ratios. *

    See more

    Declaration

    Objective-C

    @interface SBSDKAspectRatioRange : NSObject

    Swift

    class SBSDKAspectRatioRange : NSObject
  • A helper class describing a barcode document type.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeDocumentType : NSObject

    Swift

    class SBSDKBarcodeDocumentType : NSObject
  • Base class for describing recognized and parsed barcode information.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarCodeScannerDocumentFormat : NSObject

    Swift

    class SBSDKBarCodeScannerDocumentFormat : NSObject
  • A class that contains additional parameters for barcodes detection and filtering.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeAdditionalParameters : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeDocumentParser : NSObject

    Swift

    class SBSDKBarcodeDocumentParser : NSObject
  • A UIViewController subclass to show a camera screen with the barcode detector. Screen also shows snap, scan more and reset buttons. The snap button starts the scanning when tapped. The scan more button can be used to scan more barcodes, the accumulated results are stored in countedBarcodes property. The reset button resets the scanner, and the stored accumulated results are also cleared. 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 SBSDKBarcodeScanAndCountViewController
        : SBSDKBaseScannerViewController

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScanner : NSObject

    Swift

    class SBSDKBarcodeScanner : NSObject
  • The class that keeps track of the detected code and the number of times it is scanned.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScannerAccumulatingResult : NSObject

    Swift

    class SBSDKBarcodeScannerAccumulatingResult : NSObject
  • This class encapsulates the result of a barcode detection.

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScannerResult : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBarcodeScannerViewController : SBSDKBaseScannerViewController

    Swift

    class SBSDKBarcodeScannerViewController : SBSDKBaseScannerViewController
  • Class that represents a barcode type.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKBaseAdjustableFilter : NSObject

    Swift

    class SBSDKBaseAdjustableFilter : NSObject
  • The energy management configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses. ‘SBSDKBaseScannerViewController’ and subclasses sport a customizable energy management system.

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

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

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

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBaseScannerEnergyConfiguration : NSObject

    Swift

    class SBSDKBaseScannerEnergyConfiguration : NSObject
  • The general configuration object for a ‘SBSDKBaseScannerViewController’ and its subclasses.

    See more

    Declaration

    Objective-C

    @interface SBSDKBaseScannerGeneralConfiguration : NSObject

    Swift

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

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

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBaseScannerViewController : UIViewController

    Swift

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

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBaseScannerViewFinderConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKBaseScannerZoomConfiguration : NSObject

    Swift

    class SBSDKBaseScannerZoomConfiguration : NSObject
  • Class for image blurriness value estimation.

    See more

    Declaration

    Objective-C

    @interface SBSDKBlurrinessEstimator : NSObject

    Swift

    class SBSDKBlurrinessEstimator : NSObject
  • Boarding pass leg field description.

    See more

    Declaration

    Objective-C

    @interface SBSDKBoardingPassLegField : NSObject

    Swift

    class SBSDKBoardingPassLegField : NSObject
  • Boarding pass leg information.

    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 CAShapeLayer subclass to draw rectangles to mark detected objects.

    See more

    Declaration

    Objective-C

    @interface SBSDKBoxesLayer : CAShapeLayer

    Swift

    class SBSDKBoxesLayer : CAShapeLayer
  • Adjusts the brightness of an image.

    See more

    Declaration

    Objective-C

    @interface SBSDKBrightnessFilter : SBSDKBaseAdjustableFilter

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKCameraDevice : NSObject

    Swift

    class SBSDKCameraDevice : 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
  • None.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentCheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentCheck : SBSDKGenericDocumentWrapper
  • A check compatible with the ASC X9 standard used in the USA.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentUSACheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentUSACheck : SBSDKGenericDocumentWrapper
  • A check format commonly used in France.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentFRACheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentFRACheck : SBSDKGenericDocumentWrapper
  • A check format commonly used in Kuwait.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentKWTCheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentKWTCheck : SBSDKGenericDocumentWrapper
  • A check compatible with the Australian Paper Clearing System cheque standard.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentAUSCheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentAUSCheck : SBSDKGenericDocumentWrapper
  • A check compatible with the CTS-2010 standard issued by the Reserve Bank of India in 2012.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentINDCheck : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKCheckDocumentINDCheck : SBSDKGenericDocumentWrapper
  • Root document type.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckDocumentRootType : SBSDKGenericDocumentType

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckRecognizer : NSObject

    Swift

    class SBSDKCheckRecognizer : NSObject
  • The result object of a check recognition.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckRecognizerResult : NSObject

    Swift

    class SBSDKCheckRecognizerResult : NSObject
  • Classic UI view controller that can be used to detect and recognize bank checks. Can be configured to recognize on video frames or, for better accuracy, on high-res photos that are automatically captured.

    See more

    Declaration

    Objective-C

    @interface SBSDKCheckRecognizerViewController : SBSDKBaseScannerViewController

    Swift

    class SBSDKCheckRecognizerViewController : SBSDKBaseScannerViewController
  • A compound image filter to build a filter chain with minimal conversion and maximal performance.

    See more

    Declaration

    Objective-C

    @interface SBSDKCompoundFilter : SBSDKBaseAdjustableFilter

    Swift

    class SBSDKCompoundFilter : SBSDKBaseAdjustableFilter
  • Adjusts the contrast of an image.

    See more

    Declaration

    Objective-C

    @interface SBSDKContrastFilter : SBSDKBaseAdjustableFilter

    Swift

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

    See more

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

    • A class to detect a document’s outline polygon in a UIImage or CMSampleBufferRef.
    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
  • Wraps the texts being displayed as the detection status.

    See more

    Declaration

    Objective-C

    @interface SBSDKDocumentScannerStatusTextConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKDocumentScannerViewController : SBSDKBaseScannerViewController

    Swift

    class SBSDKDocumentScannerViewController : SBSDKBaseScannerViewController
  • A UIView subclass to display a view finder with colored background and transparent cutout with the given aspect ratio.

    See more

    Declaration

    Objective-C

    @interface SBSDKFinderView : UIView

    Swift

    class SBSDKFinderView : UIView
  • 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 class describing a data field of a GS1 code.

    See more

    Declaration

    Objective-C

    @interface SBSDKGS1DocumentField : NSObject

    Swift

    class SBSDKGS1DocumentField : NSObject
  • The document format of a GS1 code.

    See more

    Declaration

    Objective-C

    @interface SBSDKGS1DocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKGS1DocumentFormat : SBSDKBarCodeScannerDocumentFormat
  • A generic documents fields result of OCR text recognition.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentOcrResult : NSObject

    Swift

    class SBSDKGenericDocumentOcrResult : NSObject
  • A generic documents field type.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentFieldType : NSObject

    Swift

    class SBSDKGenericDocumentFieldType : NSObject
  • A generic documents field.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentField : NSObject

    Swift

    class SBSDKGenericDocumentField : NSObject
  • A generic documents type.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentType : NSObject

    Swift

    class SBSDKGenericDocumentType : NSObject
  • A generic document. Contains fields and sub-documents.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocument : NSObject

    Swift

    class SBSDKGenericDocument : NSObject
  • Root document type.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentRootType : SBSDKGenericDocumentType

    Swift

    class SBSDKGenericDocumentRootType : SBSDKGenericDocumentType
  • The recognition result of the SBSDKGenericDocumentRecognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentRecognitionResult : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentRecognizer : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentRecognizerViewController
        : SBSDKBaseScannerViewController

    Swift

    class SBSDKGenericDocumentRecognizerViewController : SBSDKBaseScannerViewController
  • Base class for strongly-typed SBSDKGenericDocument wrappers

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentWrapper : NSObject

    Swift

    class SBSDKGenericDocumentWrapper : NSObject
  • MRZ part of the document.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentMRZ : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentMRZ : SBSDKGenericDocumentWrapper
  • German ID card, front side.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeIdCardFront : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDeIdCardFront : SBSDKGenericDocumentWrapper
  • German ID card, back side.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeIdCardBack : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDeIdCardBack : SBSDKGenericDocumentWrapper
  • German travel passport (Reisepass).

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDePassport : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDePassport : SBSDKGenericDocumentWrapper
  • German driver license (Führerschein), front side.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeDriverLicenseFront
        : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDeDriverLicenseFront : SBSDKGenericDocumentWrapper
  • A category row from the categories table.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeDriverLicenseBackCategory
        : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDeDriverLicenseBackCategory : SBSDKGenericDocumentWrapper
  • Categories table row container.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeDriverLicenseBackCategories
        : SBSDKGenericDocumentWrapper

    Swift

    class SBSDKGenericDocumentDeDriverLicenseBackCategories : SBSDKGenericDocumentWrapper
  • German driver license (Führerschein), back side.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericDocumentDeDriverLicenseBack : SBSDKGenericDocumentWrapper

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericTextLineRecognizer : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericTextLineRecognizerConfiguration : NSObject

    Swift

    class SBSDKGenericTextLineRecognizerConfiguration : NSObject
  • A class describing a recognized word, its bounding box and its text recognition confidence.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericTextLineRecognizerResultWordBox
        : NSObject <SBSDKBoxedObject>

    Swift

    class SBSDKGenericTextLineRecognizerResultWordBox : NSObject, SBSDKBoxedObject
  • A class describing the result of the generic text line recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericTextLineRecognizerResult : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKGenericTextLineRecognizerViewController
        : SBSDKBaseScannerViewController

    Swift

    class SBSDKGenericTextLineRecognizerViewController : SBSDKBaseScannerViewController
  • 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
  • A class to recognize European health insurance cards (EHIC), a.k.a. elektronische Gesundheitskarten (eGK). NOTE: In order to operate, this class requires tesseract languages and trained data to be present in the application bundle.

    See more

    Declaration

    Objective-C

    @interface SBSDKHealthInsuranceCardRecognizer : NSObject

    Swift

    class SBSDKHealthInsuranceCardRecognizer : NSObject
  • A UIViewController subclass to scan health insurance cards with the camera.

    See more

    Declaration

    Objective-C

    @interface SBSDKHealthInsuranceCardScannerViewController
        : SBSDKBaseScannerViewController

    Swift

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

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

    See more

    Declaration

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

    See more

    Declaration

    Objective-C

    @interface SBSDKLicensePlateScanner : NSObject

    Swift

    class SBSDKLicensePlateScanner : NSObject
  • A class being used to configure the license plate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKLicensePlateScannerConfiguration : NSObject

    Swift

    class SBSDKLicensePlateScannerConfiguration : NSObject
  • A class describing the result of a license plate scan.

    See more

    Declaration

    Objective-C

    @interface SBSDKLicensePlateScannerResult : NSObject

    Swift

    class SBSDKLicensePlateScannerResult : NSObject
  • A UIViewController subclass to scan for license plates with the camera.

    See more

    Declaration

    Objective-C

    @interface SBSDKLicensePlateScannerViewController
        : SBSDKBaseScannerViewController

    Swift

    class SBSDKLicensePlateScannerViewController : SBSDKBaseScannerViewController
  • A camera-enabled UIViewController subclass to scan machine-readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKMRZScannerViewController : SBSDKBaseScannerViewController

    Swift

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

    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
  • Medical certificate field description.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateDocumentField : NSObject

    Swift

    class SBSDKMedicalCertificateDocumentField : NSObject
  • Class for parsing data obtained from QR code on medical certificates.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateDocumentFormat
        : SBSDKBarCodeScannerDocumentFormat

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizer : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizer : NSObject
  • Contains information about recognized medical certificate checkbox.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizerCheckboxResult : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizerCheckboxResult : NSObject
  • A class intended to store the configuration options for a medical certificate recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizerConfigurationOptions : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizerConfigurationOptions : NSObject
  • Class contains date information retrieved by medical certificates recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizerDateResult : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizerDateResult : NSObject
  • This class describes the results of a medical certificate recognition.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizerResult : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizerResult : NSObject
  • This class represents one entry of patient information recognized by medical certificate recognition.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateRecognizerResultPatientField : NSObject

    Swift

    class SBSDKMedicalCertificateRecognizerResultPatientField : NSObject
  • Classic UI view controller that can be used to detect and recognize medical certificates. Can be configured to recognize on video frames or, for better accuracy, on high-res photos that are automatically captured.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalCertificateScannerViewController
        : SBSDKBaseScannerViewController

    Swift

    class SBSDKMedicalCertificateScannerViewController : SBSDKBaseScannerViewController
  • German medical plan document subheading prescription information description field.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanSubheadingPrescriptionField : NSObject

    Swift

    class SBSDKMedicalPlanSubheadingPrescriptionField : NSObject
  • German medical plan document subheading prescription information description.

    See more

    Declaration

    Objective-C

    @interface SBSDKMedicalPlanSubheadingPrescription : NSObject

    Swift

    class SBSDKMedicalPlanSubheadingPrescription : 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
  • 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 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 more

    Declaration

    Objective-C

    @interface SBSDKOpticalTextRecognizer : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPDFMetadataProcessor : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKPDFPagesExtractor : NSObject

    Swift

    class SBSDKPDFPagesExtractor : NSObject
  • A class to render an ordered collection of images into a basic, non-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
  • 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 document field information.

    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
  • Adjusts the saturation of an image.

    See more

    Declaration

    Objective-C

    @interface SBSDKSaturationFilter : SBSDKBaseAdjustableFilter

    Swift

    class SBSDKSaturationFilter : SBSDKBaseAdjustableFilter
  • A filter that separately adjusts the contrast of darker and brighter image areas.

    See more

    Declaration

    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 more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKSmartFilter : SBSDKBaseAdjustableFilter

    Swift

    class SBSDKSmartFilter : SBSDKBaseAdjustableFilter
  • A class to manage playback of sounds and vibration.

    See more

    Declaration

    Objective-C

    @interface SBSDKSoundController : NSObject

    Swift

    class SBSDKSoundController : NSObject
  • A contrast image filter that works with shifting white and black point.

    See more

    Declaration

    Objective-C

    @interface SBSDKSpecialContrastFilter : SBSDKBaseAdjustableFilter

    Swift

    class SBSDKSpecialContrastFilter : SBSDKBaseAdjustableFilter
  • 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
  • A class describing one data field of a Swiss QR code.

    See more

    Declaration

    Objective-C

    @interface SBSDKSwissQRCodeDocumentField : NSObject

    Swift

    class SBSDKSwissQRCodeDocumentField : NSObject
  • The document format of a Swiss QR code.

    See more

    Declaration

    Objective-C

    @interface SBSDKSwissQRCodeDocumentFormat : SBSDKBarCodeScannerDocumentFormat

    Swift

    class SBSDKSwissQRCodeDocumentFormat : SBSDKBarCodeScannerDocumentFormat
  • 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
  • Adjusts the color temperature of an image.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKTextOrientationRecognizer : NSObject

    Swift

    class SBSDKTextOrientationRecognizer : NSObject
  • Adjusts the tint of an image.

    See more

    Declaration

    Objective-C

    @interface SBSDKTintAdjustFilter : SBSDKBaseAdjustableFilter

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeFilter : NSObject

    Swift

    class SBSDKUIBarcodeFilter : NSObject
  • Subclass of SBSDKUIBarcodeFilter that only accepts barcodes with extensions.

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeExtensionsFilter : SBSDKUIBarcodeFilter

    Swift

    class SBSDKUIBarcodeExtensionsFilter : SBSDKUIBarcodeFilter
  • A class to store and remove barcode images from SBSDKUIBarcodeScannerViewController.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeImageStorage : NSObject

    Swift

    class SBSDKUIBarcodeImageStorage : NSObject
  • Class that contains barcode name and description.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeMappedData : NSObject

    Swift

    class SBSDKUIBarcodeMappedData : NSObject
  • Class that contains barcode result and mapped data.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeMappedResult : NSObject

    Swift

    class SBSDKUIBarcodeMappedResult : NSObject
  • Configuration for the behavior of barcodes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIBarcodeScannerBehaviorConfiguration : 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 more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIBarcodeScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the detector screens for barcodes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIBarcodeScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for user interface of the detector screens for barcodes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIBarcodeScannerUIConfiguration : NSObject
  • A highly customizable camera-based view controller to detect QR and bar codes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIBarcodeScannerViewController : SBSDKUICameraViewController
  • The configuration object for a barcode selection overlay.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodeTrackingOverlayConfiguration : NSObject

    Swift

    class SBSDKUIBarcodeTrackingOverlayConfiguration : NSObject
  • Configuration for the behavior of barcodes.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodesBatchScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIBarcodesBatchScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the detector screens for barcodes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodesBatchScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIBarcodesBatchScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for user interface of the detector screens for barcodes.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodesBatchScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIBarcodesBatchScannerUIConfiguration : NSObject
  • A highly customizable camera-based view controller to detect barcodes batches.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIBarcodesBatchScannerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUIBarcodesBatchScannerViewController : SBSDKUICameraViewController
  • Configuration for the camera of all RTU-UI components.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICameraConfiguration : NSObject

    Swift

    class SBSDKUICameraConfiguration : NSObject
  • A SBSDKUIViewController subclass which adds support for enabled and disabled camera permission.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICameraViewController : SBSDKUIViewController

    Swift

    class SBSDKUICameraViewController : SBSDKUIViewController
  • Configuration for the behavior of the check scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICheckRecognizerBehaviorConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUICheckRecognizerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUICheckRecognizerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the check scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICheckRecognizerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUICheckRecognizerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the check scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICheckRecognizerUIConfiguration : NSObject

    Swift

    class SBSDKUICheckRecognizerUIConfiguration : NSObject
  • A Ready-To-Use viewcontroller to recognize checks using the camera.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICheckRecognizerViewController : SBSDKUICameraViewController

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIConfiguration : NSObject

    Swift

    class SBSDKUIConfiguration : NSObject
  • Configuration for the accessibility labels and hints.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenAccessibilityConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenAccessibilityConfiguration : NSObject
  • Configuration for the behavior of the cropping screen.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUICroppingScreenConfiguration : SBSDKUIConfiguration
  • Configuration for the textual content of the page cropping screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenTextConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenTextConfiguration : NSObject
  • Configuration for user interface of the page cropping screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingScreenUIConfiguration : NSObject

    Swift

    class SBSDKUICroppingScreenUIConfiguration : NSObject
  • A highly customizable view controller to edit a pages polygon or the page’s orientation.

    See more

    Declaration

    Objective-C

    @interface SBSDKUICroppingViewController : SBSDKUIViewController

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDialogButtonStyle : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDialogFactory : NSObject

    Swift

    class SBSDKUIDialogFactory : NSObject
  • The general style for a dialog in ScanbotSDK. Used to customize certain result dialogs in SBSDKUI components.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDialogStyle : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocument : NSObject <NSCopying>

    Swift

    class SBSDKUIDocument : NSObject, NSCopying
  • Configuration for the accessibility labels and hints.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerAccessibilityConfiguration : NSObject

    Swift

    class SBSDKUIDocumentScannerAccessibilityConfiguration : NSObject
  • Configuration 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 : SBSDKUIConfiguration

    Swift

    class SBSDKUIDocumentScannerConfiguration : SBSDKUIConfiguration
  • A snapshot of the current settings of an SBSDKUIDocumentScannerViewControllers instance. Can be used to persist and restore changes made by the user.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerSettings : NSObject

    Swift

    class SBSDKUIDocumentScannerSettings : NSObject
  • Configuration for the textual contents of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIDocumentScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerUIConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIDocumentScannerViewController : SBSDKUICameraViewController
  • The type of the document that should be recognized with SBSDKUIGenericDocumentRecognizerViewController. It is a composition of generic document types.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIDocumentType : NSObject

    Swift

    class SBSDKUIDocumentType : NSObject
  • Configuration for the textual contents of camera based view controllers.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIEnableCameraTextConfiguration : NSObject

    Swift

    class SBSDKUIEnableCameraTextConfiguration : NSObject
  • Configuration for the user interface of camera based view controllers.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIEnableCameraUIConfiguration : NSObject

    Swift

    class SBSDKUIEnableCameraUIConfiguration : NSObject
  • Configuration for the accessibility labels and hints.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIFinderDocumentScannerAccessibilityConfiguration : NSObject

    Swift

    class SBSDKUIFinderDocumentScannerAccessibilityConfiguration : NSObject
  • Configuration for the behavior of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIFinderDocumentScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIFinderDocumentScannerBehaviorConfiguration : 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 SBSDKUIFinderDocumentScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIFinderDocumentScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIFinderDocumentScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIFinderDocumentScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the document scanning screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIFinderDocumentScannerUIConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIFinderDocumentScannerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUIFinderDocumentScannerViewController : SBSDKUICameraViewController
  • Configuration for the behavior of the generic document recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIGenericDocumentRecognizerBehaviorConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIGenericDocumentRecognizerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIGenericDocumentRecognizerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the generic document recognizer screen.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIGenericDocumentRecognizerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIGenericDocumentRecognizerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the generic document recognizer screens.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIGenericDocumentRecognizerUIConfiguration : NSObject

    Swift

    class SBSDKUIGenericDocumentRecognizerUIConfiguration : NSObject
  • A highly customizable camera-based view controller to recognize generic documents.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIGenericDocumentRecognizerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUIGenericDocumentRecognizerViewController : SBSDKUICameraViewController
  • Configuration 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 : SBSDKUIConfiguration

    Swift

    class SBSDKUIHealthInsuranceCardScannerConfiguration : SBSDKUIConfiguration
  • Configuration 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
  • Configuration 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 cards.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIHealthInsuranceCardScannerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUIHealthInsuranceCardScannerViewController : SBSDKUICameraViewController
  • Configuration for the behavior of the license plate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUILicensePlateScannerBehaviorConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUILicensePlateScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUILicensePlateScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the license plate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUILicensePlateScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUILicensePlateScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface look and feel of the license plate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUILicensePlateScannerUIConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUILicensePlateScannerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUILicensePlateScannerViewController : SBSDKUICameraViewController
  • Configuration for the behavior of the machine readable zone scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerBehaviorConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIMRZScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the detector screens for machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIMRZScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for user interface of the detector screens for machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIMRZScannerUIConfiguration : NSObject
  • A highly customizable camera-based view controller to detect machine readable zones.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMRZScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUIMRZScannerViewController : SBSDKUICameraViewController
  • Configuration for the behavior of medical certificates scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMedicalCertificateScannerBehaviorConfiguration : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMedicalCertificateScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIMedicalCertificateScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the medical certificate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMedicalCertificateScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIMedicalCertificateScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the medical certificate scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMedicalCertificateScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIMedicalCertificateScannerUIConfiguration : NSObject
  • A Ready-To-Use viewcontroller to scan medical certificates.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIMedicalCertificateScannerViewController
        : SBSDKUICameraViewController

    Swift

    class SBSDKUIMedicalCertificateScannerViewController : SBSDKUICameraViewController
  • A class to render 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 <NSCopying>

    Swift

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

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

    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
  • Configuration for the behavior of text line recognizer.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUITextDataScannerConfiguration : SBSDKUIConfiguration
  • Defines a single workflow step of ‘SBSDKUITextDataScannerViewController’ flow.

    See more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerStep : NSObject

    Swift

    class SBSDKUITextDataScannerStep : NSObject
  • Encapsulates the result of the text recognition of a ‘SBSDKUITextDataScannerViewController’s workflow step.

    See more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerStepResult : NSObject

    Swift

    class SBSDKUITextDataScannerStepResult : NSObject
  • Configuration for the textual contents of the text line recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUITextDataScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the text line recognizer.

    See more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerUIConfiguration : NSObject

    Swift

    class SBSDKUITextDataScannerUIConfiguration : NSObject
  • A highly customizable camera-based view controller 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 more

    Declaration

    Objective-C

    @interface SBSDKUITextDataScannerViewController : SBSDKUICameraViewController

    Swift

    class SBSDKUITextDataScannerViewController : SBSDKUICameraViewController
  • Configuration for the behavior of vehicle identification number scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIVINScannerBehaviorConfiguration : NSObject

    Swift

    class SBSDKUIVINScannerBehaviorConfiguration : NSObject
  • This class describes the look and feel, the behavior and the textual contents of the detection screens for the vehicle identification number scanner. Use the ‘defaultConfiguration’ class method to retrieve an instance and modify it as needed.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIVINScannerConfiguration : SBSDKUIConfiguration

    Swift

    class SBSDKUIVINScannerConfiguration : SBSDKUIConfiguration
  • Configuration for the textual contents of the vehicle identification number scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIVINScannerTextConfiguration
        : SBSDKUIEnableCameraTextConfiguration

    Swift

    class SBSDKUIVINScannerTextConfiguration : SBSDKUIEnableCameraTextConfiguration
  • Configuration for the user interface of the vehicle identification number scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIVINScannerUIConfiguration : NSObject

    Swift

    class SBSDKUIVINScannerUIConfiguration : NSObject
  • A highly customizable camera-based view controller to scan and validate a vehicle identification number in realtime. A view finder like rectangle shows the area where the vehicle identification number is scanned. The camera is zoomed in and out automatically. Once some vehicle identification number is scanned within the view finder area the result is delivered to the receivers delegate.

    See more

    Declaration

    Objective-C

    @interface SBSDKUIVINScannerViewController : SBSDKUICameraViewController

    Swift

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

    See more

    Declaration

    Objective-C

    @interface SBSDKUIViewController : UIViewController

    Swift

    class SBSDKUIViewController : UIViewController
  • 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 UIViewController subclass to show a camera screen with the vehicle identification number scanner. A view finder like rectangle shows the area where vehicle identification number is detected. 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 number is detected 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 more

    Declaration

    Objective-C

    @interface SBSDKVINScannerViewController : SBSDKBaseScannerViewController

    Swift

    class SBSDKVINScannerViewController : SBSDKBaseScannerViewController
  • A class to scan video frame for vehicle identification number and validate it.

    See more

    Declaration

    Objective-C

    @interface SBSDKVehicleIdentificationNumberScanner : NSObject

    Swift

    class SBSDKVehicleIdentificationNumberScanner : NSObject
  • A descriptor-like class to configure an instance of SBSDKVehicleIdentificationNumberScanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKVehicleIdentificationNumberScannerConfiguration : NSObject

    Swift

    class SBSDKVehicleIdentificationNumberScannerConfiguration : NSObject
  • A class describing the result of the vehicle identification number scanner.

    See more

    Declaration

    Objective-C

    @interface SBSDKVehicleIdentificationNumberScannerResult : NSObject

    Swift

    class SBSDKVehicleIdentificationNumberScannerResult : NSObject
  • Adjusts the vibrance of an image. Vibrance makes colors more brilliant.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    @interface SBSDKWhiteAndBlackPointFilter : SBSDKBaseAdjustableFilter

    Swift

    class SBSDKWhiteAndBlackPointFilter : SBSDKBaseAdjustableFilter
  • Helper class to define a range for zooming.

    See more

    Declaration

    Objective-C

    @interface SBSDKZoomRange : NSObject

    Swift

    class SBSDKZoomRange : NSObject
  • A scrollable and zoomable UIScrollView subclass that displays images and an overlay view. Zooming and scrolling can be controlled using the standard UIScrollView properties.

    See more

    Declaration

    Objective-C

    @interface SBSDKZoomingImageScrollView : UIScrollView <UIScrollViewDelegate>

    Swift

    class SBSDKZoomingImageScrollView : UIScrollView, UIScrollViewDelegate
  • Main class of Scanbot SDK. Lets you install the license and allows basic configuration.

    See more

    Declaration

    Objective-C

    @interface Scanbot : NSObject

    Swift

    class Scanbot : NSObject
  • Helper class to configure properties of the ScanbotSDKUI (SBSDKUI) components.

    See more

    Declaration

    Objective-C

    @interface ScanbotUI : NSObject

    Swift

    class ScanbotUI : NSObject
  • Declaration

    Swift

    @objcMembers
    public class ScanbotSDKConfiguration : NSObject
  • Declaration

    Swift

    @objc
    public class SBSDKBarcodeResultsAccumulator : NSObject
  • A class that represents the style of the polygon rendered around a barcode in SBSDKBarcodeTrackingOverlayController.

    See more

    Declaration

    Swift

    @objcMembers
    public class SBSDKBarcodeTrackedViewPolygonStyle : NSObject
  • A class that represents the style and kind of the text rendered below a barcode in SBSDKBarcodeTrackingOverlayController.

    See more

    Declaration

    Swift

    @objcMembers
    public class SBSDKBarcodeTrackedViewTextStyle : NSObject
  • A class that represents the configuration options for a SBSDKBarcodeTrackingOverlayController. This overlay is used to visualize the detected barcodes on the screen. The class provides various customization options for the appearance and behavior of the overlay.

    See more

    Declaration

    Swift

    @objcMembers
    public class SBSDKBarcodeTrackingOverlayConfiguration : NSObject
  • A class that represents an overlay used for visualizing detected barcodes. It provides a customizable user interface for displaying barcodes and supports interaction with them. The overlay can be used to highlight and select barcodes based on user input.

    Note

    To use the barcode tracking overlay, you should set its configuration property to customize the appearance and behavior of the overlay.
    See more

    Declaration

    Swift

    @objcMembers
    public class SBSDKBarcodeTrackingOverlayController : NSObject
  • A class that represents the style of the polygon rendered around a barcode in SBSDKBarcodeScanAndCountViewController.

    See more

    Declaration

    Swift

    @objcMembers
    public class SBSDKScanAndCountPolygonStyle : NSObject
  • Declaration

    Swift

    @objc
    public class SBSDKPerformance : NSObject