docs: update docs
Update general user-facing documentation in preperation for 2.0.0.
This commit is contained in:
OxygenCobalt
parent
6a03781750
commit
282933fb37
7 changed files with 58 additions and 58 deletions
12
README.md
12
README.md
|
|
@ -10,7 +10,7 @@
|
|||
</a>
|
||||
<img alt="Minimum SDK" src="https://img.shields.io/badge/API-21%2B-32B5ED">
|
||||
</p>
|
||||
<h4 align="center"><a href="/info/FAQ.md">FAQ</a> / <a href="/info/FORMATS.md">Formats</a> / <a href="/info/LICENSES.md">Licenses</a> / <a href="/.github/CONTRIBUTING.md">Contributing</a></h4>
|
||||
<h4 align="center"><a href="/info/FAQ.md">FAQ</a> | <a href="/info/LICENSES.md">Licenses</a> | <a href="/.github/CONTRIBUTING.md">Contributing</a> | <a href="/info/ARCHITECTURE.md">Architecture</a></h4>
|
||||
<p align="center">
|
||||
<a href="https://f-droid.org/app/org.oxycblt.auxio"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" width="170"></a>
|
||||
</p>
|
||||
|
|
@ -39,13 +39,13 @@ I primarily built Auxio for myself, but you can use it too, I guess.
|
|||
- [ExoPlayer](https://exoplayer.dev/) based playback
|
||||
- Customizable UI & Behavior
|
||||
- Genres/Artists/Albums/Songs support
|
||||
- Extensive queue system
|
||||
- Full playback persistence system
|
||||
- Intuitive queue system
|
||||
- Reliable playback state persistence
|
||||
- Edge-to-edge (Oreo+ Only)
|
||||
- Embedded covers support
|
||||
- Search Functionality
|
||||
- Audio Focus / Headset Management
|
||||
- No internet connectivity whatsoever
|
||||
- Audio/Headset focus
|
||||
- Completely private and offline
|
||||
- No rounded album covers
|
||||
|
||||
## To possibly come in the future:
|
||||
|
|
@ -54,7 +54,7 @@ I primarily built Auxio for myself, but you can use it too, I guess.
|
|||
- Liked songs
|
||||
- Improved tablet layouts
|
||||
- More notification actions
|
||||
- Other things, possibly
|
||||
- And other things, probably
|
||||
|
||||
## Permissions
|
||||
|
||||
|
|
|
|||
|
|
@ -4,11 +4,11 @@
|
|||
android:initialLayout="@layout/widget_medium"
|
||||
android:minResizeWidth="@dimen/widget_width_min"
|
||||
android:minResizeHeight="@dimen/widget_height_min"
|
||||
android:minWidth="@dimen/widget_width_def"
|
||||
android:minHeight="@dimen/widget_height_def"
|
||||
android:previewLayout="@layout/widget_medium"
|
||||
android:previewImage="@drawable/ui_widget_preview"
|
||||
android:resizeMode="horizontal|vertical"
|
||||
android:minWidth="@dimen/widget_width_def"
|
||||
android:minHeight="@dimen/widget_height_def"
|
||||
android:targetCellWidth="3"
|
||||
android:targetCellHeight="3"
|
||||
android:updatePeriodMillis="0"
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
android:initialLayout="@layout/widget_medium"
|
||||
android:minWidth="@dimen/widget_width_min"
|
||||
android:minResizeWidth="@dimen/widget_width_min"
|
||||
android:minResizeHeight="@dimen/widget_height_min"
|
||||
android:minWidth="@dimen/widget_width_def"
|
||||
android:minHeight="@dimen/widget_height_def"
|
||||
android:minResizeWidth="@dimen/widget_width_def"
|
||||
android:minResizeHeight="@dimen/widget_width_min"
|
||||
android:previewImage="@drawable/ui_widget_preview"
|
||||
android:resizeMode="horizontal|vertical"
|
||||
android:updatePeriodMillis="0"
|
||||
|
|
|
|||
|
|
@ -22,9 +22,9 @@ This does not rule out these additions, but they are not accepted as often as ot
|
|||
Feel free to fork Auxio to add your own feature set however.
|
||||
|
||||
#### Additions that have already been rejected:
|
||||
- Lyrics [#19]
|
||||
- Recently added list [#18]
|
||||
- Folder View/Grouping [#10]
|
||||
- ReplayGain [#7]
|
||||
- Folder View/Grouping [#10]
|
||||
- Recently added list [#18]
|
||||
- Lyrics [#19]
|
||||
- Tag editing [#33]
|
||||
- Specialized queue adding (ex. Play Next) [#44]
|
||||
67
info/FAQ.md
67
info/FAQ.md
|
|
@ -4,46 +4,67 @@ For a list of **supported formats** read [Supported Formats](FORMATS.md)
|
|||
|
||||
This FAQ will be continually updated as new changes and updates are made to Auxio.
|
||||
|
||||
## What is Auxio?
|
||||
|
||||
Auxio is local music player for android that I built for myself, primarily. Its designed to avoid a lot of the feature-bloat and frustrating UX that other FOSS music players have, while still remaining customizable to an extent.
|
||||
|
||||
## Where can I download Auxio?
|
||||
#### Where can I download Auxio?
|
||||
|
||||
Auxio is available on the [F-Droid](https://f-droid.org/en/packages/org.oxycblt.auxio/) repository.
|
||||
Auxio is not and will never be on the play store due to it being a proprietary and draconian platform.
|
||||
|
||||
## Can I translate Auxio to my native language?
|
||||
#### Auxio doesn't load my music correctly!
|
||||
|
||||
See the [Translations](https://github.com/OxygenCobalt/Auxio/issues/3) issue for guidance on how to create translations and submit them to the project. Any contributions are appreciated and
|
||||
tend to always be accepted.
|
||||
This is probably caused by one of two reasons:
|
||||
|
||||
## How can I contribute/report issues?
|
||||
1. If other players like Phonograph or Retro Music load it correctly, then Auxio has a bug and it should be [reported](https://github.com/OxygenCobalt/Auxio/issues).
|
||||
2. If the aforementioned players don't work, but players like Vanilla Music and VLC do, then it's a problem with the Media APIs that Auxio relies on. There is nothing I can do about it.
|
||||
|
||||
Open an [Issue](https://github.com/OxygenCobalt/Auxio/issues) or a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls), please note the [Contribution Guidelines](../.github/CONTRIBUTING.md) and [Accepted Additions](ADDITIONS.md) however.
|
||||
#### I have a large library and Auxio takes really long to load it!
|
||||
|
||||
## Why ExoPlayer?
|
||||
This is expected since reading media takes awhile, especially with libraries containing 10k songs or more.
|
||||
I do hope to mitigate this in the future by allowing one to customize the music loader to optimize for speed instead of accuracy.
|
||||
|
||||
ExoPlayer is far more flexible than the native MediaPlayer API, which allows consistent behavior across devices & OEMs amd the ability to be extended to music sources outside of local files. You can read more about the benefits (and drawbacks) of ExoPlayer [Here](https://exoplayer.dev/pros-and-cons.html).
|
||||
#### Why ExoPlayer?
|
||||
|
||||
## Why cant I have a custom accent?
|
||||
ExoPlayer is far more flexible than the native MediaPlayer API, which allows consistent behavior across devices & OEMs and the
|
||||
ability to be extended to music sources outside of local files. You can read more about the benefits (and drawbacks) of ExoPlayer
|
||||
[Here](https://exoplayer.dev/pros-and-cons.html).
|
||||
|
||||
Android themes can't be modified dynamically, making applying a custom theme nearly impossible without duplicating code and having an extremely brittle system. Therefore its not implemented.
|
||||
This may change in Android 12 however, if google exposes the APIs for Material U coloring.
|
||||
#### What formats does Auxio support?
|
||||
|
||||
## Why are accents lighter/less saturated in dark mode?
|
||||
As per the [Supported ExoPlayer Formats](https://exoplayer.dev/supported-formats.html), Auxio supports the following:
|
||||
|
||||
As per the [Material Guidelines](https://material.io/design/color/dark-theme.html), accents should be less saturated on dark mode to reduce eye strain and to make it look better in general.
|
||||
✅ = Supported
|
||||
|
||||
## Why isn't edge-to-edge enabled on versions below Oreo?
|
||||
👎 = Not supported well
|
||||
|
||||
The APIs for changing system bar colors were only added in API Level 27 (Oreo MR1), meaning that edge-to-edge will not work below that version.
|
||||
| Format | Supported | Comments |
|
||||
|--------|-----------|-----------
|
||||
| MP4 | ✅ | |
|
||||
| MP3 | ✅ | |
|
||||
| MKA | ✅ | |
|
||||
| OGG | ✅ | Containing Vorbis, Opus, and FLAC |
|
||||
| WAV | ✅ | |
|
||||
| MPEG | ✅ | |
|
||||
| AAC | ✅ | |
|
||||
| FLAC | 👎 | Supported on Android 8.1 or newer. Auxio must be patched with the [FLAC Extension](https://github.com/google/ExoPlayer/tree/release-v2/extensions/flac) on lower versions. |
|
||||
|
||||
I could possibly extend edge-to-edge support to earlier versions, but it would take awhile.
|
||||
#### Why are accents lighter/less saturated in dark mode?
|
||||
|
||||
## Why doesn't edge-to-edge work when my phone is in landscape?
|
||||
As per the [Material Design Guidelines](https://material.io/design/color/dark-theme.html), accents should be less
|
||||
saturated on dark mode to reduce eye strain and to increase visual cohesion.
|
||||
|
||||
When a *phone* [Not a tablet] is in landscape, the insets meant to make the UI fit don't work properly, therefore the feature is mostly disabled.
|
||||
#### Why isn't edge-to-edge enabled on versions below Oreo?
|
||||
|
||||
## Does this app keep/send any information about myself or my device?
|
||||
The APIs for changing system bar colors were only added in API Level 27 (Android Oreo), meaning that edge-to-edge will not work below that version.
|
||||
|
||||
#### Does this app keep/send any information about myself or my device?
|
||||
|
||||
Auxio does not log any information about the device or its owner, and it has no internet access to send that information off in the first place.
|
||||
|
||||
#### How can I contribute/report issues?
|
||||
|
||||
Open an [Issue](https://github.com/OxygenCobalt/Auxio/issues) or a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls),
|
||||
please note the [Contribution Guidelines](../.github/CONTRIBUTING.md) and [Accepted Additions](ADDITIONS.md) however.
|
||||
|
||||
#### Can I translate Auxio to my native language?
|
||||
|
||||
See the [Translations](https://github.com/OxygenCobalt/Auxio/issues/3) issue for guidance on how to create translations and submit them to the project.
|
||||
Any contributions are appreciated and tend to always be accepted.
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
# Supported Formats
|
||||
|
||||
Auxio is based off [ExoPlayer](https://exoplayer.dev/), which provides greater flexibility and consistency with how Auxio plays music.
|
||||
|
||||
Here are the music formats that Auxio supports, as per the [Supported ExoPlayer Formats](https://exoplayer.dev/supported-formats.html):
|
||||
|
||||
✅ = Supported
|
||||
|
||||
👎 = Not supported well
|
||||
|
||||
| Format | Supported | Comments |
|
||||
|--------|-----------|-----------
|
||||
| MP4 | ✅ | |
|
||||
| MP3 | ✅ | |
|
||||
| MKA | ✅ | |
|
||||
| OGG | ✅ | Containing Vorbis, Opus, and FLAC |
|
||||
| WAV | ✅ | |
|
||||
| MPEG | ✅ | |
|
||||
| AAC | ✅ | |
|
||||
| FLAC | 👎 | Supported on Android 8.1 or newer. Auxio must be patched with the [FLAC Extension](https://github.com/google/ExoPlayer/tree/release-v2/extensions/flac) on lower versions. |
|
||||
|
|
@ -7,4 +7,3 @@ Auxio uses a number of third-party libraries, which are listed below with their
|
|||
| [ExoPlayer](https://github.com/google/ExoPlayer) | [Google](https://github.com/google) | Music Playback | Apache-2.0 |
|
||||
| [Coil](https://github.com/coil-kt/coil) | [coil-kt](https://github.com/coil-kt) | Image Loading | Apache-2.0 |
|
||||
| [ktlint](https://github.com/pinterest/ktlint) | [Pinterest](https://github.com/pinterest) | Code Formatting | MIT |
|
||||
| [LeakCanary](https://github.com/square/leakcanary) | [Square](https://github.com/square) | Memory leak detection | Apache-2.0 |
|
||||
Loading…
Reference in a new issue