Docs tweaks for #3493

This commit is contained in:
Adrian Sampson 2020-02-26 19:15:44 -08:00
parent 8b8d223755
commit 00c6d1439e
3 changed files with 13 additions and 12 deletions

View file

@ -6,7 +6,7 @@ Changelog
New features:
* :doc:`plugins/fetchart`: and :doc:`plugins/embedart`: Added a new ``quality``
* :doc:`plugins/fetchart` and :doc:`plugins/embedart`: Added a new ``quality``
option that controls the quality of the image output when the image is
resized.
* :doc:`plugins/keyfinder`: Added support for `keyfinder-cli`_

View file

@ -58,13 +58,12 @@ file. The available options are:
the aspect ratio is preserved. See also :ref:`image-resizing` for further
caveats about image resizing.
Default: 0 (disabled).
- **quality**: The quality level to use when encoding the image file when
downscaling to ``maxwidth``. Can be a number from 1-100 or 0 to disable.
Higher numbers result in better image quality while lower numbers will result
in smaller files. 65-75 is a good starting point. The default behaviour
depends on the method used to scale the images. ImageMagick tries to estimate
the input image quality and uses 92 if it cannot be determined. Pillow
defaults to 75.
- **quality**: The JPEG quality level to use when compressing images (when
``maxwidth`` is set). This should be either a number from 1 to 100 or 0 to
use the default quality. 6575 is usually a good starting point. The default
behavior depends on the imaging tool used for scaling: ImageMagick tries to
estimate the input image quality and uses 92 if it cannot be determined, and
PIL defaults to 75.
Default: 0 (disabled)
- **remove_art_file**: Automatically remove the album art file for the album
after it has been embedded. This option is best used alongside the

View file

@ -42,10 +42,12 @@ file. The available options are:
- **maxwidth**: A maximum image width to downscale fetched images if they are
too big. The resize operation reduces image width to at most ``maxwidth``
pixels. The height is recomputed so that the aspect ratio is preserved.
- **quality**: The quality level to use when encoding the image file when
downscaling to ``maxwidth``. Can be a number from 1-100 or 0 to disable.
Higher numbers result in better image quality while lower numbers will result
in smaller files. 65-75 is a good starting point.
- **quality**: The JPEG quality level to use when compressing images (when
``maxwidth`` is set). This should be either a number from 1 to 100 or 0 to
use the default quality. 6575 is usually a good starting point. The default
behavior depends on the imaging tool used for scaling: ImageMagick tries to
estimate the input image quality and uses 92 if it cannot be determined, and
PIL defaults to 75.
Default: 0 (disabled)
- **enforce_ratio**: Only images with a width:height ratio of 1:1 are
considered as valid album art candidates if set to ``yes``.