Skip to content

Flutter SDK 2.3.1

SDK Installation

  1. Download the Flutter SDK here.

  2. Unzip the downloaded SDK zip file to a folder in your local drive.

  3. Setup the SDK:

    bash
    cd vital_sign_camera
    flutter pub get

Sample Code

The quickest and simplest way to kickstart your journey with the Flutter SDK is by downloading and experimenting with our full-featured sample code. To run the sample code, go to the demo_app folder, execute the commands:

console
flutter pub get
flutter run

IMPORTANT

In the above sample codes, 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

To integrate our Flutter SDK into your Flutter project, add the Flutter SDK package by:

bash
flutter pub add vital_sign_camera --path "/path_of_downloaded_folder/flutter-vital-sign-sdk/vital_sign_camera"

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

Project Integration (for iOS)

IMPORTANT

This version of the SDK requires targeting iOS 16.0 or above. If targeting iOS 12, please use SDK version 1.6.x.

Add the following to the 'ios/Podfile' file for the iOS simulator support:

ruby
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # Support x86_64 simulator only
      config.build_settings['ARCHS[sdk=iphonesimulator*]'] = 'x86_64'
    end
    flutter_additional_ios_build_settings(target)
  end
end

Camera Permission (for iOS)

When developing for iOS, you need to allow the app to use the camera by specifying the following in the file Info.plist:

xml
<key>NSCameraUsageDescription</key>
<string>Use for measuring vital signs</string>

TIP

In Info.plist, the string "Use for measuring vital signs" is an example description of the camera usage. You should specify your own description that matches the usage of your application.

Project Integration (for Android)

IMPORTANT

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

Add the following line to the file android/settings.gradle:

groovy
include ':vital-sign-engine'
project(':vital-sign-engine').projectDir = new File('/path_of_downloaded_folder/flutter-vital-sign-sdk/vital_sign_camera/android/libs')

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

Camera Permission (for Android)

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

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

What's new

2.3.1 (5-Sept-2025)

  • Fixed the problem that the blink detector is not working.

2.3.0 (4-Sept-2025)

  • Introduced SdkCredentials, providing a new method for setting the API key and user ID.
  • Added PrecisionMode. The relaxed mode uses the V1 server and performs measurements in best-effort mode, while the strict mode uses the V2 server for high-accuracy measurements, requiring higher device performance.
  • Added support for 16KB page size to comply with Android requirements.
  • Various bug fixes and general improvements.