Skip to content

Commit cec67ef

Browse files
committed
Update tagging extension documentation
1 parent 99752f7 commit cec67ef

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

docs/extensions/tagging.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,49 @@
22
title: Tag downloaded files using Mutagen
33
---
44

5-
Add episode and podcast titles to MP3/OGG tags
5+
Add episode and podcast titles to MP3/OGG tags.
6+
7+
By default, this extension will:
8+
- Remove existing tags
9+
- Write the Title tag, stripping the album from the beginning of the Title if necessary
10+
- Write the Album tag
11+
- Write the Artist tag (with the same string as the Album tag)
12+
- Write the Genre (to "Podcast", configurable)
13+
- Write the publish date
14+
15+
Also available are writing the Subtitle tag and the Comments tag (both with the
16+
subtitle field), but the subtitile is often so long that it may cause problems with
17+
certain audio players, such as Rockbox players. These are disabled by default.
18+
19+
This extension can optionally embed coverart - note that the coverart will not be
20+
standardized in any way, so Rockbox users be wary. This is disabled by default.
21+
22+
This extension can optionally remove all tags instead of doing any of the above.
23+
This is disabled by default.
24+
25+
## Dependencies
26+
27+
This extension requires python module `mutagen`.
628

729
| setting | value | description | version |
830
|----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------|
9-
| extensions.tagging.always\_remove\_tags | true/false | true = extension removes all tags instead of creating/adding tag information | 3.5.0 |
10-
| extensions.tagging.auto\_embed\_coverart | true/false | true = extension adds existing coverart after download | git master branch |
11-
| extensions.tagging.genre\_tag | Genre | with this setting you can define the genre tag. Default = Podcast | all |
12-
| extensions.tagging.strip\_album\_from\_title | true/false | true = removes the album name from the episode if the episode begins with the album title | all |
31+
| extensions.tagging.strip\_album\_from\_title | **true**/false | true = removes the Album tag from the Title tag if the Title begins with the same string as the Album tag | all |
32+
| extensions.tagging.genre\_tag | Podcast | Sets the Genre tag. Default = Podcast | all |
33+
| extensions.tagging.always\_remove\_tags | true/**false** | true = extension removes all tags instead of creating/adding tag information | 3.5.0 |
34+
| extensions.tagging.auto\_embed\_coverart | true/**false** | true = embed channel cover art in file. | git master branch |
35+
| extensions.tagging.set\_artist\_to\_album | **True**/False | True = set the Artist tag to the same as the existing Album tag. | git master branch |
36+
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch |
37+
| 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 |
38+
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch |
39+
| extensions.tagging.write\_title | **True**/False | True = write the title field | git master branch |
40+
| extensions.tagging.write\_album | **True**/False | True = write the album field | git master branch |
41+
| extensions.tagging.write\_subtitle | True/**False** | True = write the subtitle field | git master branch |
42+
| extensions.tagging.write\_comments | True/**False** | True = write the comments field (with the subtitle) | git master branch |
43+
| extensions.tagging.write\_genre | **True**/False | True = write the genre with the genre\_tag setting | git master branch |
44+
| extensions.tagging.write\_pubdate | **True**/False | True = write the published date | git master branch |
45+
46+
1347

1448
Links:
1549

1650
- [Extension Source](https://github.com/gpodder/gpodder/blob/master/share/gpodder/extensions/tagging.py)
17-
- [Flattr the Extension](https://flattr.com/thing/1203533/gPodder-Tagging-Extension)

0 commit comments

Comments
 (0)