search the media library and receive results in a specified format More...
search the media library and receive results in a specified format
Path: /medialib/search
[in] | id | The id of the object under which the search is to be conducted. Default: 0 the root object |
[in] | pfid | The id (typicaly a GUID) of the device profile we should assume. Default: the device profile is automatically detected by the user agennt. Unknown user agents receive the "never transcode" device profile |
[in] | q | The search query. It can be a collection of keywords or a full blown search expression as defined in the UPnP standard |
[in] | startat | The index of the item in the search result set from which the items in the returned document should start |
[in] | count | The number of items to return in the result document, 0 means all the results. Default: 10. |
[in] | format | The format to which the result document should be serialized. Possible values are: didlite , rss , html , mce , asx . qtl , smil , ram |
Examples:
/medialib/search?q=u2 The first ten results for search query u2
, returned in XHTML format
/medialib/search?q=u2&startat=10 The following ten results for search query u2
, returned in XHTML format
/medialib/search?q=u2&count=0 All the results for search query u2
, returned in XHTML format
/medialib/search?format=rss The first ten results for search query u2
, returned in RSS format
Advanced Paramters: Some optional advanced parameters that are supported as well are below
[in] | url | The resource URL of the object under which the search is to be conducted, this is an alternative method to using id and it needs to be used in conjunction with pid |
[in] | title | The title of the object under which the search is to be conducted, this is an alternative method to using id and it needs to be used in conjunction with pid |
[in] | pid | The id of the parent object under which the search is to be conducted, to be used in conjunction with either title or url |
[in] | embed | Bolean value relevant only when the result format is html , indicating whether the result is embedded within other pages and hence should omit the header and footer. For the iPhone HTML in addition to the header and footer all the encapsulating page markup is skipped except the list of results, this is in order to allow a retrieval of deltas for AJAX purposes. |
[in] | filter | a commad spearated list of DIDL-Lite properties that should be returned (relevant only when the format is didlite ). See UPnP CDS for more info. Default: * (meaning all properties) |