Minimalistic audio player library enabling audio playback without UI, wrapping native functionality in "headless" mode. Compatible with various platforms and includes examples for Jetpack Compose integration.
Gadulka is a minimalistic audio player library for Kotlin Multiplatform.
Gadulka wraps the native player functionality from each target in "headless" mode. That is, the library does not provide any UI (this will be up to you). You can read more about my motivations here.
Gadulka is available from Maven Central at the following coordinates:
implementation("eu.iamkonstantin.kotlin:gadulka:1.12.0")
Instantiate the player and call play!
val player = GadulkaPlayer()
player.play(url = "...")
player.stop()
player.release()
Example using Jetpack Compose:
@Composable
fun AudioPlayer() {
val player = rememberGadulkaState()
Row {
Button(
onClick = {
player.play(
"https://download.samplelib.com/wav/sample-12s.wav"
)
}) {
Text("Play")
}
Button(
onClick = {
player.stop()
}) {
Text("Stop")
}
}
}
Et voilà, enjoy the library and feel free to open an issue with any questions, thoughts or comments you may have!
If you would like to track the state of the player (e.g. in a composable), Gadulka comes with a simple convenience function which queries the player state every 300ms:
@Composable
fun AudioPlayer() {
val gadulka = rememberGadulkaLiveState()
Column {
Text(gadulka.state.name)
Text("Volume: ${gadulka.volume}")
Text("Position: ${gadulka.position / 1000}s / s")
Row {
Button(
onClick = {
player.play(
)
}) {
Text()
}
Button(
onClick = {
player.stop()
}) {
Text()
}
}
}
}
Additional methods to control volume, position and playback rate are also available.
Gadulka links against but doesn't bundle JavaFX. You may need to adapt your gradle file to add the corresponding dependencies e.g.:
📖 Docs
Gadulka is a traditional Bulgarian bowed string instrument. It's a tiny music instrument which aligned well with the mindset of the library and why the name was chosen.
While my personal projects use a self-hosted Forgejo or take advantage of the fantastic offering of Codeberg, the CI pipeline for Gadulka requires a macOS build in order to test iOS compatibility. This is a very intensive (and expensive) run for which GitHub makes more sense. Of course, this is something that can change in the future.
The library is licensed with the BSD-3-Clause license, more information in LICENSE.
This is a permissive license which allows for any type of use, provided the copyright notice is included.
This library project was initially created from JetBrains's Library Template under the Apache 2.0 license.
To achieve its purpose, Gadulka relies on a number of libraries. A SBOM report is available in JSON and XML for a complete list.
Specific license terms:
val jvmMain by getting {
dependencies {
val fxSuffix = when (osdetector.classifier) {
"linux-x86_64" -> "linux"
"linux-aarch_64" -> "linux-aarch64"
"windows-x86_64" -> "win"
"osx-x86_64" -> "mac"
"osx-aarch_64" -> "mac-aarch64"
else -> throw IllegalStateException("Unknown OS: ${osdetector.classifier}")
}
implementation("org.openjfx:javafx-base:23:${fxSuffix}")
implementation("org.openjfx:javafx-graphics:23:${fxSuffix}")
implementation("org.openjfx:javafx-controls:23:${fxSuffix}")
implementation("org.openjfx:javafx-swing:23:${fxSuffix}")
implementation("org.openjfx:javafx-web:23:${fxSuffix}")
implementation("org.openjfx:javafx-media:23:${fxSuffix}")
}
}
Surfaced from shared tags and platforms — no rankings paid for.