Skip to content

Commit 2ea5acd

Browse files
committed
clarify jpeg operation and settings add versions
1 parent fea3a27 commit 2ea5acd

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/extensions/tagging.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ artwork will be preferred if it is present - if not, the channel artwork will be
2323
Note that episode-specific artwork in MP4 files is currently not implemented.
2424

2525
The artwork can optionally be normalized to the desired parameters - size and file type.
26-
By default, it will write 500px baseline JPEGs.
26+
By default, it will baseline JPEGs with the larger side scaled to 500px with the aspect ratio maintained.
2727

2828
This extension can optionally remove all tags instead of doing any of the above.
2929
This is disabled by default.
@@ -37,21 +37,21 @@ This extension requires python modules `mutagen` and `pillow`.
3737
| extensions.tagging.strip\_album\_from\_title | **true**/false | Remove the Album tag from the Title tag if the Title begins with the same string as the Album tag | all |
3838
| extensions.tagging.genre\_tag | Podcast | Value for the Genre tag | all |
3939
| extensions.tagging.always\_remove\_tags | true/**false** | Remove all tags instead of creating/adding tag information | 3.5.0 and newer |
40-
| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | git master branch |
41-
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch |
42-
| extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | git master branch |
43-
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch |
44-
| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed cover art in file | git master branch |
45-
| extensions.tagging.prefer\_channel\_coverart | true/**false** | Prefer embedding the channel coverart if available over the episode coverart | git master branch |
46-
| extensions.tagging.normalize\_coverart | **true**/false | Normalize the coverart to the desired size and file type before embedding it | git master branch |
47-
| extensions.tagging.episode\_coverart\_size | 500 | Desired size (in pixels) of coverart. Only used if normalize\_coverart is True | git master branch |
48-
| extensions.tagging.episode\_coverart\_filetype | 0 (JPEG) | Desired filetype of coverart. integer value, maps to 0=JPEG, 1=PNG. Only used if normalize\_coverart is True | git master branch |
49-
| extensions.tagging.write\_title | **True**/False | Write the title field | git master branch |
50-
| extensions.tagging.write\_album | **True**/False | Write the album field | git master branch |
51-
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | git master branch |
52-
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | git master branch |
53-
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | git master branch |
54-
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | git master branch |
40+
| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | 3.9.3 and newer |
41+
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | 3.10.8 and newer |
42+
| extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | 3.10.8 and newer |
43+
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | 3.11.1 and newer |
44+
| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed cover art in file | 3.9.4 and newer |
45+
| extensions.tagging.prefer\_channel\_coverart | true/**false** | Prefer embedding the channel coverart if available over the episode coverart | newer than 3.11.5 |
46+
| extensions.tagging.normalize\_coverart | **true**/false | Normalize the coverart to the desired size and file type before embedding it | newer than 3.11.5 |
47+
| extensions.tagging.episode\_coverart\_size | 500 | Desired size (in pixels) of coverart. Only used if normalize\_coverart is True | newer than 3.11.5 |
48+
| extensions.tagging.episode\_coverart\_filetype | 0 (JPEG) | Desired filetype of coverart. integer value, maps to 0=JPEG, 1=PNG. Only used if normalize\_coverart is True | newer than 3.11.5 |
49+
| extensions.tagging.write\_title | **True**/False | Write the title field | newer than 3.11.5 |
50+
| extensions.tagging.write\_album | **True**/False | Write the album field | newer than 3.11.5 |
51+
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | newer than 3.11.5 |
52+
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | newer than 3.11.5 |
53+
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | newer than 3.11.5 |
54+
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | newer than 3.11.5 |
5555

5656

5757

0 commit comments

Comments
 (0)