MetaSync: docs for itunes synchronization

changelog & metasync plugin documentation
This commit is contained in:
Tom Jaspers 2015-05-07 10:28:41 +02:00
parent 3dc2beda41
commit 04d7c883d1
2 changed files with 24 additions and 3 deletions

View file

@ -4,6 +4,12 @@ Changelog
1.3.14 (in development)
-----------------------
New features:
* The :doc:`/plugins/metasync` plugin now lets you get metadata from iTunes.
This plugin is still in an experimental phase.
Fixes:
* :doc:`/plugins/mpdstats`: Avoid a crash when the music played is not in the

View file

@ -4,11 +4,13 @@ MetaSync Plugin
This plugin provides the ``metasync`` command, which lets you fetch certain
metadata from other sources: for example, your favorite audio player.
Currently, the plugin supports synchronizing with the `Amarok`_ music player.
Currently, the plugin supports synchronizing with the `Amarok`_ music player,
and with `iTunes`_.
It can fetch the rating, score, first-played date, last-played date, play
count, and track uid from Amarok.
.. _Amarok: https://amarok.kde.org/
.. _iTunes: https://www.apple.com/itunes/
Installation
@ -29,10 +31,23 @@ Configuration
To configure the plugin, make a ``metasync:`` section in your configuration
file. The available options are:
- **source**: A list of sources to fetch metadata from. Set this to "amarok"
to enable synchronization with that player.
- **source**: A list of sources to fetch metadata from. Set this to "amarok" or
"itunes" to enable synchronization with that player.
Default: empty
The follow subsections describe additional configure required for some players.
itunes
''''''
The path to your iTunes library **xml** file has to be configured, e.g.::
metaysnc:
source: itunes
itunes:
library: ~/Music/iTunes Library.xml
Please note the indentation.
Usage
-----