From c64fc68b16c223068b523cd46c8103ffb531f405 Mon Sep 17 00:00:00 2001 From: Dorian Date: Tue, 11 May 2021 22:17:38 +0200 Subject: [PATCH] more detailed documentation --- docs/dev/plugins.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index e7462c81e..b32955b61 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -247,12 +247,15 @@ The events currently available are: list of ``PromptChoices``. Parameters: ``task`` and ``session``. * `mb_track_extract`: called after the metadata is obtained from - MusicBrainz. The parameter is a ``dict`` containing the data - retrieved from MusicBrainz for a track in the form ``field : value`` - Allows to add additional tags. + MusicBrainz. The parameter is a ``dict`` containing the tags retrieved from + MusicBrainz for a track. Plugins must return a new (potentially empty) + ``dict`` with additional ``field: value`` pairs, which the autotagger will + apply to the item, as flexible attributes if ``field`` is not a hardcoded + field. Fields already present on the track are overwritten. Parameter: ``data`` -* `mb_album_extract`: Like `mb_track_extract`, but for album tags. +* `mb_album_extract`: Like `mb_track_extract`, but for album tags. Overwrites + tags set at the track level, if they have the same ``field``. Parameter: ``data`` The included ``mpdupdate`` plugin provides an example use case for event listeners.