Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-02-24 08:12:54 +01:00
Code Issues Projects Releases Wiki Activity

convert: playlist: Document the feature

Browse source 
leaving out the fact that #EXTM3U is added to the playlist file header
(that important?).
This commit is contained in:
J0J0 T 2022-08-23 08:00:18 +02:00 committed by J0J0 Todos
parent cb630c45f6
commit c1908d551a
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/plugins/convert.rst
View file

@ -4,7 +4,8 @@ Convert Plugin
The ``convert`` plugin lets you convert parts of your collection to a
directory of your choice, transcoding audio and embedding album art along the
way. It can transcode to and from any format using a configurable command
line.
line. Optionally an m3u playlist file containing all the converted files can be
saved to the destination path.
Installation
@ -54,6 +55,21 @@ instead, passing ``-H`` (``--hardlink``) creates hard links.
Note that album art embedding is disabled for files that are linked.
Refer to the ``link`` and ``hardlink`` options below.
The ``-m`` (or ``--playlist``) option enables the plugin to create an m3u8
playlist file in the destination folder given by the ``-d`` (``--dest``) option
or the ``dest`` configuration. Either a simple filename or a relative path plus
a filename can be passed. The generated playlist will always use relative paths
to the contained media files to ensure compatibility when read from external
drives or on computers other than the one used for the conversion. Also refer
to the ``playlist`` option below.
Note that the classic m3u format doesn't support special characters in media
file paths, thus the m3u8 format which requires media file paths to be unicode,
is used. Typically a playlist file would be named *.m3u8. The name of the file
can be freely chosen by the user though. Since it is always ensured that paths
to media files are written as defined by the ``path`` configuration, a
generated playlist potentially could contain unicode characters no matter what
file ending was chosen.
Configuration
-------------
@ -124,6 +140,12 @@ file. The available options are:
Default: ``false``.
- **delete_originals**: Transcoded files will be copied or moved to their destination, depending on the import configuration. By default, the original files are not modified by the plugin. This option deletes the original files after the transcoding step has completed.
Default: ``false``.
- **playlist**: The name of a playlist file that should be written on each run
of the plugin. A relative file path (e.g `playlists/mylist.m3u8`) is allowed
as well. The final destination of the playlist file will always be relative
to the destination path (``dest``, ``--dest``, ``-d``). This configuration is
overridden by the ``-m`` (``--playlist``) command line option.
Default: none.
You can also configure the format to use for transcoding (see the next
section):