Constants Reference

The SDK provides various enums for configuration. Reference them as shown below.

AilaCodeType

Since 3.0.0

Represents a barcode type or MRZ. Use with setCode:enabled: method on AilaConfiguration.

Objective-C

AilaCodeTypeNone        // Disable all code types
AilaCodeTypeAztec       // Aztec codes
AilaCodeType2of5        // 2 of 5 codes and variants
AilaCodeTypeCodaBar     // CodaBar codes
AilaCodeType39          // Code 39
AilaCodeType93          // Code 93
AilaCodeType128         // Code 128 and variants
AilaCodeTypeDataMatrix  // DataMatrix codes
AilaCodeTypeEAN         // EAN codes and variants
AilaCodeTypeDataBar     // GS1 DataBar codes
AilaCodeTypeDotCode     // DotCode codes
AilaCodeTypeMRZ         // MRZ strings
AilaCodeTypeMSIPlessey  // MSI/Plessey codes
AilaCodeTypePDF417      // PDF417 codes
AilaCodeTypeUPC         // UPC codes and variants
AilaCodeTypeQR          // QR codes

Swift

.typeNone       // Disable all code types
.typeAztec      // Aztec codes
.type2of5       // 2 of 5 codes and variants
.typeCodaBar    // CodaBar codes
.type39         // Code 39
.type93         // Code 93
.type128        // Code 128 and variants
.typeDataMatrix // DataMatrix codes
.typeEAN        // EAN codes and variants
.typeDataBar    // GS1 DataBar codes
.typeDotCode    // DotCode codes
.typeMRZ        // MRZ strings
.typeMSIPlessey // MSI/Plessey codes
.typePDF417     // PDF417 codes
.typeUPC        // UPC codes and variants
.typeQR         // QR codes

AilaMultiScanMode

Since 3.0.0

Control whether multiple barcodes can be scanned in a single session.

Default: AilaMultiScanModeOff

Objective-C

AilaMultiScanModeOff  // Return first barcode found in a frame
AilaMultiScanModeOn   // Can return multiple barcodes in a single frame

Swift

.off  // Return first barcode found in a frame
.on   // Can return multiple barcodes in a single frame

When enabled, the SDK can capture multiple barcodes and return them as a stream. Useful for scanning multiple items or finding specific barcodes among many.

AilaDuplicateFilter

Since 3.0.0

Control duplicate detection in multi-scan mode.

Default: AilaDuplicateFilterOn

Objective-C

AilaDuplicateFilterOff  // Return all barcodes as soon as available
AilaDuplicateFilterOn   // Only return unique barcodes in a session

Swift

.off  // Return all barcodes as soon as available
.on   // Only return unique barcodes in a session

info

This property only applies when AilaMultiScanMode is enabled.

When enabled (and multi-scan mode is active), each barcode is returned only once per session until timeout (4s with no motion) or Aila_ResetScan() is called.

AilaBeepMode

Since 3.0.0Deprecated in 3.1.0Use AilaBeepVolume instead.

Control automatic beep feedback on successful scans.

Default: AilaBeepModeOn

Objective-C

AilaBeepModeOff  // No automatic beep
AilaBeepModeOn   // Automatically beep upon scan

Swift

.off  // No automatic beep
.on   // Automatically beep upon scan

When multi-scan mode is enabled, beep mode is not available. Regardless of the configured beep mode, a beep can be manually triggered via Aila_Beep().

AilaBeepVolume

Since 3.1.0

Volume of the beep played on successful scans. See beepVolume for how volume control varies by head unit.

Default: AilaBeepVolume3

Objective-C

AilaBeepVolume0  // No automatic beep
AilaBeepVolume1  // Lowest volume
AilaBeepVolume2  // Lower volume
AilaBeepVolume3  // Default volume
AilaBeepVolume4  // Raised volume
AilaBeepVolume5  // Highest volume

Swift

.volume0  // No automatic beep
.volume1  // Lowest volume
.volume2  // Lower volume
.volume3  // Default volume
.volume4  // Raised volume
.volume5  // Highest volume

When multi-scan mode is enabled, the beep is not available. A beep triggered manually via Aila_Beep() plays at the configured volume.

AilaFocusMode

Since 3.0.0

Select the camera focus algorithm.

Default: AilaFocusStandardMode

Objective-C

AilaFocusStandardMode  // Normal focus algorithm for connected device
AilaFocusSafeMode      // Sweep focus with reduced lighting

Swift

.standardMode  // Normal focus algorithm for connected device
.safeMode      // Sweep focus with reduced lighting

It is recommended that AilaFocusSafeMode be used only in special situations when AilaFocusStandardMode is not responsive.

AilaMRZMode

Since 3.0.0

Enable or disable MRZ scanning.

Default: AilaMRZModeOff

Objective-C

AilaMRZModeOff  // Doesn't scan for MRZ text
AilaMRZModeOn   // Return MRZ text as JSON formatted string

Swift

.off  // Doesn't scan for MRZ text
.on   // Return MRZ text as JSON formatted string

When AilaMRZMode is enabled, we recommend adding the AilaCaptureView to assist the user. The kiosk lighting will be disabled whenever MRZ scanning is invoked.

AilaMRZDetectionMode

Since 3.0.0

Enable early MRZ component detection for UI feedback.

Default: AilaMRZDetectionModeOff

Objective-C

AilaMRZDetectionModeOff  // Doesn't detect MRZ pieces
AilaMRZDetectionModeOn   // Send notifications when pieces detected

Swift

.off  // Doesn't detect MRZ pieces
.on   // Send notifications when pieces detected

Posts AilaMRZDetectedNotification when MRZ components are detected, before complete scanning.

AilaGS1ParsingMode

Since 3.0.0

Control GS1 Application Identifier formatting.

Default: AilaGS1ParsingModeOff

Objective-C

AilaGS1ParsingModeOff  // Return string with no parsing
AilaGS1ParsingModeOn   // Return with AIs in parentheses

Swift

.off  // Return string with no parsing
.on   // Return with AIs in parentheses

AilaDLParsingMode

Since 3.0.0

Enable structured parsing of US driver's license barcodes.

Default: AilaDLParsingModeOff

Objective-C

AilaDLParsingModeOff  // Return standard pdf417 with no parsing
AilaDLParsingModeOn   // Return AilaDLScanObject for US driver's licenses

Swift

.off  // Return standard pdf417 with no parsing
.on   // Return AilaDLScanObject for US driver's licenses

AilaUPCEExpansionMode

Since 3.0.0

Control UPC-E to UPC-A conversion.

Default: AilaUPCEExpansionModeOff

Objective-C

AilaUPCEExpansionModeOff  // Return standard UPC-E barcodes
AilaUPCEExpansionModeOn   // Expand UPC-E into UPC-A format

Swift

.off  // Return standard UPC-E barcodes
.on   // Expand UPC-E into UPC-A format

AilaEANSupplementalMode

Since 3.0.0

Control EAN supplemental code handling.

Default: AilaEANSupplementalModeOff

Objective-C

AilaEANSupplementalModeOff          // Ignore supplemental digits
AilaEANSupplementalModeNotRequired  // Return with supplemental if available
AilaEANSupplementalModeRequired     // Only return when supplemental present

Swift

.off          // Ignore supplemental digits
.notRequired  // Return with supplemental if available
.required     // Only return when supplemental present

When NotRequired is selected, if the EAN barcode is captured first, the result may be returned without supplemental digits. Supplemental code will be space delimited.

AilaID1CardDetectionMode

Since 3.0.0

Enable automatic detection of ID-1 sized cards in the tray.

Default: AilaID1CardDetectionModeOff

Objective-C

AilaID1CardDetectionModeOff  // Do not detect cards
AilaID1CardDetectionModeOn   // Detect cards

Swift

.off  // Do not detect cards
.on   // Detect cards

When enabled, AilaID1CardDetectedNotification is posted when a card is detected. Only compatible with Interactive Kiosks fitted with an ID Tray.

AilaImageCaptureDebugMode

Since 3.0.0

Control image return behavior on capture timeout.

Default: AilaImageCaptureDebugModeOff

Objective-C

AilaImageCaptureDebugModeOff  // Don't return images on timeout
AilaImageCaptureDebugModeOn   // Return images with error watermark

Swift

.off  // Don't return images on timeout
.on   // Return images with error watermark

AilaEnabledCameraPosition

Since 3.0.0

Select which camera to use for scanning.

Default: AilaEnabledCameraPositionBack

Objective-C

AilaEnabledCameraPositionBack   // Use back camera
AilaEnabledCameraPositionFront  // Use front camera

Swift

.back   // Use back camera
.front  // Use front camera

Currently only supports barcode scanning through the front camera.

AilaCloudLicensing

Since 3.0.0

Enable automatic license updates from Aila's cloud service.

Default: AilaCloudLicensingOn

Objective-C

AilaCloudLicensingOff  // Don't request updates from cloud
AilaCloudLicensingOn   // Pull down updates from cloud

Swift

.off  // Don't request updates from cloud
.on   // Pull down updates from cloud

AilaRSM

Since 3.0.0

Enable device health and performance monitoring.

Default: AilaRSMOn

Objective-C

AilaRSMOff  // Do not send status information
AilaRSMOn   // Automatically send status information

Swift

.off  // Do not send status information
.on   // Automatically send status information

Remote status monitoring allows Aila to monitor system health, performance, and provide enhanced customer support.

AilaPowerManagementMode

Since 3.0.0

Enable automatic power optimization.

Default: AilaPowerManagementModeOn

Objective-C

AilaPowerManagementModeOff  // Don't change device/SDK settings
AilaPowerManagementModeOn   // Automatically adjust for power stability

Swift

.off  // Don't change device/SDK settings
.on   // Automatically adjust for power stability

When enabled:

• Efficiency Mode: Reduces screen brightness to 90% for cooler 24/7 operation
• Safe Mode: Optimizes settings during power deficiencies to keep the system online

AilaDebugLevel

Since 3.0.0

Control SDK logging verbosity.

Default: AilaDebugLevelSilent

Objective-C

AilaDebugLevelSilent  // No messages
AilaDebugLevelError   // Error messages only (E)
AilaDebugLevelWarn    // Warnings and errors (W)
AilaDebugLevelInfo    // Informational messages (I)
AilaDebugLevelDebug   // Internal debugging (D)
AilaDebugLevelBulk    // High-volume low-level messages (B)

Swift

.silent  // No messages
.error   // Error messages only (E)
.warn    // Warnings and errors (W)
.info    // Informational messages (I)
.debug   // Internal debugging (D)
.bulk    // High-volume low-level messages (B)

Each level includes messages of equal or greater severity. Debug and Bulk levels may have no effect in release versions.

Log messages are formatted: [2015-05-06 11:09:24.181 <function> <E|W|I|D|B>] <message>

AilaLogCategory

Since 3.1.0Changed in 3.2.0AilaLogCategoryIdCapture was added before AilaLogCategoryTelemetry, so the raw values of Telemetry, SerialNumber and IDDetect each went up by one.

Log categories used with enabledLogCategories to filter Info, Debug and Bulk messages.

Objective-C

AilaLogCategoryGeneral       // Configuration, compatibility, protocol
AilaLogCategoryMRZ           // MRZ scanning, parsing, image processing
AilaLogCategoryScan          // Scanner session and barcode scanning
AilaLogCategoryLicensing     // License parsing
AilaLogCategoryCloud         // Cloud licensing
AilaLogCategoryCamera        // Camera, exposure, color balance
AilaLogCategoryIdCapture     // ID-1 card image capture
AilaLogCategoryTelemetry     // Telemetry, firmware
AilaLogCategorySerialNumber  // Hardware serial number
AilaLogCategoryIDDetect      // ID-1 card detection

Swift

.general       // Configuration, compatibility, protocol
.MRZ           // MRZ scanning, parsing, image processing
.scan          // Scanner session and barcode scanning
.licensing     // License parsing
.cloud         // Cloud licensing
.camera        // Camera, exposure, color balance
.idCapture     // ID-1 card image capture
.telemetry     // Telemetry, firmware
.serialNumber  // Hardware serial number
.IDDetect      // ID-1 card detection

Store categories by name rather than raw value, since raw values can change between SDK versions.

AilaHardwareClass

Since 3.0.0

Values returned by Aila_GetHardwareClass():

Objective-C

AilaHardwareClassNone    // No hardware connected
AilaHardwareClassKiosk   // Interactive Kiosk
AilaHardwareClassMobile  // Mobile Imager (legacy)

Swift

.none    // No hardware connected
.kiosk   // Interactive Kiosk
.mobile  // Mobile Imager (legacy)

AilaConnectionInfo

Since 3.0.0

Values returned by Aila_GetConnectionInfo():

Objective-C

AilaConnectionNone           // No Aila hardware connected
AilaConnectionDigital        // USB-C connection
AilaConnectionAnalogSimplex  // Lightning connection (problem)
AilaConnectionAnalogDuplex   // Lightning connection (normal)

Swift

.none           // No Aila hardware connected
.digital        // USB-C connection
.analogSimplex  // Lightning connection (problem)
.analogDuplex   // Lightning connection (normal)