User Guide

73
Standard NetLinx API (SNAPI) R 1.8.0
Media DB
Component
Name: Media DB
Interface: IMediaDBComponent
IMediaDBComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
closeSearchDB(search-
Handle)
MEDIADBCLOSESEARCH-<key> Close the search associated with search key = <key>
deleteRecord(recordID) MEDIADBDELETE-<id> Delete media record with record id of <id>
queryDB(mdbss) MEDIADBNEXT-<key> Request next record (count =1) starting with the next record <position> for the media
search associated with search key <key>. If <position> is not present, it is assumed th
be the next record in the search result set based on the last MEDIADBNEXT or MEDI-
ADBPREV command. Responses with MEDIADBNEXT-<key>,<count>,<position>
where <key> is the search key, <count> is the number of records to expect and <posi-
tion> is the position of the first record to be returned between 1 through the total num-
ber of records.
queryDB(mdbss) MEDIADBPREV-<key> Request previous record (count = 1) for the media search associated with search key
<key>. Responses with MEDIADBPREV-<key>,1,<position> where <key> is the
search key and <position> is the position of the first record to be returned between 1
through the total number of records.
queryDB(mdbss) MEDIADBREFRESH-<key> 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.
queryDB(mdbss, count) MEDIADBNEXT-<key>,<count> Request next record (count =1) starting with record <position> for the media search
associated with search key <key>. If <position> is not present, it is assumed th be the
next record in the search result set based on the last MEDIADBNEXT or MEDIADB-
PREV command. Responses with MEDIADBNEXT-<key>,<count>,<position> where
<key> is the search
queryDB(mdbss, count) MEDIADBPREV-<key>,<count> Request previous <count> records for the media search associated with search key
<key>. Responses with MEDIADBPREV-<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.
queryDB(mdbss, count) 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.
queryMediaDBProper-
ties(recordID)
?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 property value.