Getfor_tracksforplaylist, Playlistid, Pagenumber] [pagesize] {userdata – Qsonix Integration User Manual

Page 24

Advertising
background image

Qsonix Integration Guide

Page | 24

DurationAsString Duration of the track. This is returned as a formatted string value (ex: 1:23:45).

String(10)

OutputIsPlayingT
hisTrack

This field can be used to determine if the returned track is currently playing in
any of the playback zones. Note that this is a multi-valued field and will contain
a delimited list of all zone numbers that are currently playing this track.

String(20)

GetFor_TracksForPlaylist

[PlaylistID]

[PageNumber] [PageSize] {UserData}

DESCRIPTION

Retrieves a list of tracks for the specified playlist.

PARAMETERS

PlaylistID

The unique playlist ID to retrieve a list of tracks for.

Int32

PageNumber

Specifies the page number to be retrieved.

Int32

PageSize

Specifies the number of rows in each page.

Int32

RESPONSE DEFINITION

GETFOR_TRACKSFORPLAYLIST[PlaylistID][PageNumber][TotalPages][TotalTracks][UserData][T
rackID][TrackTitle][SequenceNumber][ArtistID][ArtistName][AlbumID][AlbumTitle][TrackDuratio

nInSeconds][TrackDurationAsString] [OutputIsPlayingThisTrack]

PlaylistID

The playlist ID of the tracks being returned.

Int32

PageNumber

The page number being returned.

Int32

TotalPages

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

Int32

TotalTracks

Count of the number of tracks returned.

Int32

TrackID

The unique track ID for the track being returned.

Int32

TrackTitle

The track title.

String(100)

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.

Int32

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)

TrackDurationInSe
conds

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)

OutputIsPlayingTh
isTrack

This field can be used to determine if the returned track is currently playing in
any of the playback zones. Note that this is a multi-valued field and will contain
a delimited list of all zone numbers that are currently playing this track.

String(20)

Advertising