Frequently Asked Questions
Does audio leave the device?โ
No. NCKit runs entirely on-device on iOS and Android. Audio is never uploaded to a cloud service for processing.
What input formats are supported?โ
text
Any format AVFoundation can decode โ WAV, M4A, AAC, CAF, MP3, MP4 with audio.
text
Any format MediaExtractor / MediaCodec can decode โ WAV, M4A, AAC, MP3, MP4 with audio.
NCKit resamples to 48 kHz mono internally before inference.
Does NCKit work in the simulator / emulator?โ
text
Yes on Apple Silicon (`arm64`) and Intel Mac (`x86_64`) simulators with **NCKit 1.2.1+**
(`ios-arm64_x86_64-simulator`). Older releases: arm64 simulator only โ see the Simulator guide.
text
Yes on arm64-v8a devices and x86_64 / arm64 emulators with a supported system image.
Which distribution method should I use?โ
| Platform | Recommended | Private repo |
|---|---|---|
| iOS | Swift Package Manager | NCKit |
| Android | Gradle (Maven com.5exceptions:nckit) | NCKit_Android |
See Installation.
How large is the bundled model?โ
text
~8.5 MB (NCKit_model.tar.gz inside NCKit.xcframework). No runtime download.
text
~7.6 MB (DeepFilterNet3_onnx in AAR assets). Extracted to cache on first use.
Can I use NCKit for real-time microphone processing?โ
Yes. Call processFrame on 48 kHz mono hops of frameLength (480) samples. See NCKitProcessor.
What are the minimum requirements?โ
See Requirements. Use the iOS / Android toggle for platform-specific versions.
How do I handle errors?โ
text
All NCKit operations throw NCKitError.
text
All NCKit operations throw NCKitException subclasses.
See NCKitError.
Where can I see a working example?โ
- iOS: NCKit_Demo โ
NCKitSample.xcodeproj - Android: NCKit_Android
See Sample App.