User Guide

Standard NetLinx API (SNAPI) R 1.8.0
22
Audio Conferencer Functions (Cont.)
Name Component Channel Level Command Constant Notes
updateRecord(sdr) IPhonebookComponent PHONEBOOKUP-
DATE-
<id>,<name>,<num-
ber>
Update phonebook record with index/id of
<id>, where <name> is the new name and
<number> is the new number
processCloseEvent(String) IPhonebookComponentListener PHONEBOOKCLOS-
ESEARCH-<key>
The search associated with search key
<key> have been closed. No more opera-
tions can be performed against this search.
processDeleteRecordEvent(boolean,String) IPhonebookComponentListener PHONEBOOKDE-
LETE-<id>,<success>
Phonebook record with index/id of <id>
was deleted if <success> is 1, otherwise
delete failed.
processEndOfSetEvent(String) IPhonebookComponentListener PHONEBOOKEND-
<key>
End of search set was reached for search
with search key <key>
processQueryDBEvent(PhonebookRecord) IPhonebookComponentListener PHONE-
BOOKRECORD-
<key>,<id>,<#>,<name
>,<number>
Phonebook record for search with search
key <key>. <id> is the record ID, <#> is the
record position from 1 to the total number
of records, <name> is the name/label and
<number> is the phone number.
processSearchDBEvent(PhonebookSearch-
Set)
IPhonebookComponentListener PHONEBOOK-
SEARCHRESULT-
<key>,<count>
Phonebook search results are available for
search with search key <key>. <count> is
the total count of records. Use PHONE-
BOOKNEXT and PHONEBOOKPREV to
get more records.
processStartOfSetEvent(String) IPhonebookComponentListener PHONEBOOKSTART-
<key>
Beginning of search set was reached for
search with search key <key>
processUpdateRecordEvent(boolean,String) IPhonebookComponentListener PHONEBOOKUP-
DATE-<id>,<success>
Phonebook record with index/id of <id>
was updated if <success> is 1, otherwise
update failed.
cyclePower() IPowerComponent 9 POWER Momentary Function Channel: Cycle power
when channel is activated
setPower(ON) IPowerComponent 27 PWR_ON Momentary Function Channel: Power is
turned on when channel is activated
setPower(OFF) IPowerComponent 28 PWR_OFF Momentary Function Channel: Power is
turned off when channel is activated
setPower(ps) IPowerComponent 255 POWER_ON Discrete Function Channel: Power is on
while channel is active
setPowerSensor(nld,nIOChan) IPowerComponent IOLINK-<dps>,<chan-
nel>
Associate a Power Sensor with the device
where <dps> is the DPS in string form, i.e.
17:1:0, and <channel> is the channel on
the IO device to which the power sensor is
connected.
processPowerEvent(ON) IPowerComponentListener 255 POWER_FB Feedback Channel: Power state changed,
power is on while channel is on
cycleVolumeMute() IVolumeComponent 26 VOL_MUTE Momentary Function Channel: Cycle vol-
ume mute when channel is activated