Fabio/Auxio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

musikr: update readme

Browse source
This commit is contained in:
Alexander Capehart 2024-12-23 10:05:48 -05:00
parent b6cbf97df9
commit 046a02de00
No known key found for this signature in database
GPG key ID: 37DBE3621FE9AD47
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
musikr/README.md
View file

@ -1,14 +1,15 @@
# musikr
Musikr is a highly opinionated multithreaded music library that enables Auxio's advanced music functionality.
It completely bypasses Android's MediaStore and uses the [storage access framework (SAF)](), [taglib]() to
replicate it's functionality with less bugs and more flexibility, further expanding it with an advanced music
model that is both fast and leverages some of the nice features within the MusicBrainz spec.
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)](https://developer.android.com/guide/topics/providers/document-provider)
and [taglib](https://taglib.org/) 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.
There's not really a stable API surface for musikr right now, given that the music loader is still being
optimized and the rest of Auxio's modularization efforts are still in progress. Lots of useful stuff is
hidden, and lots of useless stuff is exposed. Eventually the API will start settling down into something
usable, but it will still require patches for your own project.
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.