Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tagging extension documentation #55

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 39 additions & 6 deletions docs/extensions/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,49 @@
title: Tag downloaded files using Mutagen
---

Add episode and podcast titles to MP3/OGG tags
Add episode and podcast titles to MP3/OGG tags.

By default, this extension will:
- Remove existing tags
- Write the Title tag, stripping the album from the beginning of the Title if necessary
- Write the Album tag
- Write the Artist tag (with the same string as the Album tag)
- Write the Genre (to "Podcast", configurable)
- Write the publish date

Also available are writing the Subtitle tag and the Comments tag (both with the
subtitle field), but the subtitle is often so long that it may cause problems with
certain audio players, such as Rockbox players. These are disabled by default.

This extension can optionally embed coverart - note that the coverart will not be
standardized in any way, so Rockbox users be wary. This is disabled by default.

This extension can optionally remove all tags instead of doing any of the above.
This is disabled by default.

## Dependencies

This extension requires python module `mutagen`.

| setting | value | description | version |
|----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------|
| extensions.tagging.always\_remove\_tags | true/false | true = extension removes all tags instead of creating/adding tag information | 3.5.0 |
| extensions.tagging.auto\_embed\_coverart | true/false | true = extension adds existing coverart after download | git master branch |
| extensions.tagging.genre\_tag | Genre | with this setting you can define the genre tag. Default = Podcast | all |
| 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 |
| 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 |
| extensions.tagging.genre\_tag | Podcast | Sets the Genre tag. Default = Podcast | all |
| extensions.tagging.always\_remove\_tags | true/**false** | true = extension removes all tags instead of creating/adding tag information | 3.5.0 |
| extensions.tagging.auto\_embed\_coverart | true/**false** | true = embed channel cover art in file. | git master branch |
| extensions.tagging.set\_artist\_to\_album | **True**/False | True = set the Artist tag to the same as the existing Album tag. | git master branch |
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch |
| 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 |
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch |
| extensions.tagging.write\_title | **True**/False | True = write the title field | git master branch |
| extensions.tagging.write\_album | **True**/False | True = write the album field | git master branch |
| extensions.tagging.write\_subtitle | True/**False** | True = write the subtitle field | git master branch |
| extensions.tagging.write\_comments | True/**False** | True = write the comments field (with the subtitle) | git master branch |
| extensions.tagging.write\_genre | **True**/False | True = write the genre with the genre\_tag setting | git master branch |
| extensions.tagging.write\_pubdate | **True**/False | True = write the published date | git master branch |
dconrad5 marked this conversation as resolved.
Show resolved Hide resolved



Links:

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