History

Alexander Capehart 5e7d575efd build: fix cpp formatting		2024-12-26 18:53:24 -05:00
..
src	build: fix cpp formatting	2024-12-26 18:53:24 -05:00
.gitignore	all: break off musikr	2024-12-16 13:09:08 -05:00
.Rhistory	all: break off musikr	2024-12-16 13:09:08 -05:00
build.gradle	build: share desugaring version	2024-12-21 12:11:32 -05:00
consumer-rules.pro	musikr: fix more taglib jni mismatches	2024-12-23 10:04:41 -05:00
proguard-rules.pro	musikr: fix more taglib jni mismatches	2024-12-23 10:04:41 -05:00
README.md	musikr: update readme	2024-12-23 10:05:48 -05:00

README.md

musikr

Musikr is a highly opinionated multithreaded music loader that enables Auxio's advanced music functionality. It completely bypasses Android's MediaStore and uses the storage access framework (SAF) and taglib to replicate it's functionality with less bugs and more flexibility, further expanding it with an advanced music model that leverages the wide variety of tags available in modern extended specs.

Warning that the API surface is:

Extremely unstable, as it's a very thin shim on top of a constantly optimzied and updated music loader
Minimized to only what the rest of the app uses or builds on, so you will need to patch it to extend certain components

Feel free to use this library as long as you follow Auxio's GPLv3 license and open-source all modifications.

If you want to generate some docs for the unstable API, you can run

./gradlew musikr:dokkaGeneratePublicationHtml

In the project root and it should produce a webpage in musikr/build/dokka/html