Developers Reference
Introduction
Architecture
Database
Client/Server-API
The communication between client and server is XMLRPC.
Login and logout
login
sid login
user
password
user logins to the default
location.
loginWithLocation
sid loginWithLocation
user
password
location
user logins to the
location location.
logout
logout
sid
Session sid logs out.
Locations
getLocations
list of locations getLocations
sid
Returns a list of locations.
getPublicLocations
list of locations getPublicLocations
Returns a list of public locations.
setLocation
setLocation
sid
locationId
Set new location for sid.
getLocation
locationId getLocation
sid
Get the current location for
sid.
Player control
play
locationId getLocation
sid
Get the current location for
sid.
stop
locationId getLocation
sid
Get the current location for
sid.
pause
locationId getLocation
sid
Get the current location for
sid.
Queueing
enqueueTrack
enqueueTrack
sid
trackId
.
enqueueArtist
enqueueArtist
sid
ArtistId
.
enqueueAlbum
enqueueAlbum
sid
albumId
.
Randomize
setRandom
setRandom
sid
on/off
.
setRandomAll
setRandomAll
sid
.
setRandomGenre
setRandomGenre
sid
genreId*
.
setRandomArtist
setRandomArtist
sid
artistId*
.
Rating
The rate parameter is an integer between and including -2
and 2.
setGenreRate
setGenreRate
sid
genreId
rate
.
setAlbumRate
setAlbumRate
sid
albumId
rate
.
setTrackRate
setTrackRate
sid
trackId
rate
.
getGenreRate
getGenreRate
sid
genreId
.
getAlbumRate
getAlbumRate
sid
albumId
.
getTrackRate
getTrackRate
sid
trackId
.
deleteGenreRate
deleteGenreRate
sid
genreId
.
deleteAlbumRate
deleteAlbumRate
sid
albumId
.
deleteTrackRate
deleteTrackRate
sid
trackId
.
Search
Search
General search function.
search
sid
resultType
casesensitive
allRequired
queryRows
sid
Session id.
resultType
resultType is a string that can be any of following values:
Track returns trackId:s as result
Album returns albumId as result
AArtist returns artistId as result. Requires that the artist is the Album Artist.
TArtist returns artistId as result. Requires that the artist is the Album Artist.
casesensitive
Either True or False.
allRequired
Either True or False.
queryRows
An array of arrays. The first array can have any
number of rows (query rows). The
second array has always three elements:
source which can be any of following values:
Album artist name
Album artist i
Album title
Album id
Album release year
Album cd
Track name
Track id
Track number
Track length
Track artist name, only for testing
Track artist id, only for testing
Operator
contains
not contains
is
is not
greater than
lesser than
argument
Data editing
Nothing written yet.
The principle is setTableField sid id value.
Administration
Nothing done yet.
Server design
The server is written in Python.