mirror of
https://github.com/beetbox/beets.git
synced 2025-12-15 21:14:19 +01:00
aa31fea037
*All* URLs were checked manually, but only once per domain! I mostly concerned myself with URLs in documentation rather than source code because the latter may or may not have impactful changes, while the former should be straight forward. Changes in addition to simply adding an s: - changed pip and pypi references as their location has changed - MPoD (iOS app) url redirects to Regelian, so I replaced those - updated homebrew references Notable observations: - beets.io does have HTTPS set up properly (via gh-pages) - beatport.py uses the old HTTP url for beatport - as does lyrics.py for lyrics.wikia.com - https://tomahawk-player.org/ expired long ago, but the http page redirects to https regardless - none of the sourceforge subdomains have https (in 2019!)
32 lines
1.1 KiB
ReStructuredText
32 lines
1.1 KiB
ReStructuredText
Key Finder Plugin
|
|
=================
|
|
|
|
The `keyfinder` plugin uses the `KeyFinder`_ program to detect the
|
|
musical key of track from its audio data and store it in the
|
|
`initial_key` field of your database. It does so
|
|
automatically when importing music or through the ``beet keyfinder
|
|
[QUERY]`` command.
|
|
|
|
To use the ``keyfinder`` plugin, enable it in your configuration (see
|
|
:ref:`using-plugins`).
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
To configure the plugin, make a ``keyfinder:`` section in your
|
|
configuration file. The available options are:
|
|
|
|
- **auto**: Analyze every file on
|
|
import. Otherwise, you need to use the ``beet keyfinder`` command
|
|
explicitly.
|
|
Default: ``yes``
|
|
- **bin**: The name of the `KeyFinder`_ program on your system or
|
|
a path to the binary. If you installed the KeyFinder GUI on a Mac, for
|
|
example, you want something like
|
|
``/Applications/KeyFinder.app/Contents/MacOS/KeyFinder``.
|
|
Default: ``KeyFinder`` (i.e., search for the program in your ``$PATH``)..
|
|
- **overwrite**: Calculate a key even for files that already have an
|
|
`initial_key` value.
|
|
Default: ``no``.
|
|
|
|
.. _KeyFinder: https://www.ibrahimshaath.co.uk/keyfinder/
|