mirror of
https://github.com/beetbox/beets.git
synced 2025-12-15 13:07:09 +01:00
Move musicbrainz docs to a separate file
This commit is contained in:
Šarūnas Nejus
parent
0980c82959
commit
df56bfeec9
2 changed files with 108 additions and 109 deletions
108
docs/plugins/musicbrainz.rst
Normal file
108
docs/plugins/musicbrainz.rst
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
.. _musicbrainz-config:
|
||||
|
||||
MusicBrainz Options
|
||||
-------------------
|
||||
|
||||
You can instruct beets to use `your own MusicBrainz database`_ instead of
|
||||
the `main server`_. Use the ``host``, ``https`` and ``ratelimit`` options
|
||||
under a ``musicbrainz:`` header, like so::
|
||||
|
||||
musicbrainz:
|
||||
host: localhost:5000
|
||||
https: no
|
||||
ratelimit: 100
|
||||
|
||||
The ``host`` key, of course, controls the Web server hostname (and port,
|
||||
optionally) that will be contacted by beets (default: musicbrainz.org).
|
||||
The ``https`` key makes the client use HTTPS instead of HTTP. This setting applies
|
||||
only to custom servers. The official MusicBrainz server always uses HTTPS. (Default: no.)
|
||||
The server must have search indices enabled (see `Building search indexes`_).
|
||||
|
||||
The ``ratelimit`` option, an integer, controls the number of Web service requests
|
||||
per second (default: 1). **Do not change the rate limit setting** if you're
|
||||
using the main MusicBrainz server---on this public server, you're `limited`_
|
||||
to one request per second.
|
||||
|
||||
.. _your own MusicBrainz database: https://musicbrainz.org/doc/MusicBrainz_Server/Setup
|
||||
.. _main server: https://musicbrainz.org/
|
||||
.. _limited: https://musicbrainz.org/doc/XML_Web_Service/Rate_Limiting
|
||||
.. _Building search indexes: https://musicbrainz.org/doc/Development/Search_server_setup
|
||||
|
||||
.. _musicbrainz.enabled:
|
||||
|
||||
enabled
|
||||
~~~~~~~
|
||||
|
||||
This option allows you to disable using MusicBrainz as a metadata source. This applies
|
||||
if you use plugins that fetch data from alternative sources and should make the import
|
||||
process quicker.
|
||||
|
||||
Default: ``yes``.
|
||||
|
||||
.. _searchlimit:
|
||||
|
||||
searchlimit
|
||||
~~~~~~~~~~~
|
||||
|
||||
The number of matches returned when sending search queries to the
|
||||
MusicBrainz server.
|
||||
|
||||
Default: ``5``.
|
||||
|
||||
.. _extra_tags:
|
||||
|
||||
extra_tags
|
||||
~~~~~~~~~~
|
||||
|
||||
By default, beets will use only the artist, album, and track count to query
|
||||
MusicBrainz. Additional tags to be queried can be supplied with the
|
||||
``extra_tags`` setting. For example::
|
||||
|
||||
musicbrainz:
|
||||
extra_tags: [year, catalognum, country, media, label]
|
||||
|
||||
This setting should improve the autotagger results if the metadata with the
|
||||
given tags match the metadata returned by MusicBrainz.
|
||||
|
||||
Note that the only tags supported by this setting are the ones listed in the
|
||||
above example.
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
.. _genres:
|
||||
|
||||
genres
|
||||
~~~~~~
|
||||
|
||||
Use MusicBrainz genre tags to populate (and replace if it's already set) the
|
||||
``genre`` tag. This will make it a list of all the genres tagged for the
|
||||
release and the release-group on MusicBrainz, separated by "; " and sorted by
|
||||
the total number of votes.
|
||||
Default: ``no``
|
||||
|
||||
.. _musicbrainz.external_ids:
|
||||
|
||||
external_ids
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Set any of the ``external_ids`` options to ``yes`` to enable the MusicBrainz
|
||||
importer to look for links to related metadata sources. If such a link is
|
||||
available the release ID will be extracted from the URL provided and imported
|
||||
to the beets library::
|
||||
|
||||
musicbrainz:
|
||||
external_ids:
|
||||
discogs: yes
|
||||
spotify: yes
|
||||
bandcamp: yes
|
||||
beatport: yes
|
||||
deezer: yes
|
||||
tidal: yes
|
||||
|
||||
|
||||
The library fields of the corresponding :ref:`autotagger_extensions` are used
|
||||
to save the data (``discogs_albumid``, ``bandcamp_album_id``,
|
||||
``spotify_album_id``, ``beatport_album_id``, ``deezer_album_id``,
|
||||
``tidal_album_id``). On re-imports existing data will be overwritten.
|
||||
|
||||
The default of all options is ``no``.
|
||||
|
|
@ -874,115 +874,6 @@ This feature is currently supported by the :doc:`/plugins/discogs` and the
|
|||
|
||||
Default: ``yes``.
|
||||
|
||||
.. _musicbrainz-config:
|
||||
|
||||
MusicBrainz Options
|
||||
-------------------
|
||||
|
||||
You can instruct beets to use `your own MusicBrainz database`_ instead of
|
||||
the `main server`_. Use the ``host``, ``https`` and ``ratelimit`` options
|
||||
under a ``musicbrainz:`` header, like so::
|
||||
|
||||
musicbrainz:
|
||||
host: localhost:5000
|
||||
https: no
|
||||
ratelimit: 100
|
||||
|
||||
The ``host`` key, of course, controls the Web server hostname (and port,
|
||||
optionally) that will be contacted by beets (default: musicbrainz.org).
|
||||
The ``https`` key makes the client use HTTPS instead of HTTP. This setting applies
|
||||
only to custom servers. The official MusicBrainz server always uses HTTPS. (Default: no.)
|
||||
The server must have search indices enabled (see `Building search indexes`_).
|
||||
|
||||
The ``ratelimit`` option, an integer, controls the number of Web service requests
|
||||
per second (default: 1). **Do not change the rate limit setting** if you're
|
||||
using the main MusicBrainz server---on this public server, you're `limited`_
|
||||
to one request per second.
|
||||
|
||||
.. _your own MusicBrainz database: https://musicbrainz.org/doc/MusicBrainz_Server/Setup
|
||||
.. _main server: https://musicbrainz.org/
|
||||
.. _limited: https://musicbrainz.org/doc/XML_Web_Service/Rate_Limiting
|
||||
.. _Building search indexes: https://musicbrainz.org/doc/Development/Search_server_setup
|
||||
|
||||
.. _musicbrainz.enabled:
|
||||
|
||||
enabled
|
||||
~~~~~~~
|
||||
|
||||
This option allows you to disable using MusicBrainz as a metadata source. This applies
|
||||
if you use plugins that fetch data from alternative sources and should make the import
|
||||
process quicker.
|
||||
|
||||
Default: ``yes``.
|
||||
|
||||
.. _searchlimit:
|
||||
|
||||
searchlimit
|
||||
~~~~~~~~~~~
|
||||
|
||||
The number of matches returned when sending search queries to the
|
||||
MusicBrainz server.
|
||||
|
||||
Default: ``5``.
|
||||
|
||||
.. _extra_tags:
|
||||
|
||||
extra_tags
|
||||
~~~~~~~~~~
|
||||
|
||||
By default, beets will use only the artist, album, and track count to query
|
||||
MusicBrainz. Additional tags to be queried can be supplied with the
|
||||
``extra_tags`` setting. For example::
|
||||
|
||||
musicbrainz:
|
||||
extra_tags: [year, catalognum, country, media, label]
|
||||
|
||||
This setting should improve the autotagger results if the metadata with the
|
||||
given tags match the metadata returned by MusicBrainz.
|
||||
|
||||
Note that the only tags supported by this setting are the ones listed in the
|
||||
above example.
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
.. _genres:
|
||||
|
||||
genres
|
||||
~~~~~~
|
||||
|
||||
Use MusicBrainz genre tags to populate (and replace if it's already set) the
|
||||
``genre`` tag. This will make it a list of all the genres tagged for the
|
||||
release and the release-group on MusicBrainz, separated by "; " and sorted by
|
||||
the total number of votes.
|
||||
Default: ``no``
|
||||
|
||||
.. _musicbrainz.external_ids:
|
||||
|
||||
external_ids
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Set any of the ``external_ids`` options to ``yes`` to enable the MusicBrainz
|
||||
importer to look for links to related metadata sources. If such a link is
|
||||
available the release ID will be extracted from the URL provided and imported
|
||||
to the beets library::
|
||||
|
||||
musicbrainz:
|
||||
external_ids:
|
||||
discogs: yes
|
||||
spotify: yes
|
||||
bandcamp: yes
|
||||
beatport: yes
|
||||
deezer: yes
|
||||
tidal: yes
|
||||
|
||||
|
||||
The library fields of the corresponding :ref:`autotagger_extensions` are used
|
||||
to save the data (``discogs_albumid``, ``bandcamp_album_id``,
|
||||
``spotify_album_id``, ``beatport_album_id``, ``deezer_album_id``,
|
||||
``tidal_album_id``). On re-imports existing data will be overwritten.
|
||||
|
||||
The default of all options is ``no``.
|
||||
|
||||
.. _match-config:
|
||||
|
||||
Autotagger Matching Options
|
||||
|
|
|
|||
Loading…
Reference in a new issue