Android SDK 1.5.1

SDK Installation

1. Download the Android SDK and sample code here.
2. Unzip the downloaded SDK zip file to a folder in your local drive.

Sample Code

The quickest and simplest way to kickstart your journey with the Android SDK is by downloading and experimenting with our sample code. Follow these steps to open the sample project:

1. Open Android Studio.
2. In Android Studio, select "File", "Open...".
3. Choose the demo folder from the downloaded SDK files, and then click Open.

IMPORTANT

In the demo code, the strings __YOUR_USER_ID__ and __YOUR_API_KEY__ should be replaced by your own User ID and API Key repectively. Please contact us to obtain your User ID and API Key.

Project Integration

IMPORTANT

Please note that for Android, the minimum SDK version must be at least 24.

1. Add the following line to the file settings.gradle:

   Kotlin (build.gradle.kts)

   include(":vital-sign-engine")
   project(":vital-sign-engine").projectDir = File("path_of_downloaded_folder/kotlin-vital-sign-sdk-1.5.1/sdk/libs")
   include(":vital-sign-sdk")
   project(":vital-sign-sdk").projectDir = File("path_of_downloaded_folder/kotlin-vital-sign-sdk-1.5.1/sdk")

   Groovy (build.gradle)

   include ':vital-sign-engine'
   project(':vital-sign-engine').projectDir = new File('path_of_downloaded_folder/kotlin-vital-sign-sdk-1.5.1/sdk/libs')
   include ':vital-sign-sdk'
   project(':vital-sign-sdk').projectDir = new File('path_of_downloaded_folder/kotlin-vital-sign-sdk-1.5.1/sdk')

   Please replace the string path_of_downloaded_folder above with the actual downloaded path.

2. Remove or comment out the line which set the repositories mode to RepositoriesMode.FAIL_ON_PROJECT_REPOS from the file settings.gradle.kts or settings.gradle:

   Kotlin (build.gradle.kts)

   dependencyResolutionManagement {
   //    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   }

   Groovy (build.gradle)

   dependencyResolutionManagement {
   //    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   }

3. Add the dependencies in the file build.gradle.kts or build.gradle.

   Kotlin (build.gradle.kts)

   implementation(project(":vital-sign-engine"))
   implementation(project(":vital-sign-sdk"))

   Groovy (build.gradle)

   implementation project(path: ':vital-sign-engine')
   implementation project(path: ':vital-sign-sdk')

Camera Permission

When developing for Android, you need to allow the app to use the camera by specifying the following in AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />

What's New

1.5.1 (19-Jan-2026)

• Bug Fixes: Fixed a crash if camera is not initialized properly
• Schema Updates: Fixed a typo in V2 schema parsing and updated VitalSign to reflect deprecation of stressScore in schema 2.3
• Face Detection: Updated face detector to version 16.1.7 to fix 16kb alignment issues
• Version Management: Updated versions from beta to release

1.5.0 (19-Dec-2025)

• Java API Support: Added Java-compatible API for broader language support
• S3 Data Upload: Implemented saveScanDataToS3 functionality to save scan request and response data directly to S3
• Enhanced Scan Parameters: Added more scan parameters and FPS display in scan conditions
• Mean RGB Pixel Type: Implemented meanRGB chest pixel type for improved accuracy
• Huawei Device Compatibility: Fixed face detector issues on Huawei devices
• UI Improvements: Resolved scrolling problems in example4 result screen
• Crash Prevention: Added error handling for native library loading failures
• Configuration Fixes: Corrected landmarks sample rate settings and error key usage
• Relaxed Mode: Enabled relaxed mode for example1 with improved user experience
• Cross-Platform Alignment: Aligned precision mode features with Swift and TypeScript implementations
• CameraX Upgrade: Updated to latest CameraX version for improved camera handling
• Android SDK: Upgraded Android SDK version for better compatibility
• NDK Updates: Updated to NDK 25 with 16KB page size support
• Gradle Improvements: Updated Gradle configuration for better build performance