Build a Sample App with NCKit
Use this guide to create a new iOS app or integrate NCKit into an existing project.
Reference project
| Item | Value |
|---|---|
| Repository | github.com/5Exceptions-Mobile-Team/NCKit_Demo |
| Xcode project | NCKitSample.xcodeproj |
| Scheme | NCKitSample |
| NCKit version | 1.2.1 (SPM) |
git clone https://github.com/5Exceptions-Mobile-Team/NCKit_Demo.git
cd NCKit_Demo/KrispyiOS
open NCKitSample.xcodeproj
The sample demonstrates microphone NC, video/file denoise, and in-app API snippets.
Verify import
import NCKit
Public API checklist
let modelURL = try NCKitModelLocator.modelTarGzURL()
let processor = try NCKitProcessor(modelURL: modelURL)
try NCKitFileProcessor.processFile(inputURL: in, outputURL: out, processor: processor)
Run on arm64 device or simulator (arm64 / x86_64 with NCKit 1.2.1+).
Use this guide to clone the reference Android app or integrate NCKit into your own project. This page documents everything the sample does with NCKit — integration, usage, and SDK API mapping. Toggle Android in the navbar on other pages for matching Kotlin snippets.
Reference project
| Item | Value |
|---|---|
| Repository | github.com/5Exceptions-Mobile-Team/Nckit_Android_Sample_App |
| Android Studio project | Open the repository root (Gradle project) |
| App module | app |
| NCKit version | 1.1.2 (Maven) |
| SDK (private) | 5Exceptions-Mobile-Team/NCKit_Android |
git clone https://github.com/5Exceptions-Mobile-Team/Nckit_Android_Sample_App.git
cd Nckit_Android_Sample_App
Android Studio → File → Open → select the cloned folder → Sync Project with Gradle Files.
The sample demonstrates microphone NC, video/file denoise, and in-app API snippets (Audio · Video · How to Use tabs).
Verify dependency
import com.fiveexceptions.nckit.NCKitProcessor
import com.fiveexceptions.nckit.NCKitModelLocator
import com.fiveexceptions.nckit.NCKitFileProcessor
Public API checklist
val model = NCKitModelLocator.modelFile(context)
NCKitProcessor(model, attenLimDb = 100f, postFilterBeta = 0f).use { processor ->
NCKitFileProcessor.processFile(inputWav, outputWav, processor)
}
Run on API 26+ device or emulator (arm64-v8a or x86_64).
Coverage map (sample app ↔ SDK)
| Sample feature | Source file | NCKit SDK API | Docs |
|---|---|---|---|
| Maven dependency | app/build.gradle.kts | com.5exceptions:nckit:1.1.2 | Gradle (Android) |
| Load model on startup | AudioEngine.loadModel() | NCKitModelLocator.modelFile | NCKitModelLocator |
| Create processor once | NckitProcessorFactory | NCKitProcessor(...) | NCKitProcessor |
| Live mic denoise | AudioEngine | NCKitStreamProcessor / processFrame | NCKitStreamProcessor |
| Bypass NC (listen raw) | AudioEngine.setNcEnabled | pass-through copy | How to Use |
| Runtime attenuation | (fixed 100 in sample; API supports change) | setAttenLim, setPostFilterBeta | NCKitProcessor |
| Record original + enhanced WAV | AudioEngine.stop() | processFrame + WavWriter | How to Use |
| Denoise audio/video file | VideoProcessor / file pick | NCKitFileProcessor.processFile | NCKitFileProcessor |
| Speech makeup gain | VideoProcessor.applyMakeupGain | NCKitAudioNormalizer | NCKitAudioNormalizer |
| Share WAV / video | FileProvider | — (app I/O) | How to Use |
| Save video to gallery | VideoProcessor.saveEnhancedToGallery | — (MediaStore) | How to Use |
| In-app API cheatsheet | HowToUseScreen | all public APIs | How to Use |
| Typed errors | try/catch in engines | NCKitException | NCKitError / NCKitException |
Run the sample app
1. Clone the repository
git clone https://github.com/5Exceptions-Mobile-Team/Nckit_Android_Sample_App.git
cd Nckit_Android_Sample_App
2. Open and sync
Android Studio → File → Open → cloned Nckit_Android_Sample_App folder → Sync Project with Gradle Files.
3. Run
- Device arm64-v8a recommended
- Emulator: arm64-v8a or x86_64
- Grant Microphone (Audio tab) and pick a video (Video tab)
Tabs in the sample: Audio · Video · How to Use (mirrors this documentation).
Integration details
Full integration code moved to dedicated pages:
- Gradle (Android) — Maven credentials + dependency
- How to Use — file, live mic, and video paths
- API Reference — complete Kotlin API docs