API Reference
Complete reference for all Aila SDK functions, classes, and notifications.
Core Functions
Initialization
- Aila_Init - Initialize the SDK
- Aila_SetConfiguration - Configure SDK settings
Licensing
- Aila_ReadLicense - Initialize license file
- Aila_SetLicenseProfile - Set profile ID for cloud licensing
- Aila_GetSDKLicensingInfo - Get current licensing info
Scanning
- Aila_Start - Start scanning
- Aila_Stop - Stop scanning
- Aila_ResetScan - Reset camera settings after scan
- Aila_Beep - Trigger beep manually
Camera Control
- Aila_ReleaseCamera - Take full control of device camera
- Aila_RegainCamera - Relinquish camera control to Aila
- Aila_GetAVCaptureSession - Get internal AVCaptureSession
- Aila_SetCameraFramerate - Change the back camera's frame rate Since 3.1.0
Audio Control
- Aila_EnableSpeaker - Enable audio through speaker
- Aila_DisableSpeaker - Disable audio through speaker
Advanced Features
- Aila_ID1CaptureImage - Capture ID-1 card images
- Aila_OverrideLightLevels - Control LED intensity
- Aila_OverrideLightTimeout - Set lighting duration
- Aila_NotifyVibrate - Trigger device vibration
Hardware Information
- Aila_GetHardwareClass - Get current hardware class
- Aila_GetHardwareDescription - Get hardware model description
- Aila_GetHardwareSerialNumber - Get hardware serial number
- Aila_GetFirmwareVersionNumber - Get firmware version
- Aila_GetConnectionInfo - Get connection type and status
- Aila_GetChargerWattage - Get negotiated charger power
SDK Information
- Aila_GetSDKVersion - Get library version
- Aila_ComsTest - Test RSM endpoint reachability
Classes
- AilaConfiguration - SDK configuration object
- AilaCaptureView - UI view with camera feed
- AilaScanObject - Base scan result object
- AilaMRZScanObject - MRZ scan result
- AilaDLScanObject - Driver's license scan result
Notifications
- Notifications - All NSNotification constants