Enumerations

The following enumerations are available globally.

  • Known values for AAMVA fields.

    See more

    Declaration

    Objective-C

    enum SBSDKAAMVARecordFieldType : NSInteger {}

    Swift

    enum SBSDKAAMVARecordFieldType : Int

  • An enum containing the available encryption modes for the SBSDKAESEncrypter.

    See more

    Declaration

    Objective-C

    enum SBSDKAESEncrypterMode : NSUInteger {}

    Swift

    enum SBSDKAESEncrypterMode : UInt

  • The checksum algorithm for MSI-Plessey type barcodes.

    See more

    Declaration

    Objective-C

    enum SBSDKBarcodeMSIPlesseyChecksumAlgorithm : NSInteger {}

    Swift

    enum SBSDKBarcodeMSIPlesseyChecksumAlgorithm : Int

  • The type of barcode image generation.

    See more

    Declaration

    Objective-C

    enum SBSDKBarcodeImageGenerationType : NSUInteger {}

  • The engine mode of the barcode recognizer.

    See more

    Declaration

    Objective-C

    enum SBSDKBarcodeEngineMode : NSUInteger {}

    Swift

    enum SBSDKBarcodeEngineMode : UInt

  • An enum describing the various modes used to apply an adjustable filter.

    See more

    Declaration

    Objective-C

    enum SBSDKFilterMethod : NSInteger {}

    Swift

    enum SBSDKFilterMethod : Int

  • Boarding pass field types,

    See more

    Declaration

    Objective-C

    enum SBSDKBoardingPassDocumentFieldType : NSInteger {}

    Swift

    enum SBSDKBoardingPassDocumentFieldType : Int

  • Enum for camera device positions.

    See more

    Declaration

    Objective-C

    enum SBSDKCameraDevicePosition : NSUInteger {}

    Swift

    enum SBSDKCameraDevicePosition : UInt

  • Enum for camera device types.

    See more

    Declaration

    Objective-C

    enum SBSDKCameraDeviceType : NSUInteger {}

    Swift

    enum SBSDKCameraDeviceType : UInt

  • The priorization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0.

    See more

    Declaration

    Objective-C

    enum SBSDKCapturePhotoQualityPrioritization : NSUInteger {}

    Swift

    enum SBSDKCapturePhotoQualityPrioritization : UInt

  • DC document field types.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificateDocumentFieldType : NSInteger {}

    Swift

    enum SBSDKDisabilityCertificateDocumentFieldType : Int

  • Type classifiers for checkboxes recognized on disability certificates.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificateRecognizerCheckboxType : NSUInteger {}

    Swift

    enum SBSDKDisabilityCertificateRecognizerCheckboxType : UInt

  • Type classifiers for dates recognized on disability certificates.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificatesRecognizerDateResultType : NSUInteger {}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerDateResultType : UInt

  • The form type of a recognized disability certificate.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificatesRecognizerFormType : NSInteger {}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerFormType : Int

  • The various types of fields inside the patient information field of a disability certificate.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificatesRecognizerResultPatientFieldType : NSInteger {}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerResultPatientFieldType : Int

  • The status of the latest document detection.

    See more

    Declaration

    Objective-C

    enum SBSDKDocumentDetectionStatus : int {}

    Swift

    struct SBSDKDocumentDetectionStatus : Equatable, RawRepresentable

  • The mode of the document detector: standard or machine-learning-based.

    See more

    Declaration

    Objective-C

    enum SBSDKDocumentDetectorMode : NSInteger {}

    Swift

    enum SBSDKDocumentDetectorMode : Int

  • The fields validation status. Applicable only to fields that support some kind of validation, e.g. using check digits.

    See more

    Declaration

    Objective-C

    enum SBSDKGenericDocumentFieldValidationStatus : NSUInteger {}

    Swift

    enum SBSDKGenericDocumentFieldValidationStatus : UInt

  • Common field types

    See more

    Declaration

    Objective-C

    enum SBSDKGenericDocumentCommonFieldType : NSUInteger {}

    Swift

    enum SBSDKGenericDocumentCommonFieldType : UInt

  • The status of the generic document recognition.

    See more

    Declaration

    Objective-C

    enum SBSDKGenericDocumentRecognitionStatus : NSUInteger {}

    Swift

    enum SBSDKGenericDocumentRecognitionStatus : UInt

  • Strategies for the generic text line recognizer.

    See more

    Declaration

    Objective-C

    enum SBSDKTextFilterStrategy : NSInteger {}

    Swift

    enum SBSDKTextFilterStrategy : Int

  • EHIC field type.

    See more

    Declaration

    Objective-C

    enum SBSDKHealthInsuranceCardFieldType : NSUInteger {}

    Swift

    enum SBSDKHealthInsuranceCardFieldType : UInt

  • EHIC detection status.

    See more

    Declaration

    Objective-C

    enum SBSDKHealthInsuranceCardDetectionStatus : NSUInteger {}

    Swift

    enum SBSDKHealthInsuranceCardDetectionStatus : UInt

  • ID card field types

    See more

    Declaration

    Objective-C

    enum SBSDKIDCardPDF417DocumentFieldType : NSInteger {}

    Swift

    enum SBSDKIDCardPDF417DocumentFieldType : Int

  • The type of an ID cards data field.

    See more

    Declaration

    Objective-C

    enum SBSDKIDCardFieldType : NSUInteger {}

    Swift

    enum SBSDKIDCardFieldType : UInt

  • The status of the recognition.

    See more

    Declaration

    Objective-C

    enum SBSDKIDCardRecognitionStatus : NSUInteger {}

    Swift

    enum SBSDKIDCardRecognitionStatus : UInt

  • Enumeration of supported image file types.

    See more

    Declaration

    Objective-C

    enum SBSDKImageFileFormat : NSInteger {}

  • The ScanbotSDK image filter types.

    See more

    Declaration

    Objective-C

    enum SBSDKImageFilterType : int {}

    Swift

    struct SBSDKImageFilterType : Equatable, RawRepresentable

  • The strategy being used to scan a license plate.

    See more

    Declaration

    Objective-C

    enum SBSDKLicensePlateScannerStrategy : NSInteger {}

    Swift

    enum SBSDKLicensePlateScannerStrategy : Int

  • Type classifiers for machine-readable-zone fields.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerFieldName : NSUInteger {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerFieldName : UInt

  • Type classifier for machine-readable-zone document types.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerResultDocumentType : NSInteger {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerResultDocumentType : Int

  • MRZ checkdigit types.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType : NSUInteger {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType : UInt

  • German medical plan document subheading prescription information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanSubheadingPrescriptionFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanSubheadingPrescriptionFieldType : Int

  • German medical plan document medicine substance information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanMedicineSubstanceFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanMedicineSubstanceFieldType : Int

  • German medical plan document medicine information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanMedicineFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanMedicineFieldType : Int

  • German medical plan document subheading information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanStandardSubheadingFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanStandardSubheadingFieldType : Int

  • German medical plan document doctor information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanDoctorFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanDoctorFieldType : Int

  • German medical plan document patient information description field type.

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanPatientFieldType : NSInteger {}

    Swift

    enum SBSDKMedicalPlanPatientFieldType : Int

  • Types of passport reader errors.

    See more

    Declaration

    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 more

    Declaration

    Objective-C

    enum SBSDKOCRResultBlockType : NSUInteger {}

    Swift

    enum SBSDKOCRResultBlockType : UInt

  • This enum describes the available orientation lock modes for image capturing. All modes work independently from the user interface orientation.

    See more

    Declaration

    Objective-C

    enum SBSDKOrientationLock : NSInteger {}

  • Specifies the desired page size (media box size) for PDF rendering operations.

    See more

    Declaration

    Objective-C

    enum SBSDKPDFRendererPageSize : NSUInteger {}

    Swift

    enum SBSDKPDFRendererPageSize : UInt

  • Part of the page layout analysis result. Describes the detected orientation of the text.

    See more

    Declaration

    Objective-C

    enum SBSDKPageOrientation : NSUInteger {}

    Swift

    enum SBSDKPageOrientation : UInt

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

    Declaration

    Objective-C

    enum SBSDKWritingDirection : NSUInteger {}

    Swift

    enum SBSDKWritingDirection : UInt

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

    Declaration

    Objective-C

    enum SBSDKTextlineOrder : NSUInteger {}

    Swift

    enum SBSDKTextlineOrder : UInt

  • The source from where the image of the page originated from.

    See more

    Declaration

    Objective-C

    enum SBSDKPageImageSource : NSInteger {}

SBSDKPayFormScannerRecognitionMode

  • An enumeration describing the recognition mode of the scanner.

    See more

    Declaration

    Objective-C

    enum SBSDKPayFormScannerRecognitionMode : NSInteger {}

    Swift

    enum SBSDKPayFormScannerRecognitionMode : Int

SBSDKPayFormTokenType

  • An enumeration describing the types of tokens the SBSDKPayFormScanner can detect and recognize.

    See more

    Declaration

    Objective-C

    enum SBSDKPayFormTokenType : NSInteger {}

    Swift

    enum SBSDKPayFormTokenType : Int

  • An enum describing the orientation of a polygon edge.

    See more

    Declaration

    Objective-C

    enum SBSDKPolygonEdgeOrientation : NSUInteger {}

    Swift

    enum SBSDKPolygonEdgeOrientation : UInt

  • An enumeration that represents resource type.

    See more

    Declaration

    Objective-C

    enum SBSDKResourceType : NSUInteger {}

    Swift

    enum SBSDKResourceType : UInt

  • SEPA document field types,

    See more

    Declaration

    Objective-C

    enum SBSDKSEPADocumentFieldType : NSInteger {}

    Swift

    enum SBSDKSEPADocumentFieldType : Int

  • The error codes in the SBSDKErrorDomain.

    See more

    Declaration

    Objective-C

    enum SBSDKErrorCode : NSInteger {}

    Swift

    enum SBSDKErrorCode : Int

  • Enum describing the image color mode of output images.

    See more

    Declaration

    Objective-C

    enum SBSDKImageMode : NSInteger {}

    Swift

    enum SBSDKImageMode : Int

  • This enum describes the possible scanning states of an SBSDKScannerViewController.

    See more

    Declaration

    Objective-C

    enum SBSDKScannerStatus : NSInteger {}

    Swift

    enum SBSDKScannerStatus : Int

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

    Declaration

    Objective-C

    enum SBSDKShutterMode : NSInteger {}

    Swift

    enum SBSDKShutterMode : Int

  • This enum describes the possible modes of the view finder during scanning.

    See more

    Declaration

    Objective-C

    enum SBSDKFinderMode : NSInteger {}

    Swift

    enum SBSDKFinderMode : Int

  • The version number of the Swiss QR code.

    See more

    Declaration

    Objective-C

    enum SBSDKSwissQRCodeVersion : NSInteger {}

    Swift

    enum SBSDKSwissQRCodeVersion : Int

  • The type of one Swiss QR code field.

    See more

    Declaration

    Objective-C

    enum SBSDKSwissQRCodeFieldType : NSInteger {}

    Swift

    enum SBSDKSwissQRCodeFieldType : Int

  • TIFF Compression algorithms

    See more

    Declaration

    Objective-C

    enum SBSDKTIFFImageWriterCompressionOptions : int {}

    Swift

    enum SBSDKTIFFImageWriterCompressionOptions : Int32

  • Custom TIFF field type.

    See more

    Declaration

    Objective-C

    enum SBSDKTIFFImageWriterUserDefinedFieldType : int {}

    Swift

    enum SBSDKTIFFImageWriterUserDefinedFieldType : Int32

  • The ScanbotSDK text orientation types.

    See more

    Declaration

    Objective-C

    enum SBSDKTextOrientation : NSInteger {}

    Swift

    enum SBSDKTextOrientation : Int

  • Enumeration of image type classifiers. *

    See more

    Declaration

    Objective-C

    enum SBSDKUIPageFileType : NSInteger {}

  • Enumeration of video preview content mode.

    See more

    Declaration

    Objective-C

    enum SBSDKUIVideoContentMode : NSInteger {}

  • vCard document field type.

    See more

    Declaration

    Objective-C

    enum SBSDKVCardDocumentFieldType : NSInteger {}

    Swift

    enum SBSDKVCardDocumentFieldType : Int