# -*- coding: utf-8 -*-
-# Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2013-2015 Jack Kaliko <kaliko@azylum.org>
#
# This file is part of sima
#
Plugin object to derive from
"""
+
class Plugin:
"""
First non-empty line of the docstring is used as description
if cls.__doc__:
doc = cls.__doc__.strip(' \n').splitlines()[0]
return {'name': cls.__name__,
- 'doc': doc,
- }
+ 'doc': doc,}
def __init__(self, daemon):
self.log = daemon.log
"""Get plugin's specific configuration from global applications's config
"""
conf = self.__daemon.config
- for sec in conf.sections():
+ for sec in conf.sections(): # Discovering plugin conf
if sec == self.__class__.__name__.lower():
self.plugin_conf = conf[sec]
+ if 'priority' not in self.plugin_conf:
+ self.plugin_conf['priority'] = '80'
+ if not self.plugin_conf:
+ self.plugin_conf = {'priority': '80'}
#if self.plugin_conf:
# self.log.debug('Got config for {0}: {1}'.format(self,
# self.plugin_conf))
+ @property
+ def priority(self):
+ return self.plugin_conf.get('priority')
+
+ def start(self):
+ """
+ Called when the daemon().run() is called and
+ right after the player has connected successfully.
+ """
+ pass
+
def callback_player(self):
"""
Called on player changes, stopped, paused, skipped
def callback_playlist(self):
"""
Called on playlist changes
-
Not returning data
"""
pass
def callback_next_song(self):
- """Not returning data,
+ """
Could be use to scrobble, maintain an history…
+ Not returning data,
"""
pass
def callback_need_track(self):
- """Returns a list of Track objects to add
+ """
+ Returns a list of Track objects to add
"""
pass
def callback_need_track_fb(self):
- """Called when callback_next_song failled to find tracks to queue
+ """
+ Called when callback_need_track failled to find tracks to queue
Returns a list of Track objects to add
"""
pass