User Guide

77
Standard NetLinx API (SNAPI) R 1.8.0
Digital Media Server Functions (Cont.)
Name Component Channel Level Command Constant Notes
queryDB(mdbss, count) IMediaDBComponent MEDIADBREFRESH-
<key>,<count>
Refresh record starting with the last starting
position used with a MEDIADBNEXT or
MEDIADBPREV command for the media
search associated with search key <key>.
Responses with MEDIADBNEXT-
<key>,<count>,<position> where <key> is
the search key, <count> is the number of
records to expect and <position> is the
position of the first record to be returned
between 1 through the total number of
records.
queryMediaDBProperties(recordID) IMediaDBComponent ?MEDIADBPROPS-
<id>
Query for all Media Database Properties for
a given record where <id> is the record ID,
responds with multiple MEDIADBPROP-
<id>,<key>,<value>, one for each property,
where <id> is the record id of the record
from which to retrieve the properties, <key>
is the property key and <value> is the prop-
erty value.
queryMediaDBProperty(id,key) IMediaDBComponent ?MEDIADBPROP-
<id>,<key>
Query for one Media Database Property
where <id> is the record ID and <key> is
the property key to query, responds with
MEDIADBPROP-<id>,<key>,<value>
where <id> is the record id of the record
from which to retrieve the properties, <key>
is the property key and <value> is the prop-
erty value.
searchDB(sr) IMediaDBComponent MEDIADBSEARCH-
<key>,<search
type>=<search
string>,RETURN=<retu
rn type>
Search the media database for records
with <search type> equal to <search
string>. If <search string> is "*", all records
are returned. <key> is a search key used
in other search operations, such as clos-
eSearchDB(). It can be any string you like,
such as a panel device number or internal
key that makes sense for your program. All
future DB operation associated with this
search will reference this key value.
<search type> can be ALL, ID, ARTIST,
GENRE, TITLE, KEYWORDS, PLAYLIST,
BOOKMARK. RETURN= is optional and
limits the type of items returned in the result
set where <result type> can be ALL, PIC-
TURE, APPLICATION, TRACK, CHAP-
TER, PLAYLIST, BOOKMARK, DISC,
AUDIO, VIDEO, GENRE, ARTIST, STA-
TION.
setMediaDBProperty(sID, sName,sValue) IMediaDBComponent MEDIADBPROP-
<id>,<key>,<value>
Set a Media Databse Property where <id>
is the record id of the record for which to
set the properties, <key> is the property
key and <value> is the property value.