Qsonix Integration - Manual (Page 19)

Qsonix Integration Guide
Page | 19
will be returned to indicate tracks that are queued up to play in the future. If there are no future tracks
or less than TrackCount number of future tracks, then less rows may be returned.
PARAMETERS
Zone Now Playing tracks will be returned for this zone.
uInt8
TrackCount Specifies the number of rows to return. This is how many tracks in the future will
be returned (includes the current track).
Int32
RESPONSE DEFINITION
GET_NOWPLAYING[Zone][TrackCount][UserData][TrackID][TrackTitle][SequenceNumber][Ar
tistID][ArtistName][AlbumID][AlbumTitle][TrackDurationInSeconds][TrackDurationAsString]
Zone Now Playing tracks will be returned for this zone.
uInt8
TrackCount Specifies the number of rows returned. This will normally be the same
as the TrackCount value passed in unless there are less than the
specified number of tracks in the future of the now playing queue for the
specified Zone.
Int32
TrackID The unique track ID for the track being returned.
Int32
TrackTitle The track title.
String(512)
SequenceNumber This number is unique within a playlist and indicates this tracks order
within the playlist. Since a playlist can contain a track more than once,
this provides an alternative to track ID to uniquely identify a particular
instance of a track within a playlist.
Int32
ArtistID The unique artist ID of the primary artist for the track being returned.
Int32
ArtistName The name of the primary artist for the track being returned.
String(255)
AlbumID The unique album ID of the album that this track is associated with.
Int32
AlbumTitle The title of the album that the track is associated with.
String(100)
TrackDurationInSeconds Duration of the track. This is returned as an integer value in seconds.
Int32
DurationAsString Duration of the track. This is returned as a formatted string value (ex:
1:23:45).
String(10)
GetFor_Search [SearchTerm] [PageNumber] [PageSize] {UserData}
DESCRIPTION
Performs a keyword search on all items in the library and returns a list of objects that have a string
match. Currently, this search function searches for matches in all album titles, artist names, track titles
and genres. The results are returned as a composite result, with the ObjectType response field
indicating the type of object that contained the search keyword.
PARAMETERS
SearchTerm A string value that is to be used for the search.
String(255)
PageNumber Specifies the page number to be retrieved.
Int32
PageSize Specifies the number of rows in each page.
Int32
RESPONSE DEFINITION
GETFOR_SEARCH[SearchTerm][PageNumber][TotalPages][TotalResults][UserData][ObjectType