Koala Noise Suppression
Android Quick Start

Platforms

• Android (5.0+)

Requirements

• Picovoice Account and AccessKey
• Android Studio
• Android device with USB debugging enabled or Android simulator

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Android Studio.

2. Include mavenCentral() repository in the top-level build.gradle. Then add the following to the app's build.gradle:

dependencies {
    // ...
    implementation 'ai.picovoice:koala-android:${LATEST_VERSION}' // replace with latest version
}

3. Add the following to the app's AndroidManifest.xml file to enable recording with an Android device's microphone:

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

Usage

Create an instance of the engine with the Koala Noise Suppression Builder by passing in your AccessKey and the Android app context:

import ai.picovoice.koala.*;

final String accessKey = "${ACCESS_KEY}"; // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)

try {
    Koala koala = new Koala.Builder()
      .setAccessKey(accessKey)
      .build(appContext);
} catch (KoalaException ex) { }

Enhance real-time audio:

short[] getNextAudioFrame() {
    // .. get audioFrame
    return audioFrame;
}


while true {
    short[] enhancedAudioFrame = koala.process(getNextAudioFrame());
}

In case the next audio frame does not directly follow the previous one, reset Koala Noise Suppression's internal state:

koala.reset();
while true {
    short[] enhancedAudioFrame = koala.process(getNextAudioFrame());
}

When done, release resources explicitly:

koala.delete();

Demo

For the Koala Noise Suppression Android SDK, we offer demo applications that demonstrate how to use the Noise Suppression engine on real-time audio streams (i.e. microphone input).

Setup

Clone the Koala Noise Suppression repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/koala.git

Usage

1. Open the Android demo using Android Studio.
2. Copy your AccessKey from Picovoice Console into the ACCESS_KEY variable in MainActivity.java.
3. Run the application using a connected Android device or using an Android simulator.

Resources