iOS Global IQA SDK Integration Guide (V1.4.0)

Overview

AAIGlobalIQASDK contains four modules, the core module AAIGlobalIQASDK, the model resources module AAIGlobalIQAModel, the default UI module AAIGlobalIQAUI, the dependency module AAINetwork and AAICore.

• AAIGlobalIQASDK.xcframework(Dynamic framework, Required module)

  This is the core module that provides the essential UI component AAIIQACameraWrapperView. This component offers real-time scanning and photo capture functionality. You can directly integrate the AAIIQACameraWrapperView UI control into your own pages to meet your fully customized UI requirements. For specific usage instructions, please refer to the code in CameraViewDemo1/MyCameraDemo1ViewController.swift from the demo project. The actual total size of this module is about 2.3MB(arm64, disable bitcode).

• AAIGlobalIQAModel.xcframework(Dynamic framework, Optional module)

  This model resources module contains the model files used by the SDK. The total size of this module is approximately 1MB (arm64, disable bitcode). This module is optional, if you want to minimize the size of the SDK, you can remove it, and the SDK will automatically download the model files from the server when needed, but the trade-off is that users will need to wait for the model files to download on first use.

• AAIGlobalIQAUI(Source mode, Optional module)

  This module provides the default UI implementation for the SDK, allowing you to quickly achieve the desired functionality. Please note that this module is optional - if you choose not to use it, you'll need to implement your own UI pages by integrating the core AAIIQACameraWrapperView component from AAIGlobalIQASDK into your custom UI page, giving you complete control over your UI logic and presentation. This module provides source code visibility (when integrated via CocoaPods or Swift Package Manager) and offers public APIs for further customization. For detailed examples of UI customization effects and related code, please refer to the DefaultUsageDemo, CustomUIDemo1, CustomUIDemo2, and CustomUIDemo4 sections in the demo project.

• AAICore.xcframework(Dynamic framework, Required module)

  A core library that AAI SDKs depend on. The total size of this module is approximately 0.2MB (arm64, disable bitcode).

• AAINetwork.xcframework(Dynamic framework, Required module)

  A base network library that AAI SDKs depend on. The total size of this module is approximately 0.8MB (arm64, disable bitcode).

SDK requirements and limitations as below:

• Minimum iOS version: iOS 10.0

• Additional dependent third-party libraries: None

• Supported CPU architectures: arm64, x86_64

• SDK package size: 4.6MB(arm64, all module) or 3.3MB(arm64, without AAIGlobalIQAModel and AAIGlobalIQAUI module)

• Capture image size: width * 800px. Note the width is determined by the device's camera resolution, and the height is fixed at 800px.

• Supported bitcode: NO

• Supported languages:

  • English (en)
  • Indonesian (id)
  • Thai (th)
  • Simplified Chinese (zh-Hans)

• Use-permissions: NSCameraUsageDescription

Compliance Explanation

Click to view the compliance explanation

Migration Guides

1. When migrating from older version to 1.4.x, you need to modify your Podfile to add other SDK dependencies (AAIGlobalIQAUI, AAIGlobalIQAModel and AAICore).
2. When migrating from 1.0.x to 1.1.x or higher, you need to modify your Podfile to reintegrate the SDK(including SDK dependency AAINetwork).

Run demo project

1. Download the AAIGlobalIQASDK and extract it, then navigate to the directory of AAIGlobalIQASDKSwiftDemo project and install the dependencies:

   pod install
   

2. Open xcworkspace file in Xcode.

3. Specify your license, and configure region and cardType and cardSide.

4. Run.

5. The project includes DefaultUsageDemo, CustomUIDemo1, CustomUIDemo2, and CustomUIDemo4 which demonstrate the default UI module and various customized UI effects based on the default UI module. The CameraViewDemo1 section provides usage examples for the core AAIIQACameraWrapperView component.

Integration

• See Integration guide (Default UI) for details on how to integrate the SDK into your iOS project.
• See Integration guide (CustomView Mode) for details on how to use the AAIIQACameraWrapperView component in your own UI pages.

FAQ

See FAQ for common questions and answers.

Release Notes

See iOS IQA SDK release history for more details.