wav-recorder
0.1.1indexedLightweight audio capture producing canonical 16-bit mono WAV buffers for transcription and AI pipelines, with unified API and extensible event hooks for error handling.
0
Stars
—
Used by
dependents
—
Health
/ 100
Wav Recorder
Wav Recorder is a lightweight Kotlin Multiplatform library that captures audio from the system microphone and returns it as a WAV-formatted kotlinx.io.Buffer. It focuses on predictable WAV output for speech pipelines and AI-driven applications without bundling higher-level speech tooling.
Features
- Unified API – obtain a
Recorderinstance viaplatformRecorder, start/stop, and receive a WAV buffer you can persist or stream.
Getting Started
Gradle Setup (Kotlin DSL)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("de.findusl:wav-recorder:0.1.1")
}
}
}
Ensure mavenCentral() is present in your repository list.
Quick Usage
import de.findusl.wavrecorder.platformRecorder
import kotlinx.io.readByteArray
val recorder = platformRecorder
require(recorder.isAvailable) { "Recording is not supported on this device." }
recorder.startRecording()
// ... wait or collect input ...
val wavBuffer = recorder.stopRecording().getOrThrow()
val wavBytes: ByteArray = wavBuffer.readByteArray()
recorder.close()
- Android callers must request
android.permission.RECORD_AUDIObefore invokingstartRecording(). - Always call
close()when you no longer need the recorder to release microphone resources.
Handling Errors
Implement WavRecorderEventHandler (assign to WavRecorderEventHandler.INSTANCE) to surface issues such as Windows initialisation problems or runtime recording failures:
WavRecorderEventHandler.INSTANCE = object : WavRecorderEventHandler {
override fun failedToInitializeOnWindows(e: Exception) {
// Show a toast, log to analytics, etc.
}
override fun errorWhileRecording(e: Exception) { /* ... */ }
}
Platform Notes
- Android – Uses
AudioRecord, dynamically picks a supported sample rate, outputs mono, 16-bit WAV. - Windows – Relies on
javax.sound.sampled.TargetDataLinewith a 44.1 kHz mono configuration.
Roadmap / Contributions
Planned improvements include native backends (Linux/iOS) and higher-level streaming helpers. Issues and pull requests are welcome—check the existing workflows in .github/workflows if you plan to extend CI or publishing.
License
This project is licensed under the MIT License.