User Guide

Standard NetLinx API (SNAPI) R 1.8.0
242
Switcher Functions (Cont.)
Name Component Channel Level Command Constant Notes
passThru(buffer) IModuleComponent PASSTHRU-<buffer> Send a message directly to the device
reinitialize() IModuleComponent REINIT Reinitialize communication with the device
setDebugState(state) IModuleComponent DEBUG-<state> Set the debug state where <state> is 1-4
for ERROR, WARNING, DEBUG, INFO
setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy>
<hh:mm:ss>
Set the device date/time.
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.
getInput(sl,output) ISwitcherComponent ?INPUT-[<sl>,]<output> Query for the input connected to an output,
respond with SWITCH-
L<sl>I<input>O<output> where <sl> is
ALL, VIDEO, or AUDIO and <input> is 0 if
there is no connection.. If <sl> is not sup-
plied, ALL will be assumed.
getOutput(sl,input) ISwitcherComponent ?OUTPUT-
[<sl>,]<input>
Query for the outputs connected to an
input, respond with SWITCH-
L<sl>I<input>O<output>,<output>Ö where
<sl> is ALL, VIDEO, or AUDIO and <out-
put> is 0 if there is no connection. If <sl> is
not supplied, ALL will be assumed.
getSwitcherPreset() ISwitcherComponent ?SWITCHPRESET Query for switcher preset, responds with
SWITCHPRESET-<preset>
saveSwitcherPreset(preset) ISwitcherComponent SWITCHPRESET-
SAVE-<preset>
Save switcher preset where <preset> is 1-x
and x is the maximum supported preset
(see specific module documentation)
setSwitcherPreset(preset) ISwitcherComponent SWITCHPRESET-
<preset>
Recall switcher preset where <preset> is 1-
x and x is the maximum supported preset
(see specific module documentation)