1 # -*- coding: utf-8 -*-
5 First non-empty line of the docstring is used as description
6 Rest of the docstring at your convenience.
8 The plugin Name MUST be the same as the module (file name), case
9 insensitive: for instance plugin.py → Plugin
10 It eases plugins discovery and simplifies the code to handle them,
11 IMHO, it's a fair trade-off.
16 """self documenting class method
18 return {'name': cls.__name__,
19 'doc': cls.__doc__.strip(' \n').splitlines()[0]
22 def __init__(self, daemon):
24 self.__daemon = daemon
25 self.plugin_conf = None
29 return self.__class__.__name__
31 def __get_config(self):
32 """Get plugin's specific configuration from global applications's config
34 conf = self.__daemon.config
35 for sec in conf.sections():
36 if sec.lower() == self.__class__.__name__.lower():
37 self.plugin_conf = dict(conf.items(sec))
39 # self.log.debug('Got config for {0}: {1}'.format(self,
42 def callback_player(self):
44 Called on player changes, stopped, paused, skipped
48 def callback_player_database(self):
50 Called on player music library changes
54 def callback_playlist(self):
56 Called on playlist changes
62 def callback_next_song(self):
63 """Not returning data,
64 Could be use to scrobble, maintain an history…
68 def callback_need_track(self):
69 """Returns a list of Track objects to add
78 # vim: ai ts=4 sw=4 sts=4 expandtab