Enumerations
The following enumerations are available globally.
-
Known values for AAMVA fields.
See moreDeclaration
Objective-C
enum SBSDKAAMVARecordFieldType : NSInteger {}
Swift
enum SBSDKAAMVARecordFieldType : Int, @unchecked Sendable
-
An enum containing the available encryption modes for the SBSDKAESEncrypter.
See moreDeclaration
Objective-C
enum SBSDKAESEncrypterMode : NSUInteger {}
Swift
enum SBSDKAESEncrypterMode : UInt, @unchecked Sendable
-
The Auto-snapping mode handles different auto-snap scenarios.
See moreDeclaration
Objective-C
enum SBSDKAutosnappingMode : NSUInteger {}
Swift
enum SBSDKAutosnappingMode : UInt, @unchecked Sendable
-
The checksum algorithm for MSI-Plessey type barcodes.
See moreDeclaration
Objective-C
enum SBSDKBarcodeMSIPlesseyChecksumAlgorithm : NSInteger {}
Swift
enum SBSDKBarcodeMSIPlesseyChecksumAlgorithm : Int, @unchecked Sendable
-
The expected density of QR codes. A higher density finds more QR codes in an image but the performance is slightly reduced.
See moreDeclaration
Objective-C
enum SBSDKBarcodeDensity : NSInteger {}
Swift
enum SBSDKBarcodeDensity : Int, @unchecked Sendable
-
The type of barcode image generation.
See moreDeclaration
Objective-C
enum SBSDKBarcodeImageGenerationType : NSUInteger {}
-
The barcode text format overlay.
See moreDeclaration
Objective-C
enum SBSDKBarcodeOverlayFormat : NSInteger {}
-
The engine mode of the barcode recognizer.
See moreDeclaration
Objective-C
enum SBSDKBarcodeEngineMode : NSUInteger {}
Swift
enum SBSDKBarcodeEngineMode : UInt, @unchecked Sendable
-
An enum describing the various modes used to apply an adjustable filter.
See moreDeclaration
Objective-C
enum SBSDKFilterMethod : NSInteger {}
Swift
enum SBSDKFilterMethod : Int, @unchecked Sendable
-
Boarding pass field types,
See moreDeclaration
Objective-C
enum SBSDKBoardingPassDocumentFieldType : NSInteger {}
Swift
enum SBSDKBoardingPassDocumentFieldType : Int, @unchecked Sendable
-
Enum for camera device positions.
See moreDeclaration
Objective-C
enum SBSDKCameraDevicePosition : NSUInteger {}
Swift
enum SBSDKCameraDevicePosition : UInt, @unchecked Sendable
-
Enum for camera device types.
See moreDeclaration
Objective-C
enum SBSDKCameraDeviceType : NSUInteger {}
Swift
enum SBSDKCameraDeviceType : UInt, @unchecked Sendable
-
The priorization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0.
See moreDeclaration
Objective-C
enum SBSDKCapturePhotoQualityPrioritization : NSUInteger {}
Swift
enum SBSDKCapturePhotoQualityPrioritization : UInt, @unchecked Sendable
-
An enum describing the status of a check recognition.
See moreDeclaration
Objective-C
enum SBSDKCheckRecognitionResultStatus : NSUInteger {}
Swift
enum SBSDKCheckRecognitionResultStatus : UInt, @unchecked Sendable
-
The live recognition state of the check recognizer.
See moreDeclaration
Objective-C
enum SBSDKCheckRecognizerState : NSUInteger {}
Swift
enum SBSDKCheckRecognizerState : UInt, @unchecked Sendable
-
The status of the latest document detection.
See moreDeclaration
Objective-C
enum SBSDKDocumentDetectionStatus : int {}
Swift
struct SBSDKDocumentDetectionStatus : Equatable, RawRepresentable
-
The mode of the document detector: standard or machine-learning-based.
See moreDeclaration
Objective-C
enum SBSDKDocumentDetectorMode : NSInteger {}
Swift
enum SBSDKDocumentDetectorMode : Int, @unchecked Sendable
-
A GS1 document field validation status.
See moreDeclaration
Objective-C
enum SBSDKGS1SystemElementValidationStatus : NSInteger {}
Swift
enum SBSDKGS1SystemElementValidationStatus : Int, @unchecked Sendable
-
The fields validation status. Applicable only to fields that support some kind of validation, e.g. using check digits.
See moreDeclaration
Objective-C
enum SBSDKGenericDocumentFieldValidationStatus : NSUInteger {}
Swift
enum SBSDKGenericDocumentFieldValidationStatus : UInt, @unchecked Sendable
-
Common field types
See moreDeclaration
Objective-C
enum SBSDKGenericDocumentCommonFieldType : NSUInteger {}
Swift
enum SBSDKGenericDocumentCommonFieldType : UInt, @unchecked Sendable
-
The status of the generic document recognition.
See moreDeclaration
Objective-C
enum SBSDKGenericDocumentRecognitionStatus : NSUInteger {}
Swift
enum SBSDKGenericDocumentRecognitionStatus : UInt, @unchecked Sendable
-
Strategies for the generic text line recognizer.
See moreDeclaration
Objective-C
enum SBSDKTextFilterStrategy : NSInteger {}
Swift
enum SBSDKTextFilterStrategy : Int, @unchecked Sendable
-
EHIC field type.
See moreDeclaration
Objective-C
enum SBSDKHealthInsuranceCardFieldType : NSUInteger {}
Swift
enum SBSDKHealthInsuranceCardFieldType : UInt, @unchecked Sendable
-
EHIC detection status.
See moreDeclaration
Objective-C
enum SBSDKHealthInsuranceCardDetectionStatus : NSUInteger {}
Swift
enum SBSDKHealthInsuranceCardDetectionStatus : UInt, @unchecked Sendable
-
ID card field types
See moreDeclaration
Objective-C
enum SBSDKIDCardPDF417DocumentFieldType : NSInteger {}
Swift
enum SBSDKIDCardPDF417DocumentFieldType : Int, @unchecked Sendable
-
Enumeration of supported image file types.
See moreDeclaration
Objective-C
enum SBSDKImageFileFormat : NSInteger {}
-
The ScanbotSDK image filter types.
See moreDeclaration
Objective-C
enum SBSDKImageFilterType : int {}
Swift
struct SBSDKImageFilterType : Equatable, RawRepresentable
-
The strategy being used to scan a license plate.
See moreDeclaration
Objective-C
enum SBSDKLicensePlateScannerStrategy : NSInteger {}
Swift
enum SBSDKLicensePlateScannerStrategy : Int, @unchecked Sendable
-
Type classifiers for machine-readable-zone fields.
See moreDeclaration
Objective-C
enum SBSDKMachineReadableZoneRecognizerFieldName : NSUInteger {}
Swift
enum SBSDKMachineReadableZoneRecognizerFieldName : UInt, @unchecked Sendable
-
Type classifier for machine-readable-zone document types.
See moreDeclaration
Objective-C
enum SBSDKMachineReadableZoneRecognizerResultDocumentType : NSInteger {}
Swift
enum SBSDKMachineReadableZoneRecognizerResultDocumentType : Int, @unchecked Sendable
-
MRZ checkdigit types.
See moreDeclaration
Objective-C
enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType : NSUInteger {}
Swift
enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType : UInt, @unchecked Sendable
-
Medical certificate document field types.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateDocumentFieldType : NSInteger {}
Swift
enum SBSDKMedicalCertificateDocumentFieldType : Int, @unchecked Sendable
-
Type classifiers for checkboxes recognized on medical certificates.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateRecognizerCheckboxType : NSUInteger {}
Swift
enum SBSDKMedicalCertificateRecognizerCheckboxType : UInt, @unchecked Sendable
-
Type classifiers for dates recognized on medical certificates.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateRecognizerDateResultType : NSUInteger {}
Swift
enum SBSDKMedicalCertificateRecognizerDateResultType : UInt, @unchecked Sendable
-
The form type of a recognized medical certificate.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateRecognizerFormType : NSInteger {}
Swift
enum SBSDKMedicalCertificateRecognizerFormType : Int, @unchecked Sendable
-
The various types of fields inside the patient information field of a medical certificate.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateRecognizerResultPatientFieldType : NSInteger {}
Swift
enum SBSDKMedicalCertificateRecognizerResultPatientFieldType : Int, @unchecked Sendable
-
The live recognition state of the medical certificate scanner.
See moreDeclaration
Objective-C
enum SBSDKMedicalCertificateScannerState : NSUInteger {}
Swift
enum SBSDKMedicalCertificateScannerState : UInt, @unchecked Sendable
-
German medical plan document subheading prescription information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanSubheadingPrescriptionFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanSubheadingPrescriptionFieldType : Int, @unchecked Sendable
-
German medical plan document medicine substance information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanMedicineSubstanceFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanMedicineSubstanceFieldType : Int, @unchecked Sendable
-
German medical plan document medicine information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanMedicineFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanMedicineFieldType : Int, @unchecked Sendable
-
German medical plan document subheading information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanStandardSubheadingFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanStandardSubheadingFieldType : Int, @unchecked Sendable
-
German medical plan document doctor information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanDoctorFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanDoctorFieldType : Int, @unchecked Sendable
-
German medical plan document patient information description field type.
See moreDeclaration
Objective-C
enum SBSDKMedicalPlanPatientFieldType : NSInteger {}
Swift
enum SBSDKMedicalPlanPatientFieldType : Int, @unchecked Sendable
-
Types of passport reader errors.
See moreDeclaration
Objective-C
enum SBSDKNFCPassportReaderError : NSUInteger {}
-
When an OCR operation finishes it returns an array of result blocks containing e.g. the position and type of recognized text. Each of the result blocks has a specific type.
See moreDeclaration
Objective-C
enum SBSDKOCRResultBlockType : NSUInteger {}
Swift
enum SBSDKOCRResultBlockType : UInt, @unchecked Sendable
-
This enum describes the available orientation lock modes for the user interface. Captured images are always top-oriented to the status bar.
See moreDeclaration
Objective-C
enum SBSDKOrientationLock : NSInteger {}
Swift
enum SBSDKOrientationLock : Int, @unchecked Sendable
-
Specifies the desired page size (media box size) for PDF rendering operations.
See moreDeclaration
Objective-C
enum SBSDKPDFRendererPageSize : NSUInteger {}
Swift
enum SBSDKPDFRendererPageSize : UInt, @unchecked Sendable
-
Part of the page layout analysis result. Describes the detected orientation of the text.
See moreDeclaration
Objective-C
enum SBSDKPageOrientation : NSUInteger {}
Swift
enum SBSDKPageOrientation : UInt, @unchecked Sendable
-
Part of the page layout analysis result. Describes the reading direction of the text independently from the orientation. Note: Experimental - this is currently not always working correctly for top-to-bottom text.
See moreDeclaration
Objective-C
enum SBSDKWritingDirection : NSUInteger {}
Swift
enum SBSDKWritingDirection : UInt, @unchecked Sendable
-
Part of the page layout analysis result. Describes the order of columns in top-to-bottom writing direction resp. of rows in left-right and right-left direction.
See moreDeclaration
Objective-C
enum SBSDKTextlineOrder : NSUInteger {}
Swift
enum SBSDKTextlineOrder : UInt, @unchecked Sendable
-
The source from where the image of the page originated from.
See moreDeclaration
Objective-C
enum SBSDKPageImageSource : NSInteger {}
-
An enumeration describing the recognition mode of the scanner.
See moreDeclaration
Objective-C
enum SBSDKPayFormScannerRecognitionMode : NSInteger {}
Swift
enum SBSDKPayFormScannerRecognitionMode : Int, @unchecked Sendable
-
An enumeration describing the types of tokens the SBSDKPayFormScanner can detect and recognize.
See moreDeclaration
Objective-C
enum SBSDKPayFormTokenType : NSInteger {}
Swift
enum SBSDKPayFormTokenType : Int, @unchecked Sendable
-
An enum describing the orientation of a polygon edge.
See moreDeclaration
Objective-C
enum SBSDKPolygonEdgeOrientation : NSUInteger {}
Swift
enum SBSDKPolygonEdgeOrientation : UInt, @unchecked Sendable
-
An enumeration that represents resource type.
See moreDeclaration
Objective-C
enum SBSDKResourceType : NSUInteger {}
Swift
enum SBSDKResourceType : UInt, @unchecked Sendable
-
SEPA document field types,
See moreDeclaration
Objective-C
enum SBSDKSEPADocumentFieldType : NSInteger {}
Swift
enum SBSDKSEPADocumentFieldType : Int, @unchecked Sendable
-
The error codes in the SBSDKErrorDomain.
See moreDeclaration
Objective-C
enum SBSDKErrorCode : NSInteger {}
Swift
enum SBSDKErrorCode : Int, @unchecked Sendable
-
Enum describing the image color mode of output images.
See moreDeclaration
Objective-C
enum SBSDKImageMode : NSInteger {}
Swift
enum SBSDKImageMode : Int, @unchecked Sendable
-
This enum describes the possible scanning states of an
See moreSBSDKScannerViewController
.Declaration
Objective-C
enum SBSDKScannerStatus : NSInteger {}
Swift
enum SBSDKScannerStatus : Int, @unchecked Sendable
-
This enum describes the possible modes of the cameras shutter. Automatic shutter means, a photo is taken automatically if a document was detected in the video stream. The smart mode is the default mode. Whenever the automatic shutter is toggled the delegate of SBSDKScannerViewController is informed. You can also the query the autoShutterEnabled property. The default shutter button reflects this mode.
See moreDeclaration
Objective-C
enum SBSDKShutterMode : NSInteger {}
Swift
enum SBSDKShutterMode : Int, @unchecked Sendable
-
This enum describes the possible modes of the view finder during scanning.
See moreDeclaration
Objective-C
enum SBSDKFinderMode : NSInteger {}
Swift
enum SBSDKFinderMode : Int, @unchecked Sendable
-
The version number of the Swiss QR code.
See moreDeclaration
Objective-C
enum SBSDKSwissQRCodeVersion : NSInteger {}
Swift
enum SBSDKSwissQRCodeVersion : Int, @unchecked Sendable
-
The type of one Swiss QR code field.
See moreDeclaration
Objective-C
enum SBSDKSwissQRCodeFieldType : NSInteger {}
Swift
enum SBSDKSwissQRCodeFieldType : Int, @unchecked Sendable
-
TIFF Compression algorithms
See moreDeclaration
Objective-C
enum SBSDKTIFFImageWriterCompressionOptions : int {}
Swift
enum SBSDKTIFFImageWriterCompressionOptions : Int32, @unchecked Sendable
-
Custom TIFF field type.
See moreDeclaration
Objective-C
enum SBSDKTIFFImageWriterUserDefinedFieldType : int {}
Swift
enum SBSDKTIFFImageWriterUserDefinedFieldType : Int32, @unchecked Sendable
-
The ScanbotSDK text orientation types.
See moreDeclaration
Objective-C
enum SBSDKTextOrientation : NSInteger {}
Swift
enum SBSDKTextOrientation : Int, @unchecked Sendable
-
Enumeration of image type classifiers. *
See moreDeclaration
Objective-C
enum SBSDKUIPageFileType : NSInteger {}
-
vCard document field type.
See moreDeclaration
Objective-C
enum SBSDKVCardDocumentFieldType : NSInteger {}
Swift
enum SBSDKVCardDocumentFieldType : Int, @unchecked Sendable
-
Enumeration of video preview content mode.
See moreDeclaration
Objective-C
enum SBSDKVideoContentMode : NSInteger {}