Deprecated commands, Queue [zone #] [location, Queue – Qsonix Integration User Manual

Page 31: Zone #] [location

Advertising
background image

Qsonix Integration Guide

Page | 31

Deprecated commands

Queue

[Zone #] [Location]

This command has been replaced by the QueueItem command starting in version 2.4.8.

DESCRIPTION

Adds the currently selected item to the Now Playing playlist for the specified [Zone]. The location in
the current playlist that the item will be inserted is determined by the value of the Location parameter.
The Location parameter is optional and if not specified, the default is End. Valid values for Location
are listed below.

PARAMETERS

Zone #

Specifies which zone should be acted upon. Must be 0 or a valid zone
number.

Action

Specifies what action should be taken on the specified zone‟s now playing
playlist. Action must be one of the following values:
ClearAll – Clears all tracks from the playlist
ClearPlayed – Clears all tracks that have completed playing from the playlist

Command

Description / Usage

GET PLAYLISTS REFRESH
GET PLAYLISTS FIRST
GET PLAYLISTS NEXT
GET PLAYLISTS PREVIOUS
GET PLAYLISTS LAST
GET PLAYLISTS PAGESIZE
[PageSize]

Retrieves a list of playlists stored on the server. The PAGESIZE
command can be used to set the number of playlists returned
per page (specified by the PageSize parameter). This would
typically be called upon initialization of the client application.
Omitting the paging command parameter (ex: GET PLAYLISTS)
will retrieve the current page index and can be useful for
refreshing the contents of that page.


Response format:

PLAYLISTS[PageNumber][TotalPages] [TotalRows]
[PlaylistID]

[PlaylistName][TrackCount][PlaylistLength][LengthAsString]

Field Descriptions:

PageNumber – The number of the page being returned
(numbered from 1 to the total number of pages)
TotalPages – The total number of pages available for this
response
TotalRows – The total number of rows available for this response

PlaylistID – A system-assigned ID number uniquely assigned for
each playlist
PlaylistName – The user-specified description for the playlist
TrackCount – Total number of tracks in the playlist
PlaylistLength – Total duration of the playlist (in seconds)
LengthAsString – Total duration of the playlist (formatted as
hh:mm:ss)

GET NOWPLAYING REFRESH
[ZoneNumber]
GET NOWPLAYING FIRST

This command is used to retrieve the current Now Playing list of
tracks. This command includes an additional parameter of
Zone Number and this is unique to the NOWPLAYING

Advertising