User Guide

157
Standard NetLinx API (SNAPI) R 1.8.0
Volume
Component
Name: Volume
Interface: IVolumeComponent
IVolumeComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
cycleVolumeMute() 26 VOL_MUTE Momentary Function Channel: Cycle volume mute when channel is activated
cycleVolumePreset() 138 VOL_PRESET Momentary Function Channel: Cycle camera preset when channel is activated
getVolumePreset() ?VOLPRESET Query for volume preset, responds with VOLPRESET-<preset>
saveVolumePreset(pre-
set)
VOLPRESETSAVE-<preset> Save Volume Preset where <preset> is 1 to x and x is the maximum supported preset
(see specific module documentation)
setVolume(level) 1 VOL_LVL Set volume, range is 0-255
setVolumeMuteOn(state) 199 VOL_MUTE_ON Discrete Function Channel: Volume mute is on while channel is active
setVolumePreset(preset) VOLPRESET-<preset> Recall volume preset where <preset> is 1 to x and x is the maximum supported preset
(see specific module documentation)
setVol-
umeRamp(DOWN)
25 VOL_DN Ramping Channel: Volume is ramped down while channel is active
setVolumeRamp(UP) 24 VOL_UP Ramping Channel: Volume is ramped up while channel is active
Listener
Name: Volume Listener
Interface: IVolumeComponentListener
IVolumeComponentListener
Listener Functions:
Name: Channel: Level: Command: Constant: Notes:
processVolumeEvent 1 VOL_LVL Volume changed, range is 0-255
processVolumeMu-
teEvent
199 VOL_MUTE_FB Feedback Channel: Volume is muted if channel is on
processVolumePre-
setEvent
VOLPRESET-<preset> Volume preset changed, where <preset> is 1-x and x is the maximum supported preset
(see specific module documentation)
processVolumeRampE-
vent
25 VOL_DN_FB Feedback Channel: Volume is ramping down while channel is on
processVolumeRampE-
vent
24 VOL_UP_FB Feedback Channel: Volume is ramping up while channel is on