-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for rockbox_coverart extension
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Rockbox Cover Art Sync | ||
--- | ||
|
||
This extension writes podcast subscription cover art to a media player. | ||
This extension assumes that each podcast has its own folder on device. | ||
Only folder-wide coverart is written - this extension does not do anything about | ||
embedded cover art. | ||
|
||
Cover art is converted to the desired file format and image size | ||
via the python "pillow" module, and written to the desired filename. | ||
|
||
Existing files (of the correct name) will be checked to see if they | ||
need to be overwritten to conform to the size, baseline/progressive, | ||
and file format parameters. | ||
|
||
All jpegs will be written as "baseline" (rather than "progressive") type. Rockbox | ||
only supports baseline jpegs. | ||
|
||
## Dependencies | ||
|
||
Requires python modules `pillow` and `filelock`. These are available on pip. | ||
|
||
## Settings | ||
|
||
| setting | value | description | | ||
|---------|-------|-------------| | ||
| extensions.rockbox_coverart.art_name_on_device | cover.jpg | Desired filename on device. Only jpg, jpeg, and png filetypes allowed. | | ||
| extensions.rockbox_coverart.convert_and_resize_art | **True**/False | Enable conversion and resize operations | | ||
| extensions.rockbox_coverart.convert_size | 500 | Cover art will be resized to this size (square). If convert_allow_upscale_art=False, art smaller than this size will retain its size. Only used if convert_and_resize_art=True. | | ||
| extensions.rockbox_coverart.convert_allow_upscale_art | True/**False** | Allow upscaling of art. If set to true, will allow images smaller than convert_size (square) to be upscaled to convert_size. Only used if convert_and_resize_art=True. | | ||
|
||
Links: | ||
|
||
- [Extension Source](https://github.com/gpodder/gpodder/blob/master/share/gpodder/extensions/rockbox_coverart.py) |