AstroPlayer is an open-source media player designed for the Kotlin Multiplatform. It provides a simple API for audio playback, supports multiple media formats, and offers a Jetpack Compose UI.
Key Features:
Packages:
astroplayer-core
: Contains the core player logic.astroplayer-ui
: Provides the Jetpack Compose UI components for playback control. While the package currently provides a limited set of media player control components,
I am actively considering expanding its functionality in future releases.Documentation:
Detailed documentation regarding astroplayer can be found here.
Important Note: AstroPlayer is currently under active development. This means there may be some errors, unimplemented methods, and limitations in functionality. I are actively testing the core functionalities and working towards a stable release.
Current Status:
Publishing to Maven Central:
Once the core functionalities are thoroughly tested and stabilized, I plan to publish AstroPlayer to Maven Central for wider accessibility.
Publishing Locally to Maven Repository
To publish locally to your Maven repository, you can leverage the Gradle task publishToMavenLocal for the required modules
Or use this to publish all the modules to Maven Local
gradle astroplayer-core:publishToMavenLocal astroplayer-ui:publishToMavenLocal
By running these tasks, you'll deploy the respective modules to your local Maven repository, making them readily available for your project's development and testing purposes.
For comprehensive instructions, refer to the Gradle documentation on publishing to Maven repositories.
Installation:
AstroPlayer is published to Maven Central. To add it to your project, include the following dependencies in your build.gradle
file:
sourceSets {
commonMain.dependencies {
// TODO : Replace this with cords
implementation("com.example.astroplayer:astroplayer-core:$astroplayer_vesion")
implementation("com.example.astroplayer:astroplayer-ui:$astroplayer_vesion")
}
}
Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.
AstroPlayer is licensed under the Apache License 2.0. See the LICENSE file for details.