API Reference

Complete reference for all Aila Cordova SDK methods and events.

Core Methods

Initialization

• init - Initialize the SDK with configuration
• setConfig - Update SDK configuration

Licensing

• readLicense - Initialize license file
• setLicenseProfile - Set profile ID for cloud licensing
• getSDKLicenseInfo - Get current licensing info

Scanning

• scanStart - Start barcode scanning
• scanStop - Stop scanning
• resetScan - Reset camera settings after scan
• beep - Trigger beep manually

Camera Control

• disableCamera - Take full control of device camera
• enableCamera - Relinquish camera control to Aila
• getAVCaptureSession - Get internal AVCaptureSession (iOS only)

Audio Control

• speakerOn - Enable audio through speaker
• speakerOff - Disable audio through speaker

Advanced Features

• captureImage - Capture ID-1 card images
• lightOverride - Control LED intensity
• overrideLightTimeout - Set lighting duration
• vibrate - Trigger device vibration

Capture View (UI)

• showCaptureView - Show native camera overlay
• hideCaptureView - Hide native camera overlay
• setCaptureViewFrame - Set overlay position and size
• displayMRZGuides - Show/hide MRZ scanning guides
• resetGuidanceText - Reset guidance text to default

Hardware Information

• getHardwareDescription - Get hardware model description
• getConnectionInfo - Get connection type and status
• getSerialNumber - Get hardware serial number
• getFirmwareVersionNumber - Get firmware version
• getChargerWattage - Get negotiated charger power

SDK Information

• getSDKVersion - Get library version

Events

Listen for events using window.addEventListener():

• rawScanData - Triggered when a barcode is scanned
• imageCaptured - Triggered when ID-1 card image is captured