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

updated documentation

Browse source
This commit is contained in:
MrNuggelz 2019-11-16 21:10:41 +01:00
parent e9dee5dca8
commit 00330da623
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/plugins/subsonicplaylist.rst
View file

@ -1,21 +1,30 @@
Subsonic Playlist Plugin
========================
The ``subsonicplaylist`` plugin allows to import playlist from a subsonic server
The ``subsonicplaylist`` plugin allows to import playlists from a subsonic server.
This is done by retrieving the track infos from the subsonic server, searching
them in the beets library and adding the playlist names to the
`subsonic_playlist` tag of the found items. The content of the tag has the format:
subsonic_playlist: ";first playlist;second playlist"
To get all items in a playlist use the query `;playlist name;`.
Command Line Usage
------------------
To use the ``subsonicplaylist`` plugin, enable it in your configuration (see
:ref:`using-plugins`). Then use it by invoking the ``subsonicplaylist`` command.
The command will search the playlist on the subsonic server and create a playlist
using the beets library. Options to be defined in your config with their default value::
By default only the tags of the items found for playlists will be updated.
This means that, if one imported a playlist, then delete one song from it and
imported the playlist again, the deleted song will still have the playlist set
in its `subsonic_playlist` tag. To solve this problem one can use the `-d/--delete`
flag. This resets all `subsonic_playlist` tag before importing playlists.
Options to be defined in your config with their default value::
subsonicplaylist:
base_url: "https://your.subsonic.server"
'relative_to': None,
'playlist_dir': '.',
'forward_slash': False,
'base_url': "https://your.subsonic.server"
'delete': False,
'playlist_ids': [],
'playlist_names': [],
'username': '',