Constants
The following constants are available globally.
-
Key of ADF simplex input source capabilities. The value is represented by NSDictionary with source capabilities. May be absent if scanner does not support ADF simplex.
Declaration
Objective-C
extern const SKScannerCapabilityName _Nonnull SKScannerCapabilityNameADFSimplex
Swift
static let adfSimplex: SKScannerCapabilityName
-
Key of ADF duplex input source capabilities. The value is represented by NSDictionary with source capabilities. May be absent if scanner does not support ADF duplex.
Declaration
Objective-C
extern const SKScannerCapabilityName _Nonnull SKScannerCapabilityNameADFDuplex
Swift
static let adfDuplex: SKScannerCapabilityName
-
Key of Platen input source capabilities. The value is represented by NSDictionary with source capabilities. May be absent if scanner does not support Platen.
Declaration
Objective-C
extern const SKScannerCapabilityName _Nonnull SKScannerCapabilityNamePlaten
Swift
static let platen: SKScannerCapabilityName
-
Key of Camera input source capabilities. The value is represented by NSDictionary with source capabilities. May be absent if scanner does not support Camera.
Declaration
Objective-C
extern const SKScannerCapabilityName _Nonnull SKScannerCapabilityNameCamera
Swift
static let camera: SKScannerCapabilityName
-
SKResolutions object that represents resolutions supported by input source
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameResolutions
Swift
static let resolutions: SKSourceCapabilityName
-
Array of formats that are supported by an input source. The formats are represented by NSNumber containing SKDocumentFormat enum value.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameFormats
Swift
static let formats: SKSourceCapabilityName
-
Array of intents that are supported by an input source. The intents are represented by NSNumber containing SKIntent enum value.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameIntents
Swift
static let intents: SKSourceCapabilityName
-
Array of content types that are supported by an input source. The content types are represented by NSNumber containing SKContentType enum value.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameContentTypes
Swift
static let contentTypes: SKSourceCapabilityName
-
Array of color modes that are supported by input source. The color modes are represented by NSNumber containing SKColorMode enum value.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameColorModes
Swift
static let colorModes: SKSourceCapabilityName
-
Minimal size of scan area. The value is NSDictionary that represents CGSize. The size is defined in 1/300th of an inch points.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameMinScanArea
Swift
static let minScanArea: SKSourceCapabilityName
-
Maximal size of scan area. The value is NSDictionary that represents CGSize. The size is defined in 1/300th of an inch points.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameMaxScanArea
Swift
static let maxScanArea: SKSourceCapabilityName
-
Maximal number of scan areas that can be scanned simultaneously. The value is represented by NSNumber.
Declaration
Objective-C
extern const SKSourceCapabilityName _Nonnull SKSourceCapabilityNameMaxScanAreasNumber
Swift
static let maxScanAreasNumber: SKSourceCapabilityName
-
Default time interval for retrieving device status. The value is 2 seconds.
Declaration
Objective-C
extern const NSTimeInterval kSKDeviceStatusMonitoringDefaultInterval
Swift
let kSKDeviceStatusMonitoringDefaultInterval: TimeInterval
-
Scanner error codes domain
Declaration
Objective-C
extern NSString *const kSKScanningErrorDomain
Swift
let kSKScanningErrorDomain: String
-
Fetching capabilities error codes domain
Declaration
Objective-C
extern NSString *const kSKFetchingCapabilitiesErrorDomain
Swift
let kSKFetchingCapabilitiesErrorDomain: String
-
Scan ticket validation error codes domain
Declaration
Objective-C
extern NSString *const kSKScanTicketValidationErrorDomain
Swift
let kSKScanTicketValidationErrorDomain: String
-
Scanner status error codes domain
Declaration
Objective-C
extern NSString *const kSKDeviceStatusErrorDomain
Swift
let kSKDeviceStatusErrorDomain: String
-
The key of array that contains the names of invalid scan settings
Declaration
Objective-C
extern NSString *const kSKIncorrectSettingNamesKey
Swift
let kSKIncorrectSettingNamesKey: String
-
Page dimensions in pixels. Its value is NSDictionary that represents CGSize.
Declaration
Objective-C
extern const SKScanPageTrait _Nonnull SKScanPageTraitDimensions
Swift
static let dimensions: SKScanPageTrait
-
Bytes per row. The value is NSNumber.
Declaration
Objective-C
extern const SKScanPageTrait _Nonnull SKScanPageTraitBytesPerRow
Swift
static let bytesPerRow: SKScanPageTrait
-
Creation date. The value is NSDate.
Declaration
Objective-C
extern const SKScanPageTrait _Nonnull SKScanPageTraitCreationDate
Swift
static let creationDate: SKScanPageTrait
-
The key of the scan ticket name within the ticket dictionary representation
Declaration
Objective-C
extern const SKScanTicketRepresentationKey _Nonnull SKScanTicketNameKey
Swift
static let nameKey: SKScanTicketRepresentationKey
-
The key of input source value within the ticket dictionary representation. Its value is represented by NSNumber containing SKInputSource enum value.
Declaration
Objective-C
extern const SKScanTicketRepresentationKey _Nonnull SKScanTicketInputSourceKey
Swift
static let inputSourceKey: SKScanTicketRepresentationKey
-
The key of the scan settings dictionary within the ticket dictionary representation. See SKScanSettingName constants for possible settings.
Declaration
Objective-C
extern const SKScanTicketRepresentationKey _Nonnull SKScanTicketSettingsKey
Swift
static let settingsKey: SKScanTicketRepresentationKey
-
Name of scan preset that is suitable to perform scanning photos
Declaration
Objective-C
extern const SKScanPresetName _Nonnull SKScanPresetNamePhoto
Swift
static let photo: SKScanPresetName
-
Name of scan preset that is suitable to perform scanning text documents
Declaration
Objective-C
extern const SKScanPresetName _Nonnull SKScanPresetNameTextDocument
Swift
static let textDocument: SKScanPresetName
-
Name of preset that is suitable to perform scanning documents that contain text and images
Declaration
Objective-C
extern const SKScanPresetName _Nonnull SKScanPresetNameTextAndImages
Swift
static let textAndImages: SKScanPresetName
-
Name of preset that is suitable to perform high speed scanning in order to preview the document available in Platen input source
Declaration
Objective-C
extern const SKScanPresetName _Nonnull SKScanPresetNamePreview
Swift
static let preview: SKScanPresetName
-
Resolution setting name. Its value is NSDictionary that represent CGSize. The width and height values of the CGSize represent integral values of horizontal and vertical resolutions. The values could be different.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameResolution
Swift
static let resolution: SKScanSettingName
-
Document format in which scanned image should be saved. Its value is represented by NSNumber containing SKDocumentFormat enum value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameFormat
Swift
static let format: SKScanSettingName
-
Color mode setting name. Its value is represented by NSNumber containing SKColorMode enum value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameColorMode
Swift
static let colorMode: SKScanSettingName
-
Intent setting name. Its value is represented by NSNumber containing SKIntent enum value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameIntent
Swift
static let intent: SKScanSettingName
-
Content type setting name. Its value is represented by NSNumber containing SKContentType enum value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameContentType
Swift
static let contentType: SKScanSettingName
-
Duplex setting name. Its value is represented by NSNumber containing bool value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameDuplex
Swift
static let duplex: SKScanSettingName
-
The name of setting that obliges scanner to do not use edge detection and override scan areas. The value is represented by NSNumber containing bool value.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameMustHonorScanAreas
Swift
static let mustHonorScanAreas: SKScanSettingName
-
Scan areas setting name. Its value is NSArray of NSDictionary that represent CGRect. Scan areas should be defined in 1/300th of an inch points.
Declaration
Objective-C
extern const SKScanSettingName _Nonnull SKScanSettingNameScanAreas
Swift
static let scanAreas: SKScanSettingName