protocol.SearchRequest
This request allows you to perform a POSIX regex search on the name of items. You can specify as to what content types you wish to restrict this search to. 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.
| Parameter | Optional | Max Allowed | DataType | Notes |
|---|---|---|---|---|
| cid | no | 1 | text | client id. used to track origin of any particular message |
| ixs | yes | 1 | indices | start (i0) and end (i1) index inclusive |
| q | no | 1 | text | POSIX regular expression. |
| tys | no | 1 | list | list of media types to apply search to: track/album/artist/playlist/radiostation/composer |
Example xml:
<sireq>
<cid>Mum</cid>
<fn>
<search>
<ixs>
<i0>0</i0>
<i1>9</i1>
</ixs>
<q>Cold Play</q>
<tys>
<ty>track</ty>
<ty>album</ty>
<ty>artist</ty>
<ty>playlist</ty>
<ty>radiostation</ty>
<ty>composer</ty>
</tys>
</search>
</fn>
</sireq>