Android Sonde Edge Passive SDK Integration

Overview

Here is the step by step guide for integrating the Sonde Edge Passive SDK into an Android mobile application, which includes enrollment and verification modules along with the initialization of the SDK.

Prerequisites:

Android Studio (Android Studio Electric Eel and above)
Android SDK (API 30 and above)
Kotlin 1.8.0 and above
Support for API Level 26 and above.

How to get SDK:

To obtain the SDK, please contact support@sondehealth.com to request the Android Sonde Edge Passive SDK. In your request email, kindly provide the company name, developer name(s), email, and contact telephone number. Our support and sales team will review your request and may reach out to you for further details.
If your request is approved, the Sonde support team will provide access to download the SDK. Subsequently, you will receive an email containing a link to download the SDK along with a sample code for reference.
To start with the Sonde SDK, please open an account with Sonde.
1. Review the SDK account creation page to create it.
2. Once you open an account with Sonde, you will receive a Test key, which will consist of the Client Secret and Client ID.
3. The above IDs will be required in SDK Initialization.
4. The above information is required for SDK health check metering. For additional metering information, Please refer Metering Meta-Data page.

Demo App capabilities:

This page assists partner developers in understanding the demo app capabilities and which new features are coming up in upcoming releases.

Demo App Capabilities

Integration:

You can create your own project using Android Studio to utilize the Android Sonde Edge Passive SDK.

Following are the steps to create an Android app:

Open Android Studio on your PC.
Create a New Project: Click "Create a new Android Studio project" or go to File -> New -> New Project.
Choose Template: Select the template that matches the type of app you want to create. Android Studio provides various templates for different app types from the Phone and Tablet menu, such as "No Activity," "Basic Activity," or "Empty Activity."
Configure Project: Provide the necessary details such as Name, Package Name, App Location, Language (choose “Kotlin” here), and Minimum SDK (API 26).
Please download the SDK from the mail from the Sonde support team.
After downloading the SDK, copy the downloaded /Users/ABC/sonde-android-passive-sdk-v1.0.0.aar file to the libs folder of your app module. (Screenshot attached below)

Keep your minimum SDK and maximum SDK API level in app/build.gradle as follows

android {
    ..
    ..

    defaultConfig {
        ..
        ..
        ..
        minSdk 26
        targetSdk 34
        ..
        ..
        ..
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
}

Add the below statement in app/build.gradle file of your app module

dependencies {
    api fileTree(include: ['*.jar', '*.aar'], dir: 'libs')
    ..
    ..
    ..
    /encrypted shared prefs
    implementation 'androidx.security:security-crypto-ktx:<latest_version>'
    //coroutines
    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:<latest_version>'
    //retrofit
    implementation 'com.squareup.retrofit2:retrofit:<latest_version>'
    implementation 'com.google.code.gson:gson:<latest_version>'
    implementation 'com.squareup.retrofit2:converter-gson:<latest_version>'
    implementation 'com.squareup.okhttp3:logging-interceptor:<latest_version>'
    //room
    implementation "androidx.room:room-runtime:<latest_version>"
    kapt "androidx.room:room-compiler:<latest_version>"
    implementation "androidx.room:room-ktx:<latest_version>"
    //database cipher
    implementation "net.zetetic:android-database-sqlcipher:<latest_version>"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:<latest_version>"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:<latest_version>"
}

Enable microphone permission to record the audio file and Internet permission. Add the below statement in the AndroidManifest.xml file of your app module.

<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

Clean and build the project to access the Edge SDK classes.
If SDK classes are not accessible, then click on File → Sync Project with Gradle Files. It will rebuild your app and link all the library classes.

Note: The Android Sonde Edge Passive SDK is compatible with API Level 26 (Android 8 - Oreo) and above. However, it's important to note that simulators/Emulators are unsupported. Therefore, the SDK can be utilized on physical Android devices running API Level 26 or later versions.

Android Sonde Edge Passive SDK Modules:

The Android Sonde Edge Passive SDK starts with SDK Initialization and offers two primary functionalities, Enrollment, and Verification, which allow you to obtain scores and voice features. Please check the below pages for implementation details about these modules:

Please refer the below page for more on Background, call handling, and notification handling.

Developer guide - Background, Call handling, and Notifications

Releases for Sonde Passive Edge SDK

	Release Versions	Release Date	Changes

	Release Versions	Release Date	Changes
1	v1.0.0	8th August 2023	Passive support.
2	v1.0.5	30th April 2024	Initialization module, Metering, continuous voice analysis