Koala Noise Suppression
iOS Quick Start

Platforms

• iOS (13.0+)

Requirements

• Xcode
• CocoaPods

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 Xcode.

2. Install CocoaPods

3. Import the Koala-iOS binding by adding the following line to Podfile:

pod 'Koala-iOS'

4. Run the following from the project directory:

pod install

5. Add the following to the app's Info.plist file to enable recording with an iOS device's microphone

<key>NSMicrophoneUsageDescription</key>
<string>[Permission explanation]</string>

Usage

Create an instance of the engine and enhance audio:

import Koala

do {
  let koala = try Koala(accessKey: "${ACCESS_KEY}")
} catch {}

func getNextAudioFrame() -> [Int16] {
  // .. get a frame of audio
}

while true {
  do {
    let enhancedAudio = try koala.process(getNextAudioFrame())    
  } catch {}
}

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

try koala.reset()
while True {
    let enhancedAudio = try koala.process(getNextAudioFrame())
}

Free resources acquired by Koala Noise Suppression:

koala.delete()

Demos

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

Setup

Clone the Repository

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

Usage

1. Install dependencies:

cd koala/demo/ios/KoalaDemo
pod install

2. Replace let ACCESS_KEY = "${YOUR_ACCESS_KEY_HERE}" in the ViewModel.swift file with a valid AccessKey.

3. Open the KoalaDemo.xcworkspace in XCode and run the demo.

For more information on our Koala Noise Suppression demos for iOS, head over to our GitHub repository.

Resources