User Guide

243
Standard NetLinx API (SNAPI) R 1.8.0
Switcher Functions (Cont.)
Name Component Channel Level Command Constant Notes
switchInputToOutput(AUDIO,input,output[]) ISwitcherComponent AI<input>O<output,out-
put,Ö>
Switch <input> to one or more <output>s
for switcher level Audio. Use <input> 0 for
disconnect.
switchInputToOutput(ALL,input,output[]) ISwitcherComponent CI<input>O<out-
put,outputÖ>
Switch <input> to one or more <output>s
for switcher level All. Use <input> 0 for dis-
connect.
switchInputToOutput(sl,input,output[]) ISwitcherComponent CL<sl>I<input>O<out-
put,outputÖ>
Switch <input> to one or more <output>s
where <sl> is ALL, VIDEO, or AUDIO.
Use <input> 0 for disconnect.
switchInputToOutput(VIDEO,input,output[]) ISwitcherComponent VI<input>O<output,out-
put,Ö>
Switch <input> to one or more <output>s
for switcher level Video. Use <input> 0 for
disconnect.
processSwitcherPresetEvent(int) ISwitcherComponentListener SWITCHPRESET-
<preset>
Switcher preset changed, where <preset>
is 1-x and x is the maximum supported pre-
set (see specific module documentation)
processSwitchEvent(SwitchLevel,int,int) ISwitcherComponentListener SWITCH-
L<sl>I<input>O<out-
put>
Switch connections changed, where <sl>
is ALL, VIDEO, or AUDIO and <input> is 0
if there is no connection.
cycleVolumeMute() IVolumeComponent 26 VOL_MUTE Momentary Function Channel: Cycle vol-
ume mute when channel is activated
cycleVolumePreset() IVolumeComponent 138 VOL_PRESET Momentary Function Channel: Cycle cam-
era preset when channel is activated
getVolumePreset() IVolumeComponent ?VOLPRESET Query for volume preset, responds with
VOLPRESET-<preset>
saveVolumePreset(preset) IVolumeComponent VOLPRESETSAVE-
<preset>
Save Volume Preset where <preset> is 1 to
x and x is the maximum supported preset
(see specific module documentation)
setVolume(level) IVolumeComponent 1 VOL_LVL Set volume, range is 0-255
setVolumeMuteOn(state) IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel: Volume mute is
on while channel is active
setVolumePreset(preset) IVolumeComponent VOLPRESET-<preset> Recall volume preset where <preset> is 1
to x and x is the maximum supported pre-
set (see specific module documentation)
setVolumeRamp(UP) IVolumeComponent 24 VOL_UP Ramping Channel: Volume is ramped up
while channel is active
setVolumeRamp(DOWN) IVolumeComponent 25 VOL_DN Ramping Channel: Volume is ramped down
while channel is active
processVolumeEvent(int) IVolumeComponentListener 1 VOL_LVL Volume changed, range is 0-255
processVolumeMuteEvent(boolean) IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel: Volume is muted if
channel is on
processVolumePresetEvent(int) IVolumeComponentListener VOLPRESET-<preset> Volume preset changed, where <preset> is
1-x and x is the maximum supported preset
(see specific module documentation)