diff options
| author | Max Kellermann <max@musicpd.org> | 2019-04-03 14:01:46 +0200 |
|---|---|---|
| committer | Max Kellermann <max@musicpd.org> | 2019-04-03 14:01:46 +0200 |
| commit | a1ae455c69add62a4e83f050510968ae516cd8d0 (patch) | |
| tree | f7b0027c58d1bdde261f4841eda652c251081001 /doc/protocol.rst | |
| parent | 7a1b56fe96b3b7d28792a9aad5c82aedc367e7b8 (diff) | |
doc/protocol.rst: make the `albumart` documentation more generic
Diffstat (limited to 'doc/protocol.rst')
| -rw-r--r-- | doc/protocol.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/protocol.rst b/doc/protocol.rst index 02a7ecfc4..da9759014 100644 --- a/doc/protocol.rst +++ b/doc/protocol.rst @@ -782,11 +782,12 @@ The music database ================== :command:`albumart {URI} {OFFSET}` - Searches the directory the file ``URI`` - resides in and attempts to return a chunk of an album + Locate album art for the given song and return a chunk of an album art image file at offset ``OFFSET``. - Uses the filename "cover" with any of ".png, .jpg, - .tiff, .bmp". + + This is currently implemented by searching the directory the file + resides in for a file called :file:`cover.png`, :file:`cover.jpg`, + :file:`cover.tiff` or :file:`cover.bmp`. Returns the file size and actual number of bytes read at the requested offset, followed |