Enumerations

The following enumerations are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKCameraSessionFlashStatus) {
        GSKCameraSessionFlashStatusAuto,
        GSKCameraSessionFlashStatusOn,
        GSKCameraSessionFlashStatusOff,
    }

    Swift

    enum GSKCameraSessionFlashStatus : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKCameraSessionError) {
        GSKCameraSessionErrorOther = -1,
        GSKCameraSessionErrorNotAuthorized = -2,
        GSKCameraSessionErrorLockDevice = -3,
        GSKCameraSessionErrorNoDevice = -4,
        GSKCameraSessionErrorInvalidSetupDependency = -5,
        GSKCameraSessionErrorNoVideoCaptureConnection = -6,
        GSKCameraSessionErrorInvalidData = -7,
        GSKCameraSessionErrorBadInput = -8,
    
        // Warnings
        GSKCameraSessionWarnLockDevice = -1003,
    }

    Swift

    enum GSKCameraSessionError : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKCameraSessionDocumentDetection) {
        GSKCameraSessionDocumentDetectionNone,
        GSKCameraSessionDocumentDetectionHighlight,
        GSKCameraSessionDocumentDetectionHighlightAndTrigger,
    }

    Swift

    enum GSKCameraSessionDocumentDetection : Int, @unchecked Sendable
  • Quadrangle detection options

    See more

    Declaration

    Objective-C

    enum GSKDetectQuadrangleOptions : NSInteger {}
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKError) {
        /// An license key related error.
        GSKLicenseError = 1000,
        /// An internal error. Please report it to sdk@geniusscan.com with output logs.
        GSKInternalError = 1001,
        /// An image processing error
        GSKProcessingError = 1002,
        /// A general error due to a bad input parameter. Verify that your input match the API requirements.
        GSKBadInputError = 1003,
        /// A file not found error
        GSKFileNotFound = 1004,
        /// A memory (not storage) error
        GSKMemoryError = 1005
    }
  • The different possible enhancements

    See more

    Declaration

    Objective-C

    enum GSKFilterType : NSInteger {}
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKLoggerSeverity)
    {
        /** The severity of a verbose message. Logging verbose messages can have a performance impact. */
        GSKLoggerSeverityVerboseLevel,
        /** The severity of a debug message. Logging debug messages can have a performance impact. Debug messages shouldn't be used in production. */
        GSKLoggerSeverityDebugLevel,
        /** The severity of informative messages. */
        GSKLoggerSeverityInfoLevel,
        /** The severity of warning messages. */
        GSKLoggerSeverityWarnLevel,
        /** The severity of error messages. */
        GSKLoggerSeverityErrorLevel,
    }

    Swift

    enum GSKLoggerSeverity : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKMagnifierViewCenterStyle) {
        GSKMagnifierViewCenterStyleCrosshair,
        GSKMagnifierViewCenterStyleQuadrangle
    }

    Swift

    enum GSKMagnifierViewCenterStyle : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKPDFGeneratorError)
    {
        GSKPDFGeneratorErrorSuccess,
        GSKPDFGeneratorErrorInternal,
        GSKPDFGeneratorErrorFileNotFound,
        GSKPDFGeneratorErrorInvalidPassword,
        GSKPDFGeneratorErrorInvalidPageSize,
        GSKPDFGeneratorErrorProcessorError,
        GSKPDFGeneratorErrorCodeInvalidInput,
    }

    Swift

    enum GSKPDFGeneratorError : Int, @unchecked Sendable
  • Defines an image rotation by increment of 90 degrees.

    See more

    Declaration

    Objective-C

    enum GSKRotation : NSInteger {}

    Swift

    enum GSKRotation : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKTextLayoutToTextConverterStatus)
    {
        GSKTextLayoutToTextConverterStatusSuccess,
        GSKTextLayoutToTextConverterStatusInvalidHOCRError,
        GSKTextLayoutToTextConverterStatusInternalError,
    }

    Swift

    enum GSKTextLayoutToTextConverterStatus : Int, @unchecked Sendable
  • Rotation direction for gsk_rotate:

    See more

    Declaration

    Objective-C

    enum GSKRotationDirection : NSUInteger {}

    Swift

    enum GSKRotationDirection : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, GSKScanFlowError) {
        /// User has canceled the scan flow
        GSKScanFlowUserCancelationError = 999,
        /// A general error due to a bad input parameter. Verify that your input match the API requirements.
        GSKScanFlowBadInputError = 1000,
    }

    Swift

    enum GSKScanFlowError : Int, @unchecked Sendable
  • The various formats into which the OCR result can be made available.

    This is an option set so you can combine multiple formats.

    See more

    Declaration

    Objective-C

    enum GSKScanFlowOCROutputFormats : NSUInteger {}

    Swift

    struct GSKScanFlowOCROutputFormats : OptionSet, @unchecked Sendable
  • The source for a scan flow

    See more

    Declaration

    Objective-C

    enum GSKScanFlowSource : NSUInteger {}

    Swift

    enum GSKScanFlowSource : UInt, @unchecked Sendable
  • The different possible filters for the scanner UI.

    The possible values match the GSKFilterType values except “automatic”.

    See more

    Declaration

    Objective-C

    enum GSKScanFlowFilterType : NSInteger {}

    Swift

    enum GSKScanFlowFilterType : Int, @unchecked Sendable
  • The various image processing actions available in the post-processing screen.

    This is an option set so you can combine multiple actions.

    See more

    Declaration

    Objective-C

    enum GSKScanFlowPostProcessingActions : NSUInteger {}

    Swift

    struct GSKScanFlowPostProcessingActions : OptionSet, @unchecked Sendable
  • The generated PDF paper size.

    See more

    Declaration

    Objective-C

    enum GSKScanFlowPDFPageSize : NSUInteger {}

    Swift

    enum GSKScanFlowPDFPageSize : UInt, @unchecked Sendable
  • The capture screen flash mode

    See more

    Declaration

    Objective-C

    enum GSKScanFlowFlashMode : NSUInteger {}

    Swift

    enum GSKScanFlowFlashMode : UInt, @unchecked Sendable
  • The format of the exported document.

    See more

    Declaration

    Objective-C

    enum GSKScanFlowMultiPageFormat : NSUInteger {}

    Swift

    enum GSKScanFlowMultiPageFormat : UInt, @unchecked Sendable