protocol.GetPlayerTracksRequest2

GetPlayerTracksRequest2

This request allows you to get all the tracks from a particular player. An optional indices parameter can be passed if you wish to subset the returned list if you have a limit on the number of results you can display on your user interface. There is also an optional parameter that allows you to just get a slice of results around a matching index. This is useful if you are randomly jumping around in the results for example. Window elements of the slice are optional with missing fields indicating start or end of list. For the pivot in the slice this can be an index, or a constant to define either the index to pivot around or some other criteria to pivot around.

Parameter	Optional	Max Allowed	DataType	Notes
cid	no	1	text	client id. used to track origin of any particular message
id	no	1	integer	player id
ixs	yes	1	indices	start (i0) and end (i1) index inclusive
sli	yes	1	slice	pivot returned results around matching index (ix) with number of items before (w0) and after (w1) matching index.

Example xml:

  <sireq>
      <cid>Mum</cid>
      <fn>
          <getPlayerTracks2>
              <id>1</id>
              <ixs>
                  <i0>0</i0>
                  <i1>9</i1>
              </ixs>
              <sli>
                  <ix>10</ix>
                  <w0>0</w0>
                  <w1>50</w1>
              </sli>
          </getPlayerTracks2>
      </fn>
  </sireq>

 

back to index