mirror of
https://github.com/beetbox/beets.git
synced 2025-12-30 04:22:40 +01:00
cb350de2ea
Add a configuration section that lists all options for each plugin. List options in alphabetic order. Mention the default value for each option. Use same sentences to describe concepts common to different plugins eg 'auto option, install description
29 lines
738 B
ReStructuredText
29 lines
738 B
ReStructuredText
BPM Plugin
|
|
==========
|
|
|
|
This ``bpm`` plugin lets you to get the tempo (beats per minute) of a song by
|
|
tapping out the beat on your keyboard.
|
|
|
|
Usage
|
|
-----
|
|
|
|
To use the plugin, first enable it in your configuration (see
|
|
:ref:`using-plugins`).
|
|
|
|
Then, play a song you want to measure in your favorite media player and type::
|
|
|
|
beet bpm <song>
|
|
|
|
You'll be prompted to press Enter three times to the rhythm. This typically
|
|
allows to determine the BPM within 5% accuracy.
|
|
|
|
The plugin works best if you wrap it in a script that gets the playing song.
|
|
for instance, with ``mpc`` you can do something like::
|
|
|
|
beet bpm $(mpc |head -1|tr -d "-")
|
|
|
|
Credit
|
|
------
|
|
|
|
This plugin is inspired by a similar feature present in the Banshee media
|
|
player.
|