User Guide

291
Standard NetLinx API (SNAPI) R 1.8.0
Video Conferencer Functions (Cont.)
Name Component Channel Level Command Constant Notes
setPassbackOn(boolean) IModuleComponent PASSBACK-<state> Set the passback state where <state> is 1
or 0. When passback is on, all response
from the device will be passed back to the
NetLinx program as a string from the virtual
device
setProperty(key,value) IModuleComponent PROPERTY-
<key>,<value>
Set the value of property <key> to <value>
processDataInitializedEvent(boolean) IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel: Module data is syn-
chronized with device while channel is on
processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4
for ERROR, WARNING, DEBUG, INFO
processDeviceOnLineEvent(boolean) IModuleComponentListener 251 DEVICE_COMMUNICATING Feedback Channel: Communication is
established with device while channel is on
processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received
form the device is sent to the NetLinx pro-
gram as a string. Use a DATA_EVENT
event with a STRING handler to caputre
the data from the device.
closeSearchDB(searchHandle) IPhonebookComponent PHONEBOOKCLOS-
ESEARCH-<key>
Close the search associated with search
key = <key>
deleteRecord(recordID) IPhonebookComponent PHONEBOOKDE-
LETE-<id>
Delete phonebook record with index/id of
<id>
getPhonebookCapacity() IPhonebookComponent ?PHONEBOOKCA-
PACIT Y
Query for the phonebook capacity.
Responds with PHONEBOOKCAPACITY-
<count> where count is 1 to x and x is the
maximum supported phonebook index (see
specific module documentation)
queryDB(si) IPhonebookComponent PHONEBOOKNEXT-
<key>[,<count>,<posi-
tion>]
Request next <count> records starting with
record <position> for the phonebook
search associated with search key <key>.
If <count> is not present, it is assumed to
be 1. If <position> is not present, it is
assumed th be the next record in the
search result set based on the last
PHONEBOOKNEXT or PHONEBOOK-
PREV command. Responses with
PHONEBOOKNEXT-<key>,<count>,<posi-
tion> 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.