https://github.com/kkostov/gadulka

A minimalistic player library for Kotlin Multiplatform. It targets Android, jvm and iOS, allowing consumers to play audio files
https://github.com/kkostov/gadulka

android audio audio-player ios jvm kmp kotlin kotlin-multiplatform

Last synced: 21 days ago
JSON representation

A minimalistic player library for Kotlin Multiplatform. It targets Android, jvm and iOS, allowing consumers to play audio files

• Host: GitHub
• URL: https://github.com/kkostov/gadulka
• Owner: kkostov
• License: bsd-3-clause
• Created: 2024-10-27T14:08:47.000Z (24 days ago)
• Default Branch: main
• Last Pushed: 2024-10-30T12:11:56.000Z (21 days ago)
• Last Synced: 2024-10-30T12:33:58.973Z (21 days ago)
• Topics: android, audio, audio-player, ios, jvm, kmp, kotlin, kotlin-multiplatform
• Language: Kotlin
• Homepage:
• Size: 282 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


 








![Maven Central Version](https://img.shields.io/maven-central/v/eu.iamkonstantin.kotlin/gadulka)

[![Build](https://github.com/kkostov/gadulka/actions/workflows/gradle.yml/badge.svg)](https://github.com/kkostov/gadulka/actions/workflows/gradle.yml)

# Gadulka

## What is it?

Gadulka is a minimalistic player library for Kotlin Multiplatform. It targets Android, jvm and iOS, allowing consumers

to play audio files.

To achieve this, 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).

## Getting Started

Gadulka is available from Maven Central at the following coordinates:

```

implementation("eu.iamkonstantin.kotlin:gadulka:1.1.0")

```

Instantiate the player and call play!

```kotlin

val player = GadulkaPlayer()

player.play(url = "...")

player.stop()

player.release()

```

Example using Jetpack Compose:

```kotlin

@Composable

fun AudioPlayer(player: GadulkaPlayer = GadulkaPlayer()) {

    val url = remember { mutableStateOf("https://download.samplelib.com/wav/sample-12s.wav") }

    Row {

        Button(

            onClick = {

                player.play(

                    url

                )

            }) {

            Text("Play")

        }

        Button(

            onClick = {

                player.stop()

            }) {

            Text("Stop")

        }

    }

}

```

For Android, the player needs a reference to the android context. For example, using Koin (or another DI library):

```kotlin

factory {

    GadulkaPlayer(androidContext())

} onClose {

    it?.release()

}

```

**Et voilà, enjoy the library and feel free to open an issue with any questions, thoughts or comments you may have!**

## About the name

Gadulka [is a traditional Bulgarian](https://en.wikipedia.org/wiki/Gadulka) bowed string instrument. It's a tiny music

instrument which aligned well with the mindset of the library and why the name was chosen.

## Why on GitHub

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.

## License 📃

The library is licensed with the BSD-3-Clause license, more information in [LICENSE](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](https://github.com/Kotlin/multiplatform-library-template) under the Apache 2.0 license.