User Guide

241
Standard NetLinx API (SNAPI) R 1.8.0
Switcher
IGainComponent
IGainComponentListener
IModuleComponent
IModuleComponentListener
ISwitcherComponent
ISwitcherComponentListener
IVolumeComponent
IVolumeComponentListener
Name: Switcher
Interface: ISwitcher
Switcher Functions
Name Component Channel Level Command Constant Notes
cycleGainMute() IGainComponent 144 GAIN_MUTE Momentary Function Channel: Cycle gain
mute when channel is activated
setGain(level) IGainComponent 5 GAIN_LVL Set gain, range is 0-255
setGainMuteOn(state) IGainComponent 143 GAIN_MUTE_ON Discrete Function Channel: Gain mute is
on while channel is active
setGainRamp(UP) IGainComponent 140 GAIN_UP Ramping Channel: Gain is ramped up while
channel is active
setGainRamp(DOWN) IGainComponent 141 GAIN_DN Ramping Channel: Gain is ramped down
while channel is active
processGainEvent(int) IGainComponentListener 5 GAIN_LVL Gain changed, range is 0-255
processGainMuteEvent(boolean) IGainComponentListener 143 GAIN_MUTE_FB Feedback Channel: Gain is muted if chan-
nel is on
processGainRampEvent(UP) IGainComponentListener 140 GAIN_UP_FB Feedback Channel: Gain is ramping up
while channel is on
processGainRampEvent(DOWN) IGainComponentListener 141 GAIN_DN_FB Feedback Channel: Gain is ramping down
while channel is on
getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with
DEBUG-<state> where <state> is 1-4 for
ERROR, WARNING, DEBUG, INFO
getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version,
responds with FWVERSION-<version>
getProperty(key) IModuleComponent ?PROPERTY-<key> Query for the value of property <key>,
respond with PROPERTY-<key>,<value>
getVersion() IModuleComponent ?VERSION Query for the module version, responds
with VERSION-<version>
loadProperties(fileName) IModuleComponent LOADPROPERTY-
<file>
Load properties from the file with the sup-
plied filename. Used to load meta-data
properties for modules including Generic IR
modules.