Skip to content

Commit 2ee8675

Browse files
committed
Add documentation for rockbox_coverart extension
1 parent 99752f7 commit 2ee8675

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/extensions/rockbox_coverart.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Rockbox Cover Art Sync
3+
---
4+
5+
This extension writes podcast subscription cover art to a media player.
6+
This extension assumes that each podcast has its own folder on device.
7+
Only folder-wide coverart is written - this extension does not do anything about
8+
embedded cover art.
9+
10+
Cover art is converted to the desired file format and image size
11+
via the python "pillow" module, and written to the desired filename.
12+
13+
Existing files (of the correct name) will be checked to see if they
14+
need to be overwritten to conform to the size, baseline/progressive,
15+
and file format parameters.
16+
17+
All jpegs will be written as "baseline" (rather than "progressive") type. Rockbox
18+
only supports baseline jpegs.
19+
20+
## Dependencies
21+
22+
Requires python modules `pillow` and `filelock`. These are available on pip.
23+
24+
## Settings
25+
26+
| setting | value | description |
27+
|---------|-------|-------------|
28+
| extensions.rockbox_coverart.art_name_on_device | cover.jpg | Desired filename on device. Only jpg, jpeg, and png filetypes allowed. |
29+
| extensions.rockbox_coverart.convert_and_resize_art | **True**/False | Enable conversion and resize operations |
30+
| 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. |
31+
| 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. |
32+
33+
Links:
34+
35+
- [Extension Source](https://github.com/gpodder/gpodder/blob/master/share/gpodder/extensions/rockbox_coverart.py)

0 commit comments

Comments
 (0)