1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2009-2014 Jack Kaliko <jack@azylum.org>
4 # This file is part of sima
6 # sima is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # sima is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with sima. If not, see <http://www.gnu.org/licenses/>.
22 # Add decorator to filter through history?
24 # standard library import
28 #from sima.lib.track import Track
32 """Player interface to inherit from.
34 When querying player music library for tracks, Player instance *must* return
35 Track objects (usually a list of them)
37 Player instance should expose the following immutable attributes:
48 self.log = logging.getLogger('sima')
51 """Monitor player for change
53 * database player media library has changed
54 * playlist playlist modified
55 * options player options changed: repeat mode, etc…
56 * player player state changed: paused, stopped, skip track…
58 raise NotImplementedError
60 def remove(self, position=0):
61 """Removes the oldest element of the playlist (index 0)
63 raise NotImplementedError
65 def find_track(self, artist, title=None):
67 Find tracks for a specific artist or filtering with a track title
68 >>> player.find_track('The Beatles')
69 >>> player.find_track('Nirvana', title='Smells Like Teen Spirit')
71 Returns a list of Track objects
73 raise NotImplementedError
75 def find_album(self, artist, album):
77 Find tracks by track's album name
78 >>> player.find_album('Nirvana', 'Nevermind')
80 Returns a list of Track objects
82 raise NotImplementedError
84 def find_albums(self, artist):
86 Find albums by artist's name
87 >>> player.find_alums('Nirvana')
89 Returns a list of string objects
91 raise NotImplementedError
93 def fuzzy_find_artist(self, artist):
95 Find artists based on a fuzzy search in the media library
96 >>> bea = player.fuzzy_find_artist('beatles')
100 Returns a list of strings (artist names)
102 raise NotImplementedError
104 def disconnect(self):
105 """Closing client connection with the Player
107 raise NotImplementedError
110 """Connect client to the Player
112 raise NotImplementedError
115 # vim: ai ts=4 sw=4 sts=4 expandtab