Get zonevisibility, Get_albums, Get_artists – Qsonix Integration User Manual

Page 16: Pagenumber] [pagesize] {userdata

Advertising
background image

Qsonix Integration Guide

Page | 16

StylesCount

Total number of styles currently stored on the system.

Int32

PlaylistCount

Total number of playlists currently stored on the system.

Int32

FriendlyName

The friendly name of the machine set by the user in the configuration
area.

String(50)

Get ZoneVisibility

DESCRIPTION

Used to check the availability of a zone of the server.

PARAMETERS

Zone

Specifies the zone to retrieve the name for. Must be a valid zone number.

uInt8

RESPONSE DEFINITION

ZONESVISIBILITY[VisibilityStatus]

VisibilityStatus

A string containing a one or zero for each zone (1=visible) Example: 0011
would indicate that Zones 3 and 4 should be visible / active.

String(4)

Get_Albums

[PageNumber] [PageSize] {UserData}

DESCRIPTION

Retrieves a list of all albums in the library.

PARAMETERS

PageNumber

Specifies the page number to be retrieved.

Int32

PageSize

Specifies the number of rows in each page.

Int32

RESPONSE DEFINITION

GET_ALBUMS[PageNumber][TotalPages][TotalAlbums][UserData][AlbumID][AlbumTitle]

[AlbumArtistID][AlbumArtistName][Year][TrackCount]

PageNumber

The page number being returned.

Int32

TotalPages

Indicates how many pages are available at the page size specified.

Int32

TotalAlbums

Count of the number of albums in the library.

Int32

AlbumID

Unique album identifier for the album being returned.

Int32

AlbumTitle

Title of the album.

String(100)

AlbumArtistID

Unique artist identifier for the artist that is the primary artist on the album.

Int32

AlbumArtistName Name of the primary artist for the album.

String(255)

Year

Year the album was released.

Int16

TrackCount

Number of tracks associated with the album.

Int32

Get_Artists

[PageNumber] [PageSize] {UserData}

DESCRIPTION

Retrieves a list of all artists in the library.

Advertising