Page 1 instruction manual Standard NetLinx API (SNAPI) R 1.8.0 Devices last revision: 8-29-06 Document ID: 033-004-2994...
Page 2 This warranty extends only to products purchased directly from AMX Corporation or an Authorized AMX Dealer. AMX Corporation is not liable for any damages caused by its products or for the failure of its products to perform. This includes any lost profits, lost savings, inci- dental damages, or consequential damages.
Page 3: Table Of Contents
Table of Contents Interfacing with Standard NetLinx API (SNAPI) ............ 1 Overview ........................... 1 Programming........................4 Channel and Level Ranges ....................6 Commands and Escape Characters ................. 7 Amplifier ..........................9 Audio Conferencer ......................13 Audio Mixer ........................25 Audio Processor ......................31 Audio Tape ........................
Page 4 Motor ..........................165 Multi Window ......................... 169 Pool Spa........................181 Power Device ........................ 189 Pre Amp Surround Sound Processor ................191 Receiver ........................203 Relay Device ......................... 217 Security System ......................219 Sensor Device ....................... 223 Settop Box........................225 Slide Projector ....................... 237 Switcher ........................
Page 5: Interfacing With Standard Netlinx Api (Snapi)
Duet modules in their NetLinx programs and access the function and feedback of those modules through programming similar to programming they would use on an AMX device, such as a volume box. While each Duet module may support advanced functions via channels, levels and commands (see specific module documentation for the channels, levels and commands supported by that module), the SNAPI mappings apply to the Standard API supported by each module.
Page 6 Interfacing with Standard NetLinx API (SNAPI) Channels In SNAPI, there are four kinds of channels: Input Function Channels, Momentary Function Channels, Discrete Function Channels and Feedback Channels. Input function channels are used for response type functions, such as when a device wants to inform your program of an interesting event, similar to a button push on a touch panel.
Page 7 Interfacing with Standard NetLinx API (SNAPI) Commands Commands in SNAPI are used for discrete and momentary functions when the function requires textual information, multiple parameters, or the functions are not commonly used. For instance, Temperature scale is set via a command because this is usually done only once in a control system program. Other functions, such as adding and removing lighting and keypad addresses, requires more information than a channel or level alone can convey.
Page 8: Programming
Interfacing with Standard NetLinx API (SNAPI) Programming Channels Input function channels are used for response type functions. For instance, channel 1 notifies your program of a button push in the KeypadComponent. When your program receives a PUSH, the button is pushed. When your program receives a RELEASE, the button is released. You should use BUTTON_EVENT's to capture the changes of an Input function channel: BUTTON_EVENT[dvDevice, KEYPAD_BTN] PUSH:...
Page 9 Interfacing with Standard NetLinx API (SNAPI) Ramping Channels Some channels in SNAPI provide ramping functionality and some provide adjust "stepping" functionality. Since ramping on a device is only provided if the device supports ramping, a channel that causes ramping on one device may not cause ramping on another device. The following syntax can be used universally for all ramping functionality: BUTTON_EVENT[dvTP,1] PUSH:...
Page 10: Channel And Level Ranges
Interfacing with Standard NetLinx API (SNAPI) Commands Commands in SNAPI are sent like commands to other devices, using the SEND_COMMAND keyword: SEND_COMAND dvDevice,'?VERSION' Commands used to query for the status of a property start with a "?". Query commands cause the module to respond with a response command. Note that this response is a command, not a string and can be captured in a DATA_EVENT in the COMMAND sub-section: DATA_EVENT[dvDevice] COMMAND:...
Page 11: Commands And Escape Characters
Interfacing with Standard NetLinx API (SNAPI) Commands and Escape Characters SNAPI command uses comma as a parameter separator. If a parameter's value contains a comma, the parameter is escaping using double quotes at the start and end of the parameter. If a parameter's value contains a double quote character it is escaped with a pair of double quote characters. The following examples are properly escaped parameter values: Hello Brown Eyed Girl...
Page 12 Interfacing with Standard NetLinx API (SNAPI) An example program using these routines is shown below: // Build a command to be stored in cTestCmd cTestCmd = DuetPackCmdHeader('COMMAND') cTestCmd = DuetPackCmdParam(cTestCmd,'Morrison,Van') cTestCmd = DuetPackCmdParam(cTestCmd,'Wild Nights') cTestCmd = DuetPackCmdParam(cTestCmd,'"The Man"') cTestCmd = DuetPackCmdParam(cTestCmd,'Tupelo Honey') // Resulting command is: // 'COMMAND-"Morrison, Van",Wild Nights,""The Man"",Tupelo Honey' // Remove the parameters for this command...
Page 13: Amplifier
Amplifier IAmplifierComponent IAmplifierComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Amplifier Interface: IAmplifier Amplifier Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 14 Amplifier Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATIN 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-...
Page 15 Amplifier Functions (Cont.) Name Component Channel Level Command Constant Notes processVolumeEvent(int) IVolumeComponentListener VOL_LVL Volume changed, range is 0-255 processVolumeMuteEvent(boolean) IVolumeComponentListener 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) processVolumeRampEvent(UP) IVolumeComponentListener...
Page 16 Standard NetLinx API (SNAPI) R 1.8.0...
Page 17: Audio Conferencer
Audio Conferencer IAudioConferencerComponent IAudioConferencerComponentListener IDialerComponent IDialerComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPhonebookComponent IPhonebookComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Audio Conferencer Interface: IAudioConferencer Audio Conferencer Functions Name Component Channel Level Command Constant Notes cyclePrivacy() IAudioConferencerComponent ACONF_PRIVACY Momentary Function Channel: Cycle pri- vacy when channel is activated setPrivacyOn(state) IAudioConferencerComponent ACONF_PRIVACY_ON...
Page 18 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes dialNumber(number) IDialerComponent DIALNUMBER-<num- Dial a number where <number> is the num- ber> ber to be dialed. flashHook() IDialerComponent DIAL_FLASH_HOOK Momentary Function Channel: Flash hook when channel is activated getDialerStatus() IDialerComponent ?DIALERSTATUS Querydialer status, responds with DIALER-...
Page 19 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(DOWN) IMenuComponent MENU_DN Momentary Function Channel: Move menu cursor DOWN moveMenuCursor(LEFT) IMenuComponent MENU_LT Momentary Function Channel: Move menu cursor LEFT moveMenuCursor(RIGHT) IMenuComponent MENU_RT Momentary Function Channel: Move menu cursor RIGHT moveMenuCursor(UP_LEFT) IMenuComponent MENU_UP_LT...
Page 20 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(MENU) IMenuComponent MENU_FUNC Momentary Function Channel: Press menu button MENU pressMenuButton(EXIT) IMenuComponent MENU_EXIT Momentary Function Channel: Press menu button EXIT pressMenuButton(VIDEO) IMenuComponent MENU_VIDEO Momentary Function Channel: Press menu button VIDEO pressMenuButton(THUMBS_DOWN) IMenuComponent MENU_THUMBS_DN...
Page 21 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(HOLD) IMenuComponent MENU_HOLD Momentary Function Channel: Press menu button HOLD pressMenuButton(LIST) IMenuComponent MENU_LIST Momentary Function Channel: Press menu button LIST pressMenuButton(LEFT_PAREN) IMenuComponent MENU_LT_PAREN Momentary Function Channel: Press menu button LEFT_PAREN pressMenuButton(RIGHT_PAREN) IMenuComponent MENU_RT_PAREN...
Page 22 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(GUIDE) IMenuComponent MENU_GUIDE Momentary Function Channel: Press menu button GUIDE pressMenuButton(PAGE_UP) IMenuComponent MENU_PAGE_UP Momentary Function Channel: Press menu button PAGE_UP pressMenuButton(PAGE_DOWN) IMenuComponent MENU_PAGE_DN Momentary Function Channel: Press menu button PAGE_DOWN pressMenuButton(DECK_A_B) IMenuComponent MENU_DECK_A_B...
Page 23 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(B) IMenuComponent ALPHA-B Press menu button B pressMenuButton(C) IMenuComponent ALPHA-C Press menu button C pressMenuButton(D) IMenuComponent ALPHA-D Press menu button D pressMenuButton(E) IMenuComponent ALPHA-E Press menu button E pressMenuButton(F) IMenuComponent ALPHA-F Press menu button F...
Page 24 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes loadProperties(fileName) IModuleComponent LOADPROPERTY- Load properties from the file with the sup- <file> plied filename. Used to load meta-data properties for modules including Generic IR modules. passThru(buffer) IModuleComponent PASSTHRU-<buffer> Send a message directly to the device reinitialize() IModuleComponent REINIT...
Page 25 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes queryDB(si) IPhonebookComponent PHONEBOOKNEXT- Request next <count> records starting with <key>[,<count>,<posi- record <position> for the phonebook tion>] search associated with search key <key>. If <count> is not present, it is assumed to be 1.
Page 26 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes updateRecord(sdr) IPhonebookComponent PHONEBOOKUP- Update phonebook record with index/id of DATE- <id>, where <name> is the new name and <id>,<name>,<num- <number> is the new number ber> processCloseEvent(String) IPhonebookComponentListener PHONEBOOKCLOS- The search associated with search key ESEARCH-<key>...
Page 27 Audio Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes cycleVolumePreset() IVolumeComponent 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- Save Volume Preset where <preset> is 1 to <preset>...
Page 28 Standard NetLinx API (SNAPI) R 1.8.0...
Page 29: Audio Mixer
Audio Mixer IAudioMixerComponent IAudioMixerComponentListener IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener ISwitcherComponent ISwitcherComponentListener IVolumeComponent IVolumeComponentListener Name: Audio Mixer Interface: IAudioMixer Audio Mixer Functions Name Component Channel Level Command Constant Notes getAudioMixerCrosspoint(input,output) IAudioMixerComponent ?XPOINT- Query for Audio Mixer Crosspoint, <input>,<output> responds with XPOINT- <value>,<input>,<output> where <value> is 0 to 255, <input>...
Page 30 Audio Mixer Functions (Cont.) Name Component Channel Level Command Constant Notes setAudioMixerCrosspointMuteOn(input,out- IAudioMixerComponent XPOINTMUTE- Set Audio Mixer Crosspoint Mute for put,state) <state>,<input>,<out- <input> and <output> where <state> is 0 put> (un-muted) or 1 (muted). <input> is 1 to the maximum supported input and <out- put>...
Page 31 Audio Mixer Functions (Cont.) Name Component Channel Level Command Constant Notes 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>...
Page 32 Audio Mixer Functions (Cont.) Name Component Channel Level Command Constant Notes getOutput(sl,input) ISwitcherComponent ?OUTPUT- Query for the outputs connected to an [<sl>,]<input> 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.
Page 33 Audio Mixer Functions (Cont.) Name Component Channel Level Command Constant Notes 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 VOL_UP Ramping Channel: Volume is ramped up while channel is active setVolumeRamp(DOWN) IVolumeComponent...
Page 34 Standard NetLinx API (SNAPI) R 1.8.0...
Page 35: Audio Processor
Audio Processor IAudioProcessorComponent IAudioProcessorComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Audio Processor Interface: IAudioProcessor Audio Processor Functions Name Component Channel Level Command Constant Notes addAudioProcessorComponent(index,audio- IAudioProcessorComponent AUDIOPROCADD- Add a Audio Processor object at a given ProcessorAddress) <index>,<address> index, where <index> is 1 through x and <address>...
Page 36 Audio Processor Functions (Cont.) Name Component Channel Level Command Constant Notes getAudioProcessorOutput(input) IAudioProcessorComponent ?OUTPUT-<input> Query for the outputs connected to an input, respond with SWITCH- L<sl>I<input>O<output>,<output>Ö where <sl> is AUDIO and <input> is 0 if there is no connection. getAudioProcessorPreset() IAudioProcessorComponent ?AUDIOPROCPRE- Query for Audio Processor Preset,...
Page 37 Audio Processor Functions (Cont.) Name Component Channel Level Command Constant Notes switchAudioProcessorInputToOut- IAudioProcessorComponent AI<input>O<output,out- Switch <input> to one or more <output>s put(input,output[]) put,Ö> for switcher level Audio. Use <input> 0 for disconnect. processAudioProcessorCross- IAudioProcessorComponentListener XPOINT- Audio Processor crosspoint changed for pointEvent(int,int,int) <value>,<input>,<out- <input>...
Page 38 Audio Processor Functions (Cont.) Name Component Channel Level Command Constant Notes setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy> Set the device date/time. <hh:mm:ss> 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)
Page 39 Audio Processor State Charts processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 40 Standard NetLinx API (SNAPI) R 1.8.0...
Page 41: Audio Tape
Audio Tape IAudioTapeComponent IAudioTapeComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITapeTransportComponent ITapeTransportComponentListener Name: Audio Tape Interface: IAudioTape Audio Tape Functions Name Component Channel Level Command Constant Notes cycleAudioTapeRecordMute() IAudioTapeComponent CASS_RECORD_MUTE Momentary Function Channel: Cycle record mute when channel is activated cycleAudioTapeSide() IAudioTapeComponent CASS_TAPE_SIDE Momentary Function Channel: Cycle tape side when channel is activated...
Page 42 Audio Tape Functions (Cont.) Name Component Channel Level Command Constant Notes loadProperties(fileName) IModuleComponent LOADPROPERTY- Load properties from the file with the sup- <file> plied filename. Used to load meta-data properties for modules including Generic IR modules. passThru(buffer) IModuleComponent PASSTHRU-<buffer> Send a message directly to the device reinitialize() IModuleComponent REINIT...
Page 43 Audio Tape Functions (Cont.) Name Component Channel Level Command Constant Notes cycleSearchSpeed() ITapeTransportComponent SEARCH_SPEED Momentary Function Channel: Cycle search speed when channel is activated ejectTape() ITapeTransportComponent EJECT Momentary Function Channel: Tape is ejected when channel is activated resetTapeCounter() ITapeTransportComponent RESET_COUNTER Momentary Function Channel: Counter is reset when channel is activated setTapeCounterNotificationOn(state)
Page 44 Audio Tape Functions (Cont.) Name Component Channel Level Command Constant Notes processTapeTransportEvent(PAUSE) ITapeTransportComponentListener PAUSE_FB Feedback Channel: Transport state change (see chart below) processTapeTransportEvent(FF) ITapeTransportComponentListener FFWD_FB Feedback Channel: Transport state change (see chart below) processTapeTransportEvent(REW) ITapeTransportComponentListener REW_FB Feedback Channel: Transport state change (see chart below) processTapeTrans- ITapeTransportComponentListener...
Page 45 Audio Tape State Charts processPowerEvent State Channel 255 processTapeTransportEvent State Channel 241 Channel 242 Channel 243 Channel 244 Channel 245 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SEARCH_FWD SEARCH_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV Standard NetLinx API (SNAPI) R 1.8.0...
Page 46 Standard NetLinx API (SNAPI) R 1.8.0...
Page 47: Audio Tuner Device
Audio Tuner Device IAudioTunerDeviceComponent IAudioTunerDeviceComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITunerStationComponent ITunerStationComponentListener Name: Audio Tuner Device Interface: IAudioTunerDevice Audio Tuner Device Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent...
Page 48 Audio Tuner Device Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATIN Feedback Channel: Communication is established with device while channel is on processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received...
Page 49 Audio Tuner Device Functions (Cont.) Name Component Channel Level Command Constant Notes getStationPresetCount() ITunerStationComponent ?STATIONPRESET- Query for number of station presets COUNT getStationPresetProperties() ITunerStationComponent ?STATIONPRESET- Query for properties of all station presets PROPERTIES getStationPresetProperty(index) ITunerStationComponent ?STATIONPRESET- Query for properties of specific station pre- PROPERTY-<index>...
Page 50 Audio Tuner Device Functions (Cont.) Name Component Channel Level Command Constant Notes setStationPreset(preset) ITunerStationComponent TUNERPRESET-<pre- Recall tuner preset where <preset> is 1-x set> and x is the maximum supported preset (see specific module documentation) processBandEvent(TunerBand) ITunerStationComponentListener BAND-<band> Band changed, where <tb> is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV...
Page 51 Audio Tuner Device Functions (Cont.) Name Component Channel Level Command Constant Notes processTunerComponentProper- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTY tyEvent(String[]) PROPERTY- <index>,<dis- playName>,<value> Audio Tuner Device State Charts processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 52 Standard NetLinx API (SNAPI) R 1.8.0...
Page 53: Camera
Camera ICameraComponent ICameraComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Camera Interface: ICamera Camera Functions Name Component Channel Level Command Constant Notes cycleAutoFocus() ICameraComponent AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() ICameraComponent AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleCameraPreset() ICameraComponent...
Page 54 Camera Functions (Cont.) Name Component Channel Level Command Constant Notes setFocusSpeed(speed) ICameraComponent FOCUS_SPEED_LVL Set focus speed, range is 0-255 (0=slow) setIris(iris) ICameraComponent IRIS_LVL Set iris position, range is 0-255 (0=closed) setIrisRamp(OPEN) ICameraComponent IRIS_OPEN Ramping Channel: Iris is ramped open while channel is active setIrisRamp(CLOSE) ICameraComponent IRIS_CLOSE...
Page 55 Camera Functions (Cont.) Name Component Channel Level Command Constant Notes processCameraPresetPropertiesEv- ICameraComponentListener CAMERAPRESET- Response to ?CAMERAPRESETPROP- ent(String[]) PROPERTIES- ERTIES <index>,<dis- playName>,<value>[;- <index>,<dis- playName>,<value>] processCameraPresetPropertyEvent(String[]) ICameraComponentListener CAMERAPRESET- Response to ?CAMERAPRESETPROP- PROPERTY- ERTY <index>,<dis- playName>,<value> processFocusEvent(int) ICameraComponentListener FOCUS_LVL Focus changed, range is 0-255 (0=near) processFocusRampEvent(NEAR) ICameraComponentListener FOCUS_NEAR_FB...
Page 56 Camera Functions (Cont.) Name Component Channel Level Command Constant Notes processZoomRampEvent(IN) ICameraComponentListener ZOOM_IN_FB Feedback Channel: Zoom is ramping in (tele) while channel is on processZoomSpeedEvent(int) ICameraComponentListener ZOOM_SPEED_LVL Zoom speed changed, range is 0-255 (0=slow) getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state>...
Page 57 Camera Functions (Cont.) Name Component Channel Level Command Constant Notes setPower(ON) IPowerComponent PWR_ON Momentary Function Channel: Power is turned on when channel is activated setPower(OFF) IPowerComponent PWR_OFF Momentary Function Channel: Power is turned off when channel is activated setPower(ps) IPowerComponent POWER_ON Discrete Function Channel: Power is on while channel is active...
Page 58 Standard NetLinx API (SNAPI) R 1.8.0...
Page 59: Digital Media Decoder
Digital Media Decoder IDigitalMediaDecoderComponent IDigitalMediaDecoderComponentListener IDiscTransportComponent IDiscTransportComponentListener IMediaDeviceComponent IMediaDeviceComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Digital Media Decoder Interface: IDigitalMediaDecoder Digital Media Decoder Functions Name Component Channel Level Command Constant Notes cycleScanSpeed() IDiscTransportComponent SCAN_SPEED Momentary Function Channel: Cycles the scan speed when the channel is activated getTrackInfo() IDiscTransportComponent...
Page 60 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes setDiscTransport(SCAN_FWD) IDiscTransportComponent SFWD Momentary Function Channel: Deck is set to scan forward when the channel is acti- vated setDiscTransport(SCAN_REV) IDiscTransportComponent SREV Momentary Function Channel: Deck is set to scan reverse when the channel is acti- vated setDiscTransport(RECORD) IDiscTransportComponent...
Page 61 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes processTrackCounterEvent(MediaTime) IDiscTransportComponentListener TRACKCOUNTER- Track counter changed, where <counter> <counter> is a String in the format [-]hh:mm:ss.ff processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener TRACKINFO- Track info changed, where <num> is track <num>,<dura- number, <duration> is a track duration tion>,<discNumber>...
Page 62 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes processMediaDeviceCounterEvent(Media- IMediaDeviceComponentListener MEDIACOUNTER- Media counter changed, where <counter> Time) <counter> is a String in the format [-]hh:mm:ss.ff processMediaDevicePropertiesEvent(Proper- IMediaDeviceComponentListener DECODEPROP- Media property value where <key> is the ties) <key>,<value>...
Page 63 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_1) IMenuComponent DIGIT_1 Momentary Function Channel: Press menu button DIGIT_1 pressMenuButton(DIGIT_2) IMenuComponent DIGIT_2 Momentary Function Channel: Press menu button DIGIT_2 pressMenuButton(DIGIT_3) IMenuComponent DIGIT_3 Momentary Function Channel: Press menu button DIGIT_3 pressMenuButton(DIGIT_4) IMenuComponent...
Page 64 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(SLEEP) IMenuComponent MENU_SLEEP Momentary Function Channel: Press menu button SLEEP pressMenuButton(PPV) IMenuComponent MENU_PPV Momentary Function Channel: Press menu button PPV pressMenuButton(FUNCTION) IMenuComponent MENU_FUNCTION Momentary Function Channel: Press menu button FUNCTION pressMenuButton(SETUP) IMenuComponent...
Page 65 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(POUND) IMenuComponent MENU_POUND Momentary Function Channel: Press menu button POUND pressMenuButton(COMMA) IMenuComponent MENU_COMMA Momentary Function Channel: Press menu button COMMA pressMenuButton(DIAL) IMenuComponent MENU_DIAL Momentary Function Channel: Press menu button DIAL pressMenuButton(CONFERENCE) IMenuComponent...
Page 66 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(HELP) IMenuComponent MENU_HELP Momentary Function Channel: Press menu button HELP pressMenuButton(TITLE) IMenuComponent MENU_TITLE Momentary Function Channel: Press menu button TITLE pressMenuButton(TOP_MENU) IMenuComponent MENU_TOP_MENU Momentary Function Channel: Press menu button TOP_MENU pressMenuButton(ZOOM) IMenuComponent...
Page 67 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(O) IMenuComponent ALPHA-O Press menu button O pressMenuButton(P) IMenuComponent ALPHA-P Press menu button P pressMenuButton(Q) IMenuComponent ALPHA-Q Press menu button Q pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R pressMenuButton(S) IMenuComponent ALPHA-S...
Page 68 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes setProperty(key,value) IModuleComponent PROPERTY- Set the value of property <key> to <value> <key>,<value> processDataInitializedEvent(boolean) IModuleComponentListener DATA_INITIALIZED Feedback Channel: Module data is syn- chronized with device while channel is on processDebugEvent(int) IModuleComponentListener DEBUG-<state>...
Page 69 Digital Media Decoder Functions (Cont.) Name Component Channel Level Command Constant Notes setVolumeRamp(UP) IVolumeComponent VOL_UP Ramping Channel: Volume is ramped up while channel is active setVolumeRamp(DOWN) IVolumeComponent VOL_DN Ramping Channel: Volume is ramped down while channel is active processVolumeEvent(int) IVolumeComponentListener VOL_LVL Volume changed, range is 0-255 processVolumeMuteEvent(boolean)
Page 70 Digital Media Decoder State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SCAN_FWD SCAN_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON RANDOM_ALL RANDOM_OFF...
Page 71: Digital Media Encoder
Digital Media Encoder IDigitalMediaEncoderComponent IDigitalMediaEncoderComponentListener IDiscTransportComponent IDiscTransportComponentListener IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener IOutputStreamComponent IOutputStreamComponentListener IPowerComponent IPowerComponentListener Name: Digital Media Encoder Interface: IDigitalMediaEncoder Digital Media Encoder Functions Name Component Channel Level Command Constant Notes cycleScanSpeed() IDiscTransportComponent SCAN_SPEED Momentary Function Channel: Cycles the scan speed when the channel is activated getTrackInfo() IDiscTransportComponent...
Page 72 Digital Media Encoder Functions (Cont.) Name Component Channel Level Command Constant Notes setDiscTransport(SCAN_REV) IDiscTransportComponent SREV Momentary Function Channel: Deck is set to scan reverse when the channel is acti- vated setDiscTransport(RECORD) IDiscTransportComponent RECORD Momentary Function Channel: Deck is set to record when the channel is activated setDiscTransport(FRAME_FWD) IDiscTransportComponent FRAME_FWD...
Page 73 Digital Media Encoder Functions (Cont.) Name Component Channel Level Command Constant Notes processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener TRACKINFO- Track info changed, where <num> is track <num>,<dura- number, <duration> is a track duration tion>,<discNumber> String in the format [-]hh:mm:ss.ff and <dis- cNumber> is the dusc number the track belongs to.
Page 74 Digital Media Encoder Functions (Cont.) Name Component Channel Level Command Constant Notes setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy> Set the device date/time. <hh:mm:ss> 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)
Page 75 Digital Media Encoder Functions (Cont.) Name Component Channel Level Command Constant Notes processOutputStreamPropertiesEvent(Prop- IOutputStreamComponentListener ENCODEPROP- Output Stream Property value where <key> erties) <key>,<value> is the property key and <value> is the prop- erty value. One command is returned for each key. processOutputStreamSinkAddEvent(URL) IOutputStreamComponentListener ENCODESINKADD-...
Page 76 Digital Media Encoder State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SCAN_FWD SCAN_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 77: Digital Media Server
Digital Media Server IDigitalMediaServerComponent IDigitalMediaServerComponentListener IDiscTransportComponent IDiscTransportComponentListener IGainComponent IGainComponentListener IMediaDBComponent IMediaDBComponentListener IMediaDeviceComponent IMediaDeviceComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IOutputStreamComponent IOutputStreamComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Digital Media Server Interface: IDigitalMediaServer Digital Media Server Functions Name Component Channel Level Command Constant Notes cycleScanSpeed() IDiscTransportComponent SCAN_SPEED...
Page 78 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes setDiscTransport(NEXT) IDiscTransportComponent FFWD Momentary Function Channel: Deck is set to next track/chapter when the channel is activated setDiscTransport(PREVIOUS) IDiscTransportComponent Momentary Function Channel: Deck is set to previous track/chapter when the channel is activated setDiscTransport(SCAN_FWD) IDiscTransportComponent...
Page 79 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes processDiscTransportEvent(SLOW_FWD) IDiscTransportComponentListener SLOW_FWD_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent(SLOW_REV) IDiscTransportComponentListener SLOW_REV_FB Feedback Channel: Transport state change (see chart below) processTrackCounterEvent(MediaTime) IDiscTransportComponentListener TRACKCOUNTER- Track counter changed, where <counter> <counter>...
Page 80 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes queryDB(mdbss) IMediaDBComponent MEDIADBNEXT-<key> Request next record (count =1) starting with the next record <position> for the media search associated with search key <key>. If <position> is not present, it is assumed th be the next record in the search result set based on the last MEDI- ADBNEXT or MEDIADBPREV command.
Page 81 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes queryDB(mdbss, count) IMediaDBComponent MEDIADBREFRESH- Refresh record starting with the last starting <key>,<count> position used with a MEDIADBNEXT or MEDIADBPREV command for the media search associated with search key <key>. Responses with MEDIADBNEXT- <key>,<count>,<position>...
Page 82 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes updateRecord(rec) IMediaDBComponent MEDIADBUPDATE- Update media record with record id of <id>, <id>,<name>,<record where <name> is the new name and type>[,<url>] <record type> is the new record type, i.e. PICTURE, APPLICATION, TRACK, CHAP- TER, PLAYLIST, BOOKMARK, DISC, AUDIO, VIDEO, GENRE, ARTIST, STA-...
Page 83 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes queryMediaDeviceProperties() IMediaDeviceComponent ?DECODEPROPS Query for all Media Device Properties, responds with multiple DECODEPROP- <key>,<value>, one for each property, where <key> is the property key and <value> is the property value. queryMediaDeviceProperty(sKeyName) IMediaDeviceComponent ?DECODEPROP-...
Page 84 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes processMediaDeviceRepeat- IMediaDeviceComponentListener MEDIA_REPEAT_ALL_FB Feedback Channel: Repeat state change StateEvent(REPEAT_ALL) (see chart below) processMediaDeviceRepeat- IMediaDeviceComponentListener MEDIA_REPEAT_OFF_FB Feedback Channel: Repeat state change StateEvent(REPEAT_OFF) (see chart below) processMediaDeviceSourceInfoEvent (Medi- IMediaDeviceComponentListener DECODESOURCE- Media Device Source changed where aDeviceSourceInfo ) <recor-...
Page 85 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_9) IMenuComponent DIGIT_9 Momentary Function Channel: Press menu button DIGIT_9 pressMenuButton(PLUS_10) IMenuComponent MENU_PLUS_10 Momentary Function Channel: Press menu button PLUS_10 pressMenuButton(ENTER) IMenuComponent MENU_ENTER Momentary Function Channel: Press menu button ENTER pressMenuButton(CANCEL) IMenuComponent...
Page 86 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(BACK) IMenuComponent MENU_BACK Momentary Function Channel: Press menu button BACK pressMenuButton(FORWARD) IMenuComponent MENU_FORWARD Momentary Function Channel: Press menu button FORWARD pressMenuButton(ADVANCE) IMenuComponent MENU_ADVANCE Momentary Function Channel: Press menu button ADVANCE pressMenuButton(DIMMER) IMenuComponent...
Page 87 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(INFO) IMenuComponent MENU_INFO Momentary Function Channel: Press menu button INFO pressMenuButton(FAVORITES) IMenuComponent MENU_FAVORITES Momentary Function Channel: Press menu button FAVORITES pressMenuButton(CONTINUE) IMenuComponent MENU_CONTINUE Momentary Function Channel: Press menu button CONTINUE pressMenuButton(RETURN) IMenuComponent...
Page 88 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(SEND_GRAPHICS) IMenuComponent MENU_SEND_GRAPHICS Momentary Function Channel: Press menu button SEND_GRAPHICS pressMenuButton(FLASH) IMenuComponent MENU_FLASH Momentary Function Channel: Press menu button FLASH pressMenuButton(RESET) IMenuComponent MENU_RESET Momentary Function Channel: Press menu button RESET pressMenuButton(INSTANT_REPLAY) IMenuComponent...
Page 89 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes selectMenuItem() IMenuComponent MENU_SELECT Momentary Function Channel: Select cur- rent menu item getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 90 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes getOutputStreamSinks() IOutputStreamComponent ?ENCODESINK Query for Output Stream Sinks, responds with multiple ENCODESINK-<url>, one for each output stream sink, where <url> is the URL of the sink/destination. getOutputStreamSource() IOutputStreamComponent ?ENCODESOURCE- Query for Output Stream Source, responds <url>...
Page 91 Digital Media Server Functions (Cont.) Name Component Channel Level Command Constant Notes setPowerSensor(nld,nIOChan) IPowerComponent IOLINK-<dps>,<chan- Associate a Power Sensor with the device nel> 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.
Page 92 Digital Media Server State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SCAN_FWD SCAN_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON RANDOM_ALL RANDOM_OFF...
Page 93: Digital Satellite System
Digital Satellite System IDigitalSatelliteSystemComponent IDigitalSatelliteSystemComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITunerStationComponent ITunerStationComponentListener Name: Digital Satellite System Interface: IDigitalSatelliteSystem Digital Satellite System Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP Momentary Function Channel: Move menu cursor UP moveMenuCursor(DOWN) IMenuComponent MENU_DN...
Page 94 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5 Momentary Function Channel: Press menu button DIGIT_5 pressMenuButton(DIGIT_6) IMenuComponent DIGIT_6 Momentary Function Channel: Press menu button DIGIT_6 pressMenuButton(DIGIT_7) IMenuComponent DIGIT_7 Momentary Function Channel: Press menu button DIGIT_7 pressMenuButton(DIGIT_8) IMenuComponent...
Page 95 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(XM) IMenuComponent MENU_XM Momentary Function Channel: Press menu button XM pressMenuButton(FM) IMenuComponent MENU_FM Momentary Function Channel: Press menu button FM pressMenuButton(AM) IMenuComponent MENU_AM Momentary Function Channel: Press menu button AM pressMenuButton(CLEAR) IMenuComponent...
Page 96 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 pressMenuButton(PLUS_1000) IMenuComponent MENU_PLUS_1000 Momentary Function Channel: Press menu button PLUS_1000 pressMenuButton(DISPLAY) IMenuComponent MENU_DISPLAY Momentary Function Channel: Press menu button DISPLAY pressMenuButton(SUBTITLE) IMenuComponent...
Page 97 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE Momentary Function Channel: Press menu button ANGLE pressMenuButton(AUDIO) IMenuComponent MENU_AUDIO Momentary Function Channel: Press menu button AUDIO pressMenuButton(PREVIEW_INPUT) IMenuComponent MENU_PREVIEW_INPUT Momentary Function Channel: Press menu button PREVIEW_INPUT pressMenuButton(SEND_INPUT) IMenuComponent...
Page 98 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V) IMenuComponent ALPHA-V Press menu button V pressMenuButton(W) IMenuComponent ALPHA-W Press menu button W pressMenuButton(X) IMenuComponent ALPHA-X Press menu button X pressMenuButton(Y) IMenuComponent ALPHA-Y...
Page 99 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 100 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes getStationPresetProperty(index) ITunerStationComponent ?STATIONPRESET- Query for properties of specific station pre- PROPERTY-<index> getTunerBandCount() ITunerStationComponent ?TUNERBANDCOUNT Query for number of tuner bands getTunerBandProperties() ITunerStationComponent ?TUNERBANDPROP- Query for properties of all tuner bands ERTIES getTunerBandProperty(index) ITunerStationComponent...
Page 101 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes processBandEvent(TunerBand) ITunerStationComponentListener BAND-<band> Band changed, where <tb> is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV processStationEvent(String) ITunerStationComponentListener XCH-<station> Station changed, where <station> is a sta- tion string such as "501", "103.7" or "5.1" processStationPresetCountEvent(count) ITunerStationComponentListener STATIONPRESET-...
Page 102 Digital Satellite System Functions (Cont.) Name Component Channel Level Command Constant Notes processTunerComponentProper- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTY tyEvent(String[]) PROPERTY- <index>,<dis- playName>,<value> Digital Satellite System State Charts processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 103: Digital Video Recorder
Digital Video Recorder IDigitalVideoRecorderComponent IDigitalVideoRecorderComponentListener IDiscTransportComponent IDiscTransportComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener Name: Digital Video Recorder Interface: IDigitalVideoRecorder Digital Video Recorder Functions Name Component Channel Level Command Constant Notes cycleScanSpeed() IDiscTransportComponent SCAN_SPEED Momentary Function Channel: Cycles the scan speed when the channel is activated getTrackInfo() IDiscTransportComponent...
Page 104 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes setDiscTransport(SCAN_FWD) IDiscTransportComponent SFWD Momentary Function Channel: Deck is set to scan forward when the channel is acti- vated setDiscTransport(SCAN_REV) IDiscTransportComponent SREV Momentary Function Channel: Deck is set to scan reverse when the channel is acti- vated setDiscTransport(RECORD) IDiscTransportComponent...
Page 105 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes processTrackCounterEvent(MediaTime) IDiscTransportComponentListener TRACKCOUNTER- Track counter changed, where <counter> <counter> is a String in the format [-]hh:mm:ss.ff processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener TRACKINFO- Track info changed, where <num> is track <num>,<dura- number, <duration> is a track duration tion>,<discNumber>...
Page 106 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_8) IMenuComponent DIGIT_8 Momentary Function Channel: Press menu button DIGIT_8 pressMenuButton(DIGIT_9) IMenuComponent DIGIT_9 Momentary Function Channel: Press menu button DIGIT_9 pressMenuButton(PLUS_10) IMenuComponent MENU_PLUS_10 Momentary Function Channel: Press menu button PLUS_10 pressMenuButton(ENTER) IMenuComponent...
Page 107 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(CLEAR) IMenuComponent MENU_CLEAR Momentary Function Channel: Press menu button CLEAR pressMenuButton(BACK) IMenuComponent MENU_BACK Momentary Function Channel: Press menu button BACK pressMenuButton(FORWARD) IMenuComponent MENU_FORWARD Momentary Function Channel: Press menu button FORWARD pressMenuButton(ADVANCE) IMenuComponent...
Page 108 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(SUBTITLE) IMenuComponent MENU_SUBTITLE Momentary Function Channel: Press menu button SUBTITLE pressMenuButton(INFO) IMenuComponent MENU_INFO Momentary Function Channel: Press menu button INFO pressMenuButton(FAVORITES) IMenuComponent MENU_FAVORITES Momentary Function Channel: Press menu button FAVORITES pressMenuButton(CONTINUE) IMenuComponent...
Page 109 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(SEND_INPUT) IMenuComponent MENU_SEND_INPUT Momentary Function Channel: Press menu button SEND_INPUT pressMenuButton(SEND_GRAPHICS) IMenuComponent MENU_SEND_GRAPHICS Momentary Function Channel: Press menu button SEND_GRAPHICS pressMenuButton(FLASH) IMenuComponent MENU_FLASH Momentary Function Channel: Press menu button FLASH pressMenuButton(RESET) IMenuComponent...
Page 110 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(Z) IMenuComponent ALPHA-Z Press menu button Z selectMenuItem() IMenuComponent MENU_SELECT Momentary Function Channel: Select cur- rent menu item getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent...
Page 111 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes setPower(ON) IPowerComponent PWR_ON Momentary Function Channel: Power is turned on when channel is activated setPower(OFF) IPowerComponent PWR_OFF Momentary Function Channel: Power is turned off when channel is activated setPower(ps) IPowerComponent POWER_ON...
Page 112 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(VIDEO,3) ISourceSelectComponent SOURCE_VIDEO3 Momentary Function Channel: Selects input VIDEO,3 when channel is activated setInputSource(TAPE,1) ISourceSelectComponent SOURCE_TAPE1 Momentary Function Channel: Selects input TAPE,1 when channel is activated setInputSource(TAPE,2) ISourceSelectComponent SOURCE_TAPE2 Momentary Function Channel: Selects input TAPE,2 when channel is activated...
Page 113 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes processInputPropertyEvent(String[]) ISourceSelectComponentListener INPUTPROPERTY- Response to ?INPUTPROPERTY- <index>,<input- <index>,<group>,<label>,<signal- Group>,<deviceLa- Type>,<AVType>, where <group> is the bel>,<signalType>,<AV integer index based on mutually exclusive Type> inputs, <label> is the text on the device, <signalType>...
Page 114 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes getStationPresetProperty(index) ITunerStationComponent ?STATIONPRESET- Query for properties of specific station pre- PROPERTY-<index> getTunerBandCount() ITunerStationComponent ?TUNERBANDCOUNT Query for number of tuner bands getTunerBandProperties() ITunerStationComponent ?TUNERBANDPROP- Query for properties of all tuner bands ERTIES getTunerBandProperty(index) ITunerStationComponent...
Page 115 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes processBandEvent(TunerBand) ITunerStationComponentListener BAND-<band> Band changed, where <tb> is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV processStationEvent(String) ITunerStationComponentListener XCH-<station> Station changed, where <station> is a sta- tion string such as "501", "103.7" or "5.1" processStationPresetCountEvent(count) ITunerStationComponentListener STATIONPRESET-...
Page 116 Digital Video Recorder Functions (Cont.) Name Component Channel Level Command Constant Notes processTunerComponentProper- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTY tyEvent(String[]) PROPERTY- <index>,<dis- playName>,<value> Digital Video Recorder State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE...
Page 117: Disc Device
Disc Device IDiscDeviceComponent IDiscDeviceComponentListener IDiscTransportComponent IDiscTransportComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Disc Device Interface: IDiscDevice Disc Device Functions Name Component Channel Level Command Constant Notes cycleDiscTray() IDiscDeviceComponent DISC_TRAY Momentary Function Channel: Open or Close the disc tray when the channel is activated cycleRandom() IDiscDeviceComponent...
Page 118 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes queryTitleProperty(key) IDiscDeviceComponent ?TITLEPROP-<key> Query for a title property, responds with TITLEPROP-<key>,<value> command setDisc(discNumber) IDiscDeviceComponent SETDISC-<disc> Set disc number to <disc>, where <disc> is 1 to <x> where x is the disc capacity. (see getDiscCapactiy() or module specific docu- mentation) setPlayPosition(titleNumber,trackNumber)
Page 119 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes processDiscInfoEvent(DiscInfo) IDiscDeviceComponentListener DISCINFO- Disc info changed, where <num> is disc <num>,<duration>,<# number, <duration> is a disc duration of titles>,<#of String in the format [-]hh:mm:ss.ff, <# of tracks>,<disc- tracks> is the number of titles in this disc, Type>,<id>...
Page 120 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes queryTrackProperty(key) IDiscTransportComponent ?TRACKPROP-<key> Query for a track property, responds with TRACKPROP-<key>,<value> command setDiscTransport(PLAY) IDiscTransportComponent PLAY Momentary Function Channel: Deck is set to play when the channel is activated setDiscTransport(STOP) IDiscTransportComponent STOP Momentary Function Channel: Deck is set...
Page 121 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes processDiscTransportEvent(PAUSE) IDiscTransportComponentListener PAUSE_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent(SCAN_FWD) IDiscTransportComponentListener SFWD_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent(SCAN_REV) IDiscTransportComponentListener SREV_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent(RECORD) IDiscTransportComponentListener...
Page 122 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_2) IMenuComponent DIGIT_2 Momentary Function Channel: Press menu button DIGIT_2 pressMenuButton(DIGIT_3) IMenuComponent DIGIT_3 Momentary Function Channel: Press menu button DIGIT_3 pressMenuButton(DIGIT_4) IMenuComponent DIGIT_4 Momentary Function Channel: Press menu button DIGIT_4 pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5...
Page 123 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PPV) IMenuComponent MENU_PPV Momentary Function Channel: Press menu button PPV pressMenuButton(FUNCTION) IMenuComponent MENU_FUNCTION Momentary Function Channel: Press menu button FUNCTION pressMenuButton(SETUP) IMenuComponent MENU_SETUP Momentary Function Channel: Press menu button SETUP pressMenuButton(XM) IMenuComponent MENU_XM...
Page 124 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(COMMA) IMenuComponent MENU_COMMA Momentary Function Channel: Press menu button COMMA pressMenuButton(DIAL) IMenuComponent MENU_DIAL Momentary Function Channel: Press menu button DIAL pressMenuButton(CONFERENCE) IMenuComponent MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100...
Page 125 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(TITLE) IMenuComponent MENU_TITLE Momentary Function Channel: Press menu button TITLE pressMenuButton(TOP_MENU) IMenuComponent MENU_TOP_MENU Momentary Function Channel: Press menu button TOP_MENU pressMenuButton(ZOOM) IMenuComponent MENU_ZOOM Momentary Function Channel: Press menu button ZOOM pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE...
Page 126 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(Q) IMenuComponent ALPHA-Q Press menu button Q pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R pressMenuButton(S) IMenuComponent ALPHA-S Press menu button S pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U...
Page 127 Disc Device Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATIN Feedback Channel: Communication is established with device while channel is on processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received...
Page 128 Disc Device State Charts processRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON RANDOM_ALL RANDOM_OFF processRepeatStateEvent State Channel 181 Channel 182 Channel 183 Channel 184 REPEAT_DISC REPEAT_TRACK OFF REPEAT_ALL REPEAT_OFF processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE...
Page 129: Document Camera
Document Camera IDocumentCameraComponent IDocumentCameraComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener Name: Document Camera Interface: IDocumentCamera Document Camera Functions Name Component Channel Level Command Constant Notes cycleAutoFocus() IDocumentCameraComponent AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() IDocumentCameraComponent AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated...
Page 130 Document Camera Functions (Cont.) Name Component Channel Level Command Constant Notes setZoomRamp(OUT) IDocumentCameraComponent ZOOM_OUT Ramping Channel: Zoom is ramped out(far) while channel is active setZoomRamp(IN) IDocumentCameraComponent ZOOM_IN Ramping Channel: Zoom is ramped in (tele) while channel is active setZoomSpeed(speed) IDocumentCameraComponent ZOOM_SPEED_LVL Set zoom speed, range is 0-255 (0=slow) processAutoFocusEvent(boolean)
Page 131 Document Camera Functions (Cont.) Name Component Channel Level Command Constant Notes 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- Load properties from the file with the sup- <file>...
Page 132 Document Camera Functions (Cont.) Name Component Channel Level Command Constant Notes setPowerSensor(nld,nIOChan) IPowerComponent IOLINK-<dps>,<chan- Associate a Power Sensor with the device nel> 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.
Page 133 Document Camera Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(CD,1) ISourceSelectComponent SOURCE_CD1 Momentary Function Channel: Selects input CD,1 when channel is activated setInputSource(TUNER,1) ISourceSelectComponent SOURCE_TUNER1 Momentary Function Channel: Selects input TUNER,1 when channel is activated setInputSource(PHONO,1) ISourceSelectComponent SOURCE_PHONO1 Momentary Function Channel: Selects input PHONO,1 when channel is activated setInputSource(AUXILIARY,1)
Page 134 Document Camera Functions (Cont.) Name Component Channel Level Command Constant Notes processInputSourceEvent(InputSourceSe- ISourceSelectComponentListener INPUT-<sourceSe- Current input has changed, where <source- lectInfo) lect>,<inputNumber> Select> is RGB,SVIDEO,COMPOS- ITE,COMPONENT,DVI,HDMI,SDI,VGA,AU DIO,AUXILIARY,CABLE,CAMERA,CD, COMPUTER, DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINI- DISC,PHONO,SATELLITE,TAPE,TUNER, TV,VCR,VIDEO and <inputNumber> is the instance number of the source select Document Camera State Charts processPowerEvent State...
Page 135: Hvac
HVAC IHVACComponent IHVACComponentListener IModuleComponent IModuleComponentListener Name: HVAC Interface: IHVAC HVAC Functions Name Component Channel Level Command Constant Notes addHVACComponent(index,hvacAddress) IHVACComponent HVACADD- Add a thermostat at a given index, where <index>,<hvacAd- <index> is 1-x and <address> is a thermo- dress> stat address and x is the maximum sup- ported thermostat index (see specific module documentation) cycleFanState()
Page 136 HVAC Functions (Cont.) Name Component Channel Level Command Constant Notes getTemperatureScale() IHVACComponent ?HVACSCALE Query for the temperature scale, responds with HVACSCALE-<scale> where <scale> is FAHRENHEIT,CELSIUS incrementCoolSetpoint() IHVACComponent HVAC_COOL_UP Momentary Function Channel: Increment the cool setpoint when channel is activated incrementDehumidifySetpoint() IHVACComponent HVAC_DEHUMIDIFY_UP Momentary Function Channel: Increment...
Page 137 HVAC Functions (Cont.) Name Component Channel Level Command Constant Notes setHumidifyState(hs) IHVACComponent HVACHUMID-<hs> Set the humidify state, where <hs> is OFF,HUMIDIFY,DEHUMIDIFY,AUTO setHVACState(AUTO) IHVACComponent HVAC_AUTO Momentary Function Channel: HVAC state is auto while channel is active setHVACState(COOL) IHVACComponent HVAC_COOL Momentary Function Channel: HVAC state is cool while channel is active setHVACState(HEAT) IHVACComponent...
Page 138 HVAC Functions (Cont.) Name Component Channel Level Command Constant Notes processHumidifyStateEvent(HumidifyState) IHVACComponentListener HVACHUMID-<state> Humidify state changed, <state> is OFF,HUMIDIFY,DEHUMIDIFY,AUTO processHumidifyStatusEvent(DEHUMIDIFY) IHVACComponentListener HVAC_DEHUMIDIFING_FB Feedback Channel: Humidity status change (see chart below) processHumidifyStatusEvent(HUMIDIFY) IHVACComponentListener HVAC_HUMIDIFING_FB Feedback Channel: Humidity status change (see chart below) processHumidifyStatusEvent(HumidifyStatus) IHVACComponentListener HVACHUMIDSTATUS-...
Page 139 HVAC Functions (Cont.) Name Component Channel Level Command Constant Notes 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>...
Page 140 HVAC State Charts processFanStateEvent State Channel 214 Channel 215 AUTO OFF processFanStatusEvent State Channel 216 processHumidifyStateEvent State Channel 228 Channel 229 Channel 230 Channel 231 AUTO DEHUMIDIFY OFF HUMIDIFY processHumidifyStatusEvent State Channel 232 Channel 233 DEHUMIDIFY ON HUMIDIFY processHVACStateEvent State Channel 219 Channel 220 Channel 221 Channel 222 Channel 223 AUTO COOL...
Page 141 processHVACStatusEvent State Channel 224 Channel 225 Channel 226 Channel 227 COOL HEAT COOL_2 EMERGENCY_HEAT OFF Standard NetLinx API (SNAPI) R 1.8.0...
Page 142 Standard NetLinx API (SNAPI) R 1.8.0...
Page 143: Io Device
IO Device IIODeviceComponent IIODeviceComponentListener IModuleComponent IModuleComponentListener Name: IO Device Interface: IIODevice IO Device Functions Name Component Channel Level Command Constant Notes getIOChannelCount() IIODeviceComponent ?IOCHANNELCOUNT Query for the number of channels on an IO device, responds with IOCHANNEL- COUNT getIOChannelDirection(io-chan) IIODeviceComponent ?IOCHANNELDIREC- Query for direction of the I/O channel, TION-<io-chan>...
Page 144 IO Device Functions (Cont.) Name Component Channel Level Command Constant Notes 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>...
Page 145: Keypad
Keypad IKeypadComponent IKeypadComponentListener IModuleComponent IModuleComponentListener Name: Keypad Interface: IKeypad Keypad Functions Name Component Channel Level Command Constant Notes addKeypadComponent(index,keypadAd- IKeypadComponent KEYPADADD- Add a keypad address at a given index, dress) <index>,<keypadaddr> where <index> is 1-x and <keypadaddr> is a keypad address and x is the maximum supported keypad index (see specific mod- ule documentation) getKeypadComponentAddress(index)
Page 146 Keypad Functions (Cont.) Name Component Channel Level Command Constant Notes processButtonStateEvent(ButtonState) IKeypadComponentListener KEYPADBTN- Button State changed. <btn> is button <btn>,<state> number and <state> is CLICK or DOUBLE- CLICK processButtonStatusEvent(ON) IKeypadComponentListener <btn> Feedback Channel: Button status on ON while channel <btn> is on and channel <btn>+100 is off, where <btn>...
Page 147 Keypad Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 148 Standard NetLinx API (SNAPI) R 1.8.0...
Page 149: Light
Light IKeypadComponent IKeypadComponentListener ILightComponent ILightComponentListener IModuleComponent IModuleComponentListener Name: Light Interface: ILight Light Functions Name Component Channel Level Command Constant Notes addKeypadComponent(index,keypadAd- IKeypadComponent KEYPADADD- Add a keypad address at a given index, dress) <index>,<keypadaddr> where <index> is 1-x and <keypadaddr> is a keypad address and x is the maximum supported keypad index (see specific mod- ule documentation)
Page 150 Light Functions (Cont.) Name Component Channel Level Command Constant Notes processButtonStateEvent(RELEASE) IKeypadComponentListener <btn> Input Function Channel: Button state is Pushed when BUTTON_EVENT-PUSH is received, where <btn> is the button/chan- nel number processButtonStateEvent(ButtonState) IKeypadComponentListener KEYPADBTN- Button State changed. <btn> is button <btn>,<state>...
Page 151 Light Functions (Cont.) Name Component Channel Level Command Constant Notes cycleLight(19) ILightComponent LIGHTSTATE-19,TOG- Toggle Light Preset 19 cycleLight(2) ILightComponent LIGHTSTATE-2,TOG- Toggle Light Preset 2 cycleLight(20) ILightComponent LIGHTSTATE-20,TOG- Toggle Light Preset 20 cycleLight(3) ILightComponent LIGHTSTATE-3,TOG- Toggle Light Preset 3 cycleLight(4) ILightComponent LIGHTSTATE-4,TOG- Toggle Light Preset 4 cycleLight(5)
Page 152 Light Functions (Cont.) Name Component Channel Level Command Constant Notes isLightOn(15) ILightComponent ?LIGHTSTATE-15 Query status of Light Preset 15 isLightOn(16) ILightComponent ?LIGHTSTATE-16 Query status of Light Preset 16 isLightOn(17) ILightComponent ?LIGHTSTATE-17 Query status of Light Preset 17 isLightOn(18) ILightComponent ?LIGHTSTATE-18 Query status of Light Preset 18 isLightOn(19) ILightComponent...
Page 153 Light Functions (Cont.) Name Component Channel Level Command Constant Notes processLightEvent(11, boolean) ILightComponentListener LIGHTSTATE- Response to ?LIGHTSTATE-11 11,<state> processLightEvent(12, boolean) ILightComponentListener LIGHTSTATE- Response to ?LIGHTSTATE-12 12,<state> processLightEvent(13, boolean) ILightComponentListener LIGHTSTATE- Response to ?LIGHTSTATE-13 13,<state> processLightEvent(14, boolean) ILightComponentListener LIGHTSTATE- Response to ?LIGHTSTATE-14 14,<state>...
Page 154 Light Functions (Cont.) Name Component Channel Level Command Constant Notes getVersion() IModuleComponent ?VERSION Query for the module version, responds with VERSION-<version> loadProperties(fileName) IModuleComponent LOADPROPERTY- Load properties from the file with the sup- <file> plied filename. Used to load meta-data properties for modules including Generic IR modules.
Page 155 Light State Charts processButtonStateEvent State Channel <btn> RELEASE PUSH processButtonStatusEvent State Channel <btn> Channel <btn>+100 BLINK Note: All Keypad commands include an index. This index is used to obtain the keypad component and the function is called on that component. The range for channel '<btn>' is 1 to 100;...
Page 156 Standard NetLinx API (SNAPI) R 1.8.0...
Page 157: Monitor
Monitor IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IMonitorComponent IMonitorComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVolumeComponent IVolumeComponentListener Name: Monitor Interface: IMonitor Monitor Functions Name Component Channel Level Command Constant Notes adjustBrightness(1) IDisplayComponent BRIGHT_UP Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(-1) IDisplayComponent BRIGHT_DN...
Page 158 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes cycleFreeze() IDisplayComponent PIC_FREEZE Momentary Function Channel: Cycle freeze when channel is activated cyclePictureMute() IDisplayComponent PIC_MUTE Momentary Function Channel: Cycle pic- ture mute when channel is activated cyclePIP() IDisplayComponent Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() IDisplayComponent...
Page 159 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes setTint(level) IDisplayComponent TINT_LVL Set tint level, range is 0-255 setVideoType(vt) IDisplayComponent VIDEOTYPE-<vt> Set video type, where <vt> is AUTO,NTSC,PAL,SECAM swapPIP() IDisplayComponent PIP_SWAP Momentary Function Channel: Swap PIP when channel is activated processActiveWindowEvent(MultiScreenSe- IDisplayComponentListener ACTIVEWINDOW-...
Page 160 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(RIGHT) IMenuComponent MENU_RT Momentary Function Channel: Move menu cursor RIGHT moveMenuCursor(UP_LEFT) IMenuComponent MENU_UP_LT Momentary Function Channel: Move menu cursor UP_LEFT moveMenuCursor(UP_RIGHT) IMenuComponent MENU_UP_RT Momentary Function Channel: Move menu cursor UP_RIGHT moveMenuCursor(DOWN_LEFT) IMenuComponent MENU_DN_LT...
Page 161 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(VIDEO) IMenuComponent MENU_VIDEO Momentary Function Channel: Press menu button VIDEO pressMenuButton(THUMBS_DOWN) IMenuComponent MENU_THUMBS_DN Momentary Function Channel: Press menu button THUMBS_DOWN pressMenuButton(THUMBS_UP) IMenuComponent MENU_THUMBS_UP Momentary Function Channel: Press menu button THUMBS_UP pressMenuButton(ACCEPT) IMenuComponent MENU_ACCEPT...
Page 162 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(LEFT_PAREN) IMenuComponent MENU_LT_PAREN Momentary Function Channel: Press menu button LEFT_PAREN pressMenuButton(RIGHT_PAREN) IMenuComponent MENU_RT_PAREN Momentary Function Channel: Press menu button RIGHT_PAREN pressMenuButton(UNDER_SCORE) IMenuComponent MENU_UNDERSCORE Momentary Function Channel: Press menu button UNDER_SCORE pressMenuButton(DASH) IMenuComponent MENU_DASH...
Page 163 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PAGE_DOWN) IMenuComponent MENU_PAGE_DN Momentary Function Channel: Press menu button PAGE_DOWN pressMenuButton(DECK_A_B) IMenuComponent MENU_DECK_A_B Momentary Function Channel: Press menu button DECK_A_B pressMenuButton(TV_VCR) IMenuComponent MENU_TV_VCR Momentary Function Channel: Press menu button TV_VCR pressMenuButton(RECORD_SPEED) IMenuComponent MENU_RECORD_SPEED...
Page 164 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(E) IMenuComponent ALPHA-E Press menu button E pressMenuButton(F) IMenuComponent ALPHA-F Press menu button F pressMenuButton(G) IMenuComponent ALPHA-G Press menu button G pressMenuButton(H) IMenuComponent ALPHA-H Press menu button H pressMenuButton(I) IMenuComponent ALPHA-I Press menu button I pressMenuButton(J)
Page 165 Monitor 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>...
Page 166 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes getInputGroupSelect() ISourceSelectComponent ?INPUTGROUPSE- Query for currently selected input group LECT getInputProperties() ISourceSelectComponent ?INPUTPROPERTIES Query for the properties of all inputs getInputProperty(index) ISourceSelectComponent ?INPUTPROPERTY Query for the properties of a specific input getInputSelect() ISourceSelectComponent ?INPUTSELECT...
Page 167 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(sourceSelect,inputNumber) ISourceSelectComponent INPUT-<sourceSe- Set the current input, where <sourceSe- lect>,<inputNumber> lect> is RGB,SVIDEO,COMPOSITE,COM- PONENT,DVI,HDMI,SDI,VGA,AUDIO,AUXI LIARY,CABLE,CAM- ERA,CD,DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINIDISC,PH ONO,SATEL- LITE,TAPE,TUNER,TV,VCR,VIDEO and <inputNumber> is the instance number of the source select processInputCountEvent(count) ISourceSelectComponentListener INPUTCOUNT-<count>...
Page 168 Monitor Functions (Cont.) Name Component Channel Level Command Constant Notes cycleVolumeMute() IVolumeComponent VOL_MUTE Momentary Function Channel: Cycle vol- ume mute when channel is activated cycleVolumePreset() IVolumeComponent VOL_PRESET Momentary Function Channel: Cycle cam- era preset when channel is activated getVolumePreset() IVolumeComponent ?VOLPRESET Query for volume preset, responds with VOLPRESET-<preset>...
Page 169: Motor
Motor IModuleComponent IModuleComponentListener IMotorComponent IMotorComponentListener Name: Motor Interface: IMotor Motor Functions Name Component Channel Level Command Constant Notes 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>...
Page 170 Motor Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 171 Motor State Charts processMotorDirectionEvent State Channel 2 Channel 4 Channel 5 STOP OPEN CLOSE OFF Standard NetLinx API (SNAPI) R 1.8.0...
Page 172 Standard NetLinx API (SNAPI) R 1.8.0...
Page 173: Multi Window
Multi Window IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IMultiWindowComponent IMultiWindowComponentListener IPowerComponent IPowerComponentListener IWindowComponent IWindowComponentListener Name: Multi Window Interface: IMultiWindow Multi Window Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP Momentary Function Channel: Move menu cursor UP moveMenuCursor(DOWN) IMenuComponent MENU_DN Momentary Function Channel: Move menu cursor DOWN moveMenuCursor(LEFT)
Page 174 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5 Momentary Function Channel: Press menu button DIGIT_5 pressMenuButton(DIGIT_6) IMenuComponent DIGIT_6 Momentary Function Channel: Press menu button DIGIT_6 pressMenuButton(DIGIT_7) IMenuComponent DIGIT_7 Momentary Function Channel: Press menu button DIGIT_7 pressMenuButton(DIGIT_8) IMenuComponent DIGIT_8...
Page 175 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(XM) IMenuComponent MENU_XM Momentary Function Channel: Press menu button XM pressMenuButton(FM) IMenuComponent MENU_FM Momentary Function Channel: Press menu button FM pressMenuButton(AM) IMenuComponent MENU_AM Momentary Function Channel: Press menu button AM pressMenuButton(CLEAR) IMenuComponent MENU_CLEAR...
Page 176 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 pressMenuButton(PLUS_1000) IMenuComponent MENU_PLUS_1000 Momentary Function Channel: Press menu button PLUS_1000 pressMenuButton(DISPLAY) IMenuComponent MENU_DISPLAY Momentary Function Channel: Press menu button DISPLAY pressMenuButton(SUBTITLE) IMenuComponent MENU_SUBTITLE...
Page 177 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE Momentary Function Channel: Press menu button ANGLE pressMenuButton(AUDIO) IMenuComponent MENU_AUDIO Momentary Function Channel: Press menu button AUDIO pressMenuButton(PREVIEW_INPUT) IMenuComponent MENU_PREVIEW_INPUT Momentary Function Channel: Press menu button PREVIEW_INPUT pressMenuButton(SEND_INPUT) IMenuComponent MENU_SEND_INPUT...
Page 178 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V) IMenuComponent ALPHA-V Press menu button V pressMenuButton(W) IMenuComponent ALPHA-W Press menu button W pressMenuButton(X) IMenuComponent ALPHA-X Press menu button X pressMenuButton(Y) IMenuComponent ALPHA-Y Press menu button Y...
Page 179 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 180 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes adjustColor(1) IWindowComponent COLOR_UP Momentary Function Channel: Color is incremented when channel is activated adjustColor(-1) IWindowComponent COLOR_DN Momentary Function Channel: Color is decremented when channel is activated adjustContrast(1) IWindowComponent CONTRAST_UP Momentary Function Channel: Contrast is incremented when channel is activated adjustContrast(-1)
Page 181 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes getWindowSize() IWindowComponent ?WINDOW Query for the window size. Response with WINDOW-<x>,<y>,<height>,<width> getZOrder() IWindowComponent ?WINDOWZORDER Get the Z-order. Responds with WIN- DOWZORDER-<value> where <value> is 1 to the maximum z-order of the device, 1 is the top-most z-order (see specific module documentation) pan(UP)
Page 182 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes setPictureMuteOn(state) IWindowComponent PIC_MUTE_ON Discrete Function Channel: Picture Mute is on while channel is active setSharpness(level) IWindowComponent SHARP_LVL Set sharpness level, range is 0-255 setTint(level) IWindowComponent TINT_LVL Set tint level, range is 0-255 setWindow(pos,size) IWindowComponent WINDOW-...
Page 183 Multi Window Functions (Cont.) Name Component Channel Level Command Constant Notes processWindowEvent(Position,Size) IWindowComponentListener WINDOW- Window position and/or size changed. <x>,<y>,<height>,<widt h> processZOrderEvent(int) IWindowComponentListener WINDOWZORDER- Z-order changed where <value> is 1 to the <value> maximum z-order of the device, 1 is the top-most z-order (see specific module doc- umentation) Multi Window State Charts...
Page 184 Standard NetLinx API (SNAPI) R 1.8.0...
Page 185: Pool Spa
Pool Spa IModuleComponent IModuleComponentListener IPoolSpaComponent IPoolSpaComponentListener Name: Pool Spa Interface: IPoolSpa Pool Spa Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 186 Pool Spa Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 187 Pool Spa Functions (Cont.) Name Component Channel Level Command Constant Notes setPoolSpaAuxOn(aux,state) IPoolSpaComponent POOLAUX-<aux num- Set Pool/Spa Aux state where <aux num- ber>,<state> ber> is the number of the aux relay 1 to x where x is the maximum supported aux relay and <state>...
Page 188 Pool Spa Functions (Cont.) Name Component Channel Level Command Constant Notes processPoolHeatStatusEvent(SOLAR) IPoolSpaComponentListener POOL_HEATING_SOLAR Feedback Channel: Pool heater status is solar, see state chart processPoolLightOnEvent(boolean) IPoolSpaComponentListener POOL_LIGHT_FB Feedback Channel: Pool light is on while channel is active processPoolPumpOnEvent(boolean) IPoolSpaComponentListener POOL_PUMP_FB Feedback Channel: Pool pump is on while channel is active processPoolSetpointEvent(int)
Page 189 Pool Spa Functions (Cont.) Name Component Channel Level Command Constant Notes processSpaLightOnEvent(boolean) IPoolSpaComponentListener SPA_LIGHT_FB Feedback Channel: Spa light is on while channel is active processSpaPumpOnEvent(boolean) IPoolSpaComponentListener SPA_PUMP_FB Feedback Channel: Spa pump is on while channel is active processSpaSetpointEvent(int) IPoolSpaComponentListener SPA_HEAT_LVL Spa setpoint changed, value is in degrees C or F depending on temperature scale processSpaTemperatureEvent(float)
Page 190 Pool Spa State Charts processPoolHeatStateEvent State Channel 174 Channel 175 Channel 176 Channel 177 HEATER SOLAR SOLAR_PREFERRED OFF processPoolHeatStatusEvent State Channel 187 Channel 188 HEATER ON SOLAR processSpaHeatStateEvent State Channel 178 Channel 179 Channel 180 Channel 181 HEATER SOLAR SOLAR_PREFERRED OFF processSpaHeatStatusEvent State Channel 189 Channel 190...
Page 191 processSpaJetsEvent State Channel 182 Channel 183 Channel 184 Channel 185 MEDIUM OFF HIGH Standard NetLinx API (SNAPI) R 1.8.0...
Page 192 Standard NetLinx API (SNAPI) R 1.8.0...
Page 193: Power Device
Power Device IModuleComponent IModuleComponentListener IPowerDeviceComponent IPowerDeviceComponentListener Name: Power Device Interface: IPowerDevice Power Device Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 194 Power Device Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 195: Pre Amp Surround Sound Processor
Pre Amp Surround Sound Processor IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IPreAmpComponent IPreAmpComponentListener IPreAmpSurroundSoundProcessorComponent IPreAmpSurroundSoundProcessorComponentListener ISourceSelectComponent ISourceSelectComponentListener IVolumeComponent IVolumeComponentListener Name: Pre Amp Surround Sound Processor Interface: IPreAmpSurroundSoundProcessor Pre Amp Surround Sound Processor Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP...
Page 196 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_3) IMenuComponent DIGIT_3 Momentary Function Channel: Press menu button DIGIT_3 pressMenuButton(DIGIT_4) IMenuComponent DIGIT_4 Momentary Function Channel: Press menu button DIGIT_4 pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5 Momentary Function Channel: Press menu button DIGIT_5 pressMenuButton(DIGIT_6) IMenuComponent...
Page 197 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(FUNCTION) IMenuComponent MENU_FUNCTION Momentary Function Channel: Press menu button FUNCTION pressMenuButton(SETUP) IMenuComponent MENU_SETUP Momentary Function Channel: Press menu button SETUP pressMenuButton(XM) IMenuComponent MENU_XM Momentary Function Channel: Press menu button XM pressMenuButton(FM) IMenuComponent...
Page 198 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIAL) IMenuComponent MENU_DIAL Momentary Function Channel: Press menu button DIAL pressMenuButton(CONFERENCE) IMenuComponent MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 pressMenuButton(PLUS_1000) IMenuComponent...
Page 199 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(TOP_MENU) IMenuComponent MENU_TOP_MENU Momentary Function Channel: Press menu button TOP_MENU pressMenuButton(ZOOM) IMenuComponent MENU_ZOOM Momentary Function Channel: Press menu button ZOOM pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE Momentary Function Channel: Press menu button ANGLE pressMenuButton(AUDIO) IMenuComponent...
Page 200 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R pressMenuButton(S) IMenuComponent ALPHA-S Press menu button S pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V) IMenuComponent ALPHA-V...
Page 201 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATING Feedback Channel: Communication is established with device while channel is on processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received...
Page 202 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes nextSurroundMode() IPreAmpComponent SURROUND_NEXT Momentary Function Channel: Next sur- round mode is selected when channel is activated previousSurroundMode() IPreAmpComponent SURROUND_PREV Momentary Function Channel: Previous surround mode is selected when channel is activated setBalance(balance) IPreAmpComponent...
Page 203 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes setInputGroupSelect(group) ISourceSelectComponent INPUTGROUPSE- Set input group selection LECT-<inputGroup> setInputSelect(index) ISourceSelectComponent INPUTSELECT- Set input selection <index> setInputSource(TV,1) ISourceSelectComponent SOURCE_TV1 Momentary Function Channel: Selects input TV,1 when channel is activated setInputSource(VIDEO,1) ISourceSelectComponent SOURCE_VIDEO1...
Page 204 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes processInputPropertiesEvent(String[]) ISourceSelectComponentListener INPUTPROPERTIES- Response to ?INPUTPROPERTIES- <index>,<input- <index>,<group>,<label>,<signal- Group>,<deviceLa- Type>,<AVType>[;<index>,<group>,<label> bel>,<signalType>,<AV ,<signalType>,<AVType>], where <group> Type>[;<index>,<input- is the integer index based on mutually Group>,<deviceLa- exclusive inputs, <label> is the text on the bel>,<signalType>,<AV device, <signalType>...
Page 205 Pre Amp Surround Sound Processor Functions (Cont.) Name Component Channel Level Command Constant Notes 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 VOL_UP Ramping Channel: Volume is ramped up while channel is active...
Page 206 Standard NetLinx API (SNAPI) R 1.8.0...
Page 207: Receiver
Receiver IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IPreAmpComponent IPreAmpComponentListener IReceiverComponent IReceiverComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener IVolumeComponent IVolumeComponentListener Name: Receiver Interface: IReceiver Receiver Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP Momentary Function Channel: Move menu cursor UP moveMenuCursor(DOWN) IMenuComponent MENU_DN...
Page 208 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_2) IMenuComponent DIGIT_2 Momentary Function Channel: Press menu button DIGIT_2 pressMenuButton(DIGIT_3) IMenuComponent DIGIT_3 Momentary Function Channel: Press menu button DIGIT_3 pressMenuButton(DIGIT_4) IMenuComponent DIGIT_4 Momentary Function Channel: Press menu button DIGIT_4 pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5...
Page 209 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PPV) IMenuComponent MENU_PPV Momentary Function Channel: Press menu button PPV pressMenuButton(FUNCTION) IMenuComponent MENU_FUNCTION Momentary Function Channel: Press menu button FUNCTION pressMenuButton(SETUP) IMenuComponent MENU_SETUP Momentary Function Channel: Press menu button SETUP pressMenuButton(XM) IMenuComponent MENU_XM...
Page 210 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(COMMA) IMenuComponent MENU_COMMA Momentary Function Channel: Press menu button COMMA pressMenuButton(DIAL) IMenuComponent MENU_DIAL Momentary Function Channel: Press menu button DIAL pressMenuButton(CONFERENCE) IMenuComponent MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100...
Page 211 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(TITLE) IMenuComponent MENU_TITLE Momentary Function Channel: Press menu button TITLE pressMenuButton(TOP_MENU) IMenuComponent MENU_TOP_MENU Momentary Function Channel: Press menu button TOP_MENU pressMenuButton(ZOOM) IMenuComponent MENU_ZOOM Momentary Function Channel: Press menu button ZOOM pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE...
Page 212 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(Q) IMenuComponent ALPHA-Q Press menu button Q pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R pressMenuButton(S) IMenuComponent ALPHA-S Press menu button S pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V)
Page 213 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener 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-...
Page 214 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes nextSurroundMode() IPreAmpComponent SURROUND_NEXT Momentary Function Channel: Next sur- round mode is selected when channel is activated previousSurroundMode() IPreAmpComponent SURROUND_PREV Momentary Function Channel: Previous surround mode is selected when channel is activated setBalance(balance) IPreAmpComponent...
Page 215 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes setInputGroupSelect(group) ISourceSelectComponent INPUTGROUPSE- Set input group selection LECT-<inputGroup> setInputSelect(index) ISourceSelectComponent INPUTSELECT- Set input selection <index> setInputSource(TV,1) ISourceSelectComponent SOURCE_TV1 Momentary Function Channel: Selects input TV,1 when channel is activated setInputSource(VIDEO,1) ISourceSelectComponent SOURCE_VIDEO1 Momentary Function Channel: Selects input VIDEO,1 when channel is activated...
Page 216 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes processInputPropertiesEvent(String[]) ISourceSelectComponentListener INPUTPROPERTIES- Response to ?INPUTPROPERTIES- <index>,<input- <index>,<group>,<label>,<signal- Group>,<deviceLa- Type>,<AVType>[;<index>,<group>,<label> bel>,<signalType>,<AV ,<signalType>,<AVType>], where <group> Type>[;<index>,<input- is the integer index based on mutually Group>,<deviceLa- exclusive inputs, <label> is the text on the bel>,<signalType>,<AV device, <signalType>...
Page 217 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes getStation() ITunerStationComponent ?XCH Query for station, responds with XCH-<sta- tion> where <station> is a station string such as "501", "103.7" or "5.1" getStationPreset() ITunerStationComponent ?TUNERPRESET Query for tuner preset, responds with TUNERPRESET-<preset>...
Page 218 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes setBand(tb) ITunerStationComponent BAND-<tb> Set band, where <tb> is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV setStation(station) ITunerStationComponent XCH-<station> Set station, where <station> is a station string such as "501", "103.7" or "5.1" setStationPreset(preset) ITunerStationComponent TUNERPRESET-<pre- Recall tuner preset where <preset>...
Page 219 Receiver Functions (Cont.) Name Component Channel Level Command Constant Notes processTunerComponentCountEvent(count) ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERCOUNT, where COUNT <count> is the integer number of tuner components processTunerComponentPropertiesEv- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTIES ent(String[]) PROPERTIES- <index>,<dis- playName>,<value>[;- <index>,<dis- playName>,<value>] processTunerComponentProper- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTY tyEvent(String[])
Page 220 Receiver State Charts processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 221: Relay Device
Relay Device IModuleComponent IModuleComponentListener IRelayDeviceComponent IRelayDeviceComponentListener Name: Relay Device Interface: IRelayDevice Relay Device Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 222 Relay Device Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 223: Security System
Security System IModuleComponent IModuleComponentListener ISecuritySystemComponent ISecuritySystemComponentListener Name: Security System Interface: ISecuritySystem Security System Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 224 Security System Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 225 Security System Functions (Cont.) Name Component Channel Level Command Constant Notes processPointStateEvent(SecurityPointState) ISecuritySystemComponentListener SECPOINTSTATE- Point State changed, where <point> is 1 to <point>,<state> the maximum point point as returned by getPointCount() (see specific module docu- mentation) and <state> is BYPASS or ACTIVE processPointStatusEvent(SecurityPointSta- ISecuritySystemComponentListener...
Page 226 Standard NetLinx API (SNAPI) R 1.8.0...
Page 227: Sensor Device
Sensor Device IModuleComponent IModuleComponentListener ISensorComponent ISensorComponentListener Name: Sensor Device Interface: ISensorDevice Sensor Device Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 228 Sensor Device Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 229: Settop Box
Settop Box IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISettopBoxComponent ISettopBoxComponentListener ITunerStationComponent ITunerStationComponentListener IVolumeComponent IVolumeComponentListener Name: Settop Box Interface: ISettopBox Settop Box Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP Momentary Function Channel: Move menu cursor UP moveMenuCursor(DOWN) IMenuComponent MENU_DN Momentary Function Channel: Move menu...
Page 230 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_4) IMenuComponent DIGIT_4 Momentary Function Channel: Press menu button DIGIT_4 pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5 Momentary Function Channel: Press menu button DIGIT_5 pressMenuButton(DIGIT_6) IMenuComponent DIGIT_6 Momentary Function Channel: Press menu button DIGIT_6 pressMenuButton(DIGIT_7) IMenuComponent DIGIT_7...
Page 231 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(SETUP) IMenuComponent MENU_SETUP Momentary Function Channel: Press menu button SETUP pressMenuButton(XM) IMenuComponent MENU_XM Momentary Function Channel: Press menu button XM pressMenuButton(FM) IMenuComponent MENU_FM Momentary Function Channel: Press menu button FM pressMenuButton(AM) IMenuComponent MENU_AM...
Page 232 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(CONFERENCE) IMenuComponent MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 pressMenuButton(PLUS_1000) IMenuComponent MENU_PLUS_1000 Momentary Function Channel: Press menu button PLUS_1000 pressMenuButton(DISPLAY) IMenuComponent MENU_DISPLAY...
Page 233 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(ZOOM) IMenuComponent MENU_ZOOM Momentary Function Channel: Press menu button ZOOM pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE Momentary Function Channel: Press menu button ANGLE pressMenuButton(AUDIO) IMenuComponent MENU_AUDIO Momentary Function Channel: Press menu button AUDIO pressMenuButton(PREVIEW_INPUT) IMenuComponent MENU_PREVIEW_INPUT...
Page 234 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V) IMenuComponent ALPHA-V Press menu button V pressMenuButton(W) IMenuComponent ALPHA-W Press menu button W pressMenuButton(X) IMenuComponent ALPHA-X Press menu button X...
Page 235 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 236 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes getStationPreset() ITunerStationComponent ?TUNERPRESET Query for tuner preset, responds with TUNERPRESET-<preset> getStationPresetCount() ITunerStationComponent ?STATIONPRESET- Query for number of station presets COUNT getStationPresetProperties() ITunerStationComponent ?STATIONPRESET- Query for properties of all station presets PROPERTIES getStationPresetProperty(index) ITunerStationComponent...
Page 237 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes setStation(station) ITunerStationComponent XCH-<station> Set station, where <station> is a station string such as "501", "103.7" or "5.1" setStationPreset(preset) ITunerStationComponent TUNERPRESET-<pre- Recall tuner preset where <preset> is 1-x set> and x is the maximum supported preset (see specific module documentation) processBandEvent(TunerBand) ITunerStationComponentListener...
Page 238 Settop Box Functions (Cont.) Name Component Channel Level Command Constant Notes processTunerComponentPropertiesEv- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTIES ent(String[]) PROPERTIES- <index>,<dis- playName>,<value>[;- <index>,<dis- playName>,<value>] processTunerComponentProper- ITunerStationComponentListener TUNERCOMPONENT- Response to ?TUNERPROPERTY tyEvent(String[]) PROPERTY- <index>,<dis- playName>,<value> cycleVolumeMute() IVolumeComponent VOL_MUTE Momentary Function Channel: Cycle vol- ume mute when channel is activated cycleVolumePreset() IVolumeComponent...
Page 239 Settop Box State Charts processPowerEvent State Channel 255 Standard NetLinx API (SNAPI) R 1.8.0...
Page 240 Standard NetLinx API (SNAPI) R 1.8.0...
Page 241: Slide Projector
Slide Projector ILampComponent ILampComponentListener IModuleComponent IModuleComponentListener ISlideProjectorComponent ISlideProjectorComponentListener Name: Slide Projector Interface: ISlideProjector Slide Projector Functions Name Component Channel Level Command Constant Notes cycleLampPower() ILampComponent POWER Momentary Function Channel: Cycle lamp power when channel is activated getCoolDownTime() ILampComponent ?COOLDOWN Query for cool down time, responds with COOLDOWN-<time>...
Page 242 Slide Projector Functions (Cont.) Name Component Channel Level Command Constant Notes processLampTimeEvent(int) ILampComponentListener LAMPTIME-<time> Lamp time, <time> is elapsed hours processWarmUpCounterEvent(int) ILampComponentListener WARMING-<time> Warm up counter time, <time> is seconds remaining getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state>...
Page 243 Slide Projector Functions (Cont.) Name Component Channel Level Command Constant Notes getSlide() ISlideProjectorComponent ?SLIDE Query for Slide, responds with SLIDE- <slide> where <slide> is 1 to x where x is the maximum support slide (see specific module documentation) nextSlide() ISlideProjectorComponent SLIDE_NEXT Momentary Function Channel: Slide is advanced to the next slide when channel is...
Page 244 Standard NetLinx API (SNAPI) R 1.8.0...
Page 245: Switcher
Switcher IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener ISwitcherComponent ISwitcherComponentListener IVolumeComponent IVolumeComponentListener Name: Switcher Interface: ISwitcher Switcher Functions Name Component Channel Level Command Constant Notes cycleGainMute() IGainComponent GAIN_MUTE Momentary Function Channel: Cycle gain mute when channel is activated setGain(level) IGainComponent GAIN_LVL Set gain, range is 0-255 setGainMuteOn(state) IGainComponent GAIN_MUTE_ON...
Page 246 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>...
Page 247 Switcher Functions (Cont.) Name Component Channel Level Command Constant Notes switchInputToOutput(AUDIO,input,output[]) ISwitcherComponent AI<input>O<output,out- Switch <input> to one or more <output>s put,Ö> for switcher level Audio. Use <input> 0 for disconnect. switchInputToOutput(ALL,input,output[]) ISwitcherComponent CI<input>O<out- Switch <input> to one or more <output>s put,outputÖ>...
Page 248 Switcher Functions (Cont.) Name Component Channel Level Command Constant Notes processVolumeRampEvent(UP) IVolumeComponentListener VOL_UP_FB Feedback Channel: Volume is ramping up while channel is on processVolumeRampEvent(DOWN) IVolumeComponentListener VOL_DN_FB Feedback Channel: Volume is ramping down while channel is on Standard NetLinx API (SNAPI) R 1.8.0...
Page 249: Text Keypad
Text Keypad IKeypadComponent IKeypadComponentListener IModuleComponent IModuleComponentListener ITextKeypadComponent ITextKeypadComponentListener Name: Text Keypad Interface: ITextKeypad Text Keypad Functions Name Component Channel Level Command Constant Notes addKeypadComponent(index,keypadAd- IKeypadComponent KEYPADADD- Add a keypad address at a given index, dress) <index>,<keypadaddr> where <index> is 1-x and <keypadaddr> is a keypad address and x is the maximum supported keypad index (see specific mod- ule documentation)
Page 250 Text Keypad Functions (Cont.) Name Component Channel Level Command Constant Notes processButtonStateEvent(RELEASE) IKeypadComponentListener <btn> Input Function Channel: Button state is Pushed when BUTTON_EVENT-PUSH is received, where <btn> is the button/chan- nel number processButtonStateEvent(ButtonState) IKeypadComponentListener KEYPADBTN- Button State changed. <btn> is button <btn>,<state>...
Page 251 Text Keypad Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATING Feedback Channel: Communication is established with device while channel is on processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received...
Page 252 Standard NetLinx API (SNAPI) R 1.8.0...
Page 253 IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener ITVComponent ITVComponentListener IVolumeComponent IVolumeComponentListener Name: TV Interface: ITV TV Functions Name Component Channel Level Command Constant Notes adjustBrightness(1) IDisplayComponent BRIGHT_UP Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(-1) IDisplayComponent BRIGHT_DN...
Page 254 TV Functions (Cont.) Name Component Channel Level Command Constant Notes cycleAspectRatio() IDisplayComponent ASPECT_RATIO Momentary Function Channel: Cycle aspect ratios when channel is activated cycleFreeze() IDisplayComponent PIC_FREEZE Momentary Function Channel: Cycle freeze when channel is activated cyclePictureMute() IDisplayComponent PIC_MUTE Momentary Function Channel: Cycle pic- ture mute when channel is activated cyclePIP() IDisplayComponent...
Page 255 TV Functions (Cont.) Name Component Channel Level Command Constant Notes setPIPOn(state) IDisplayComponent PIP_ON Discrete Function Channel: PIP is on while channel is active setSharpness(level) IDisplayComponent SHARP_LVL Set sharpness level, range is 0-255 setTint(level) IDisplayComponent TINT_LVL Set tint level, range is 0-255 setVideoType(vt) IDisplayComponent VIDEOTYPE-<vt>...
Page 256 TV Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(DOWN) IMenuComponent MENU_DN Momentary Function Channel: Move menu cursor DOWN moveMenuCursor(LEFT) IMenuComponent MENU_LT Momentary Function Channel: Move menu cursor LEFT moveMenuCursor(RIGHT) IMenuComponent MENU_RT Momentary Function Channel: Move menu cursor RIGHT moveMenuCursor(UP_LEFT) IMenuComponent MENU_UP_LT...
Page 257 TV Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(MENU) IMenuComponent MENU_FUNC Momentary Function Channel: Press menu button MENU pressMenuButton(EXIT) IMenuComponent MENU_EXIT Momentary Function Channel: Press menu button EXIT pressMenuButton(VIDEO) IMenuComponent MENU_VIDEO Momentary Function Channel: Press menu button VIDEO pressMenuButton(THUMBS_DOWN) IMenuComponent MENU_THUMBS_DN...
Page 258 TV Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(HOLD) IMenuComponent MENU_HOLD Momentary Function Channel: Press menu button HOLD pressMenuButton(LIST) IMenuComponent MENU_LIST Momentary Function Channel: Press menu button LIST pressMenuButton(LEFT_PAREN) IMenuComponent MENU_LT_PAREN Momentary Function Channel: Press menu button LEFT_PAREN pressMenuButton(RIGHT_PAREN) IMenuComponent MENU_RT_PAREN...
Page 259 TV Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(GUIDE) IMenuComponent MENU_GUIDE Momentary Function Channel: Press menu button GUIDE pressMenuButton(PAGE_UP) IMenuComponent MENU_PAGE_UP Momentary Function Channel: Press menu button PAGE_UP pressMenuButton(PAGE_DOWN) IMenuComponent MENU_PAGE_DN Momentary Function Channel: Press menu button PAGE_DOWN pressMenuButton(DECK_A_B) IMenuComponent MENU_DECK_A_B...
Page 260 TV Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(B) IMenuComponent ALPHA-B Press menu button B pressMenuButton(C) IMenuComponent ALPHA-C Press menu button C pressMenuButton(D) IMenuComponent ALPHA-D Press menu button D pressMenuButton(E) IMenuComponent ALPHA-E Press menu button E pressMenuButton(F) IMenuComponent ALPHA-F Press menu button F pressMenuButton(G)
Page 261 TV Functions (Cont.) Name Component Channel Level Command Constant Notes loadProperties(fileName) IModuleComponent LOADPROPERTY- Load properties from the file with the sup- <file> plied filename. Used to load meta-data properties for modules including Generic IR modules. passThru(buffer) IModuleComponent PASSTHRU-<buffer> Send a message directly to the device reinitialize() IModuleComponent REINIT...
Page 262 TV Functions (Cont.) Name Component Channel Level Command Constant Notes cycleInputSource() ISourceSelectComponent SOURCE_CYCLE Momentary Function Channel: Cycle input source when channel is activated getInputCount() ISourceSelectComponent ?INPUTCOUNT Query for the number of inputs getInputGroupSelect() ISourceSelectComponent ?INPUTGROUPSE- Query for currently selected input group LECT getInputProperties() ISourceSelectComponent...
Page 263 TV Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(AUXILIARY,1) ISourceSelectComponent SOURCE_AUX1 Momentary Function Channel: Selects input AUXILIARY,1 when channel is acti- vated setInputSource(sourceSelect,inputNumber) ISourceSelectComponent INPUT-<sourceSe- Set the current input, where <sourceSe- lect>,<inputNumber> lect> is RGB,SVIDEO,COMPOSITE,COM- PONENT,DVI,HDMI,SDI,VGA,AUDIO,AUXI LIARY,CABLE,CAM- ERA,CD,DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINIDISC,PH ONO,SATEL- LITE,TAPE,TUNER,TV,VCR,VIDEO and...
Page 264 TV Functions (Cont.) Name Component Channel Level Command Constant Notes processInputSourceEvent(InputSourceSe- ISourceSelectComponentListener INPUT-<sourceSe- Current input has changed, where <source- lectInfo) lect>,<inputNumber> Select> is RGB,SVIDEO,COMPOS- ITE,COMPONENT,DVI,HDMI,SDI,VGA,AU DIO,AUXILIARY,CABLE,CAMERA,CD, COMPUTER, DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINI- DISC,PHONO,SATELLITE,TAPE,TUNER,T V,VCR,VIDEO and <inputNumber> is the instance number of the source select cycleBand() ITunerStationComponent TUNER_BAND...
Page 265 TV Functions (Cont.) Name Component Channel Level Command Constant Notes getTunerComponentProperty(index) ITunerStationComponent ?TUNERCOMPO- Query for properties of specific tuner com- NENTPROPERTY- ponent <index> gotoPreviousStation() ITunerStationComponent TUNER_PREV Momentary Function Channel: Previous station is selected when channel is acti- vated incrementStation() ITunerStationComponent CHAN_UP Momentary Function Channel: Station is incremented when channel is activated...
Page 266 TV Functions (Cont.) Name Component Channel Level Command Constant Notes processStationPresetPropertiesEv- ITunerStationComponentListener STATIONPRESET- Response to ?STATIONPRESETPROPER- ent(String[]) PROPERTIES- TIES <index>,<dis- playName>,<value>[;<i ndex>,<dis- playName>,<value>] processStationPresetPropertyEvent(String[]) ITunerStationComponentListener STATIONPRESET- Response to ?STATIONPRESETPROP- PROPERTY- ERTY <index>,<dis- playName>,<value> processTunerBandCountEvent(count) ITunerStationComponentListener TUNERBANDCOUNT- Response to ?TUNERBANDCOUNT, <count> where <count>...
Page 267 TV Functions (Cont.) Name Component Channel Level Command Constant Notes setVolumeMuteOn(state) IVolumeComponent 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...
Page 268 Standard NetLinx API (SNAPI) R 1.8.0...
Page 269: Utility
Utility IModuleComponent IModuleComponentListener IUtilityComponent IUtilityComponentListener Name: Utility Interface: IUtility Utility Functions Name Component Channel Level Command Constant Notes 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>...
Page 270 Utility Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 271: Vcr
IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITapeTransportComponent ITapeTransportComponentListener ITunerStationComponent ITunerStationComponentListener IVCRComponent IVCRComponentListener Name: VCR Interface: IVCR VCR Functions Name Component Channel Level Command Constant Notes moveMenuCursor(UP) IMenuComponent MENU_UP Momentary Function Channel: Move menu cursor UP moveMenuCursor(DOWN) IMenuComponent MENU_DN Momentary Function Channel: Move menu cursor DOWN moveMenuCursor(LEFT)
Page 272 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIGIT_3) IMenuComponent DIGIT_3 Momentary Function Channel: Press menu button DIGIT_3 pressMenuButton(DIGIT_4) IMenuComponent DIGIT_4 Momentary Function Channel: Press menu button DIGIT_4 pressMenuButton(DIGIT_5) IMenuComponent DIGIT_5 Momentary Function Channel: Press menu button DIGIT_5 pressMenuButton(DIGIT_6) IMenuComponent DIGIT_6...
Page 273 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(FUNCTION) IMenuComponent MENU_FUNCTION Momentary Function Channel: Press menu button FUNCTION pressMenuButton(SETUP) IMenuComponent MENU_SETUP Momentary Function Channel: Press menu button SETUP pressMenuButton(XM) IMenuComponent MENU_XM Momentary Function Channel: Press menu button XM pressMenuButton(FM) IMenuComponent MENU_FM...
Page 274 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DIAL) IMenuComponent MENU_DIAL Momentary Function Channel: Press menu button DIAL pressMenuButton(CONFERENCE) IMenuComponent MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE pressMenuButton(PLUS_100) IMenuComponent MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 pressMenuButton(PLUS_1000) IMenuComponent MENU_PLUS_1000...
Page 275 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(TOP_MENU) IMenuComponent MENU_TOP_MENU Momentary Function Channel: Press menu button TOP_MENU pressMenuButton(ZOOM) IMenuComponent MENU_ZOOM Momentary Function Channel: Press menu button ZOOM pressMenuButton(ANGLE) IMenuComponent MENU_ANGLE Momentary Function Channel: Press menu button ANGLE pressMenuButton(AUDIO) IMenuComponent MENU_AUDIO...
Page 276 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R pressMenuButton(S) IMenuComponent ALPHA-S Press menu button S pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U pressMenuButton(V) IMenuComponent ALPHA-V Press menu button V pressMenuButton(W)
Page 277 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener 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-...
Page 278 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes setInputGroupSelect(group) ISourceSelectComponent INPUTGROUPSE- Set input group selection LECT-<inputGroup> setInputSelect(index) ISourceSelectComponent INPUTSELECT- Set input selection <index> setInputSource(TV,1) ISourceSelectComponent SOURCE_TV1 Momentary Function Channel: Selects input TV,1 when channel is activated setInputSource(VIDEO,1) ISourceSelectComponent SOURCE_VIDEO1 Momentary Function Channel: Selects input VIDEO,1 when channel is activated...
Page 279 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes processInputPropertiesEvent(String[]) ISourceSelectComponentListener INPUTPROPERTIES- Response to ?INPUTPROPERTIES- <index>,<input- <index>,<group>,<label>,<signal- Group>,<deviceLa- Type>,<AVType>[;<index>,<group>,<label> bel>,<signalType>,<AV ,<signalType>,<AVType>], where <group> Type>[;<index>,<input- is the integer index based on mutually Group>,<deviceLa- exclusive inputs, <label> is the text on the bel>,<signalType>,<AV device, <signalType>...
Page 280 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes setTapeTransport(FF) ITapeTransportComponent FFWD Momentary Function Channel: Deck is set to fast-forward when the channel is acti- vated setTapeTransport(REW) ITapeTransportComponent Momentary Function Channel: Deck is set to rewind when the channel is activated setTapeTransport(SEARCH_FWD) ITapeTransportComponent SFWD...
Page 281 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes processTapeTransportEvent(SLOW_REV) ITapeTransportComponentListener SLOW_REV_FB Feedback Channel: Transport state change (see chart below) cycleBand() ITunerStationComponent TUNER_BAND Momentary Function Channel: Cycle tuner band when channel is activated cycleDisplayInfo() ITunerStationComponent TUNER_OSD Momentary Function Channel: Cycle on- screen or front-panel display info when channel is activated cycleStationPresetGroup()
Page 282 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes incrementStation() ITunerStationComponent CHAN_UP Momentary Function Channel: Station is incremented when channel is activated nextStationPreset() ITunerStationComponent TUNER_STATION_UP Momentary Function Channel: Next station preset is selected when channel is acti- vated previousStationPreset() ITunerStationComponent TUNER_STATION_DN Momentary Function Channel: Previous...
Page 283 VCR Functions (Cont.) Name Component Channel Level Command Constant Notes processStationPresetPropertyEvent(String[]) ITunerStationComponentListener STATIONPRESET- Response to ?STATIONPRESETPROP- PROPERTY- ERTY <index>,<dis- playName>,<value> processTunerBandCountEvent(count) ITunerStationComponentListener TUNERBANDCOUNT- Response to ?TUNERBANDCOUNT, <count> where <count> is the integer number of tuner bands processTunerBandPropertiesEvent(String[]) ITunerStationComponentListener TUNERBANDPROP- Response to ?TUNERBANDPROPERTIES ERTIES-<index>,<dis- playName>,<tunerBan d>[;<index>,<dis-...
Page 284 VCR State Charts processPowerEvent State Channel 255 processTapeTransportEvent State Channel 241 Channel 242 Channel 243 Channel 244 Channel 245 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SEARCH_FWD SEARCH_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV Standard NetLinx API (SNAPI) R 1.8.0...
Page 285: Video Conferencer
Video Conferencer ICameraComponent ICameraComponentListener IDialerComponent IDialerComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPhonebookComponent IPhonebookComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoConferencerComponent IVideoConferencerComponentListener IVolumeComponent IVolumeComponentListener Name: Video Conferencer Interface: IVideoConferencer Video Conferencer Functions Name Component Channel Level Command Constant Notes cycleAutoFocus() ICameraComponent AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() ICameraComponent...
Page 286 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes setAutoFocusOn(state) ICameraComponent AUTO_FOCUS_ON Discrete Function Channel: Auto focus is on while channel is active setAutoIrisOn(state) ICameraComponent AUTO_IRIS_ON Discrete Function Channel: Auto iris is on while channel is active setCameraPreset(preset) ICameraComponent CAMERAPRESET- Recall camera preset where <preset>...
Page 287 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes processAutoFocusEvent(boolean) ICameraComponentListener AUTO_FOCUS_FB Feedback Channel: Auto focus is on if channel is active processAutoIrisEvent(boolean) ICameraComponentListener AUTO_IRIS_FB Feedback Channel: Auto iris is on if chan- nel is active processCameraComponent- ICameraComponentListener CAMERACOMPO- Response to ?CAMERACOMPONENT- CountEvent(count)
Page 288 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes processPanSpeedEvent(int) ICameraComponentListener PAN_SPEED_LVL Pan speed changed, range is 0-255 (0=slow) processTiltEvent(int) ICameraComponentListener TILT_LVL Tilt changed, range is 0-255 (0=down) processTiltRampEvent(UP) ICameraComponentListener TILT_UP_FB Feedback Channel: Tilt is ramping up while channel is on processTiltRampEvent(DOWN) ICameraComponentListener...
Page 289 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes setAudibleRingOn(state) IDialerComponent DIAL_AUDIBLE_RING_ON Discrete Function Channel: Audible ring is on while channel is active setAutoAnswerOn(state) IDialerComponent DIAL_AUTO_ANSWER_ON Discrete Function Channel: Auto answer is on while channel is active setOffHook(state) IDialerComponent DIAL_OFF_HOOK_ON Discrete Function Channel: Hook state is...
Page 290 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(DOWN_LEFT) IMenuComponent MENU_DN_LT Momentary Function Channel: Move menu cursor DOWN_LEFT moveMenuCursor(DOWN_RIGHT) IMenuComponent MENU_DN_RT Momentary Function Channel: Move menu cursor DOWN_RIGHT pressMenuButton(DIGIT_0) IMenuComponent DIGIT_0 Momentary Function Channel: Press menu button DIGIT_0 pressMenuButton(DIGIT_1) IMenuComponent DIGIT_1...
Page 291 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(ACCEPT) IMenuComponent MENU_ACCEPT Momentary Function Channel: Press menu button ACCEPT to answer an incoming call pressMenuButton(REJECT) IMenuComponent MENU_REJECT Momentary Function Channel: Press menu button REJECT to reject an incoming call pressMenuButton(LIVE_TV) IMenuComponent MENU_LIVE_TV...
Page 292 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DASH) IMenuComponent MENU_DASH Momentary Function Channel: Press menu button DASH pressMenuButton(ASTERISK) IMenuComponent MENU_ASTERISK Momentary Function Channel: Press menu button ASTERISK pressMenuButton(DOT) IMenuComponent MENU_DOT Momentary Function Channel: Press menu button DOT pressMenuButton(POUND) IMenuComponent MENU_POUND...
Page 293 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(RECORD_SPEED) IMenuComponent MENU_RECORD_SPEED Momentary Function Channel: Press menu button RECORD_SPEED pressMenuButton(PROGRAM) IMenuComponent MENU_PROGRAM Momentary Function Channel: Press menu button PROGRAM pressMenuButton(AB_REPEAT) IMenuComponent MENU_AB_REPEAT Momentary Function Channel: Press menu button AB_REPEAT pressMenuButton(HELP) IMenuComponent MENU_HELP...
Page 294 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(J) IMenuComponent ALPHA-J Press menu button J pressMenuButton(K) IMenuComponent ALPHA-K Press menu button K pressMenuButton(L) IMenuComponent ALPHA-L Press menu button L pressMenuButton(M) IMenuComponent ALPHA-M Press menu button M pressMenuButton(N) IMenuComponent ALPHA-N Press menu button N...
Page 295 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes 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...
Page 296 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes queryDB(si) IPhonebookComponent PHONEBOOKPREV- Request previous <count> records for the <key>[,<count>] phonebook search associated with search key <key>. If <count> is not present, it is assumed to be 1. Responses with PHONEBOOKPREV-<key>,<count>,<posi- tion>...
Page 297 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes processQueryDBEvent(PhonebookRecord) IPhonebookComponentListener PHONE- Phonebook record for search with search BOOKRECORD- key <key>. <id> is the record ID, <#> is the <key>,<id>,<#>,<name record position from 1 to the total number >,<number>...
Page 298 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes getInputSource() ISourceSelectComponent ?INPUT Query current input, responds with INPUT- <sourceSelect>,<inputNumber> where <sourceSelect> is RGB,SVIDEO,COM- POSITE,COMPO- NENT,DVI,HDMI,SDI,VGA,AUDIO,AUXILIA RY,CABLE,CAM- ERA,CD,DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINIDISC,PH ONO,SATEL- LITE,TAPE,TUNER,TV,VCR,VIDEO and <inputNumber> is the instance number of the source select setInputGroupSelect(group) ISourceSelectComponent INPUTGROUPSE-...
Page 299 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(sourceSelect,inputNumber) ISourceSelectComponent INPUT-<sourceSe- Set the current input, where <sourceSe- lect>,<inputNumber> lect> is RGB,SVIDEO,COMPOSITE,COM- PONENT,DVI,HDMI,SDI,VGA,AUDIO,AUXI LIARY,CABLE,CAM- ERA,CD,DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINIDISC,PH ONO,SATEL- LITE,TAPE,TUNER,TV,VCR,VIDEO and <inputNumber> is the instance number of the source select processInputCountEvent(count) ISourceSelectComponentListener INPUTCOUNT-<count>...
Page 300 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes cyclePIP() IVideoConferencerComponent Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() IVideoConferencerComponent PIP_POS Momentary Function Channel: Cycle PIP positions when channel is activated cyclePrivacy() IVideoConferencerComponent VCONF_PRIVACY Momentary Function Channel: Cycle pri- vacy when channel is activated setPIPOn(state) IVideoConferencerComponent...
Page 301 Video Conferencer Functions (Cont.) Name Component Channel Level Command Constant Notes processVolumePresetEvent(int) IVolumeComponentListener VOLPRESET-<preset> Volume preset changed, where <preset> is 1-x and x is the maximum supported preset (see specific module documentation) processVolumeRampEvent(UP) IVolumeComponentListener VOL_UP_FB Feedback Channel: Volume is ramping up while channel is on processVolumeRampEvent(DOWN) IVolumeComponentListener...
Page 302 Standard NetLinx API (SNAPI) R 1.8.0...
Page 303: Video Processor
Video Processor IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoProcessorComponent IVideoProcessorComponentListener Name: Video Processor Interface: IVideoProcessor Video Processor Functions Name Component Channel Level Command Constant Notes adjustBrightness(1) IDisplayComponent BRIGHT_UP Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(-1) IDisplayComponent BRIGHT_DN...
Page 304 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes cyclePictureMute() IDisplayComponent PIC_MUTE Momentary Function Channel: Cycle pic- ture mute when channel is activated cyclePIP() IDisplayComponent Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() IDisplayComponent PIP_POS Momentary Function Channel: Cycle PIP positions when channel is activated getActiveWindow() IDisplayComponent...
Page 305 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes setVideoType(vt) IDisplayComponent VIDEOTYPE-<vt> Set video type, where <vt> is AUTO,NTSC,PAL,SECAM swapPIP() IDisplayComponent PIP_SWAP Momentary Function Channel: Swap PIP when channel is activated processActiveWindowEvent(MultiScreenSe- IDisplayComponentListener ACTIVEWINDOW- Active window changed, where <window> lect) <window>...
Page 306 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(RIGHT) IMenuComponent MENU_RT Momentary Function Channel: Move menu cursor RIGHT moveMenuCursor(UP_LEFT) IMenuComponent MENU_UP_LT Momentary Function Channel: Move menu cursor UP_LEFT moveMenuCursor(UP_RIGHT) IMenuComponent MENU_UP_RT Momentary Function Channel: Move menu cursor UP_RIGHT moveMenuCursor(DOWN_LEFT) IMenuComponent MENU_DN_LT...
Page 307 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(VIDEO) IMenuComponent MENU_VIDEO Momentary Function Channel: Press menu button VIDEO pressMenuButton(THUMBS_DOWN) IMenuComponent MENU_THUMBS_DN Momentary Function Channel: Press menu button THUMBS_DOWN pressMenuButton(THUMBS_UP) IMenuComponent MENU_THUMBS_UP Momentary Function Channel: Press menu button THUMBS_UP pressMenuButton(ACCEPT) IMenuComponent MENU_ACCEPT...
Page 308 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(LEFT_PAREN) IMenuComponent MENU_LT_PAREN Momentary Function Channel: Press menu button LEFT_PAREN pressMenuButton(RIGHT_PAREN) IMenuComponent MENU_RT_PAREN Momentary Function Channel: Press menu button RIGHT_PAREN pressMenuButton(UNDER_SCORE) IMenuComponent MENU_UNDERSCORE Momentary Function Channel: Press menu button UNDER_SCORE pressMenuButton(DASH) IMenuComponent MENU_DASH...
Page 309 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(PAGE_DOWN) IMenuComponent MENU_PAGE_DN Momentary Function Channel: Press menu button PAGE_DOWN pressMenuButton(DECK_A_B) IMenuComponent MENU_DECK_A_B Momentary Function Channel: Press menu button DECK_A_B pressMenuButton(TV_VCR) IMenuComponent MENU_TV_VCR Momentary Function Channel: Press menu button TV_VCR pressMenuButton(RECORD_SPEED) IMenuComponent MENU_RECORD_SPEED...
Page 310 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(E) IMenuComponent ALPHA-E Press menu button E pressMenuButton(F) IMenuComponent ALPHA-F Press menu button F pressMenuButton(G) IMenuComponent ALPHA-G Press menu button G pressMenuButton(H) IMenuComponent ALPHA-H Press menu button H pressMenuButton(I) IMenuComponent ALPHA-I Press menu button I...
Page 311 Video Processor 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...
Page 312 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes getInputGroupSelect() ISourceSelectComponent ?INPUTGROUPSE- Query for currently selected input group LECT getInputProperties() ISourceSelectComponent ?INPUTPROPERTIES Query for the properties of all inputs getInputProperty(index) ISourceSelectComponent ?INPUTPROPERTY Query for the properties of a specific input getInputSelect() ISourceSelectComponent ?INPUTSELECT...
Page 313 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(sourceSelect,inputNumber) ISourceSelectComponent INPUT-<sourceSe- Set the current input, where <sourceSe- lect>,<inputNumber> lect> is RGB,SVIDEO,COMPOSITE,COM- PONENT,DVI,HDMI,SDI,VGA,AUDIO,AUXI LIARY,CABLE,CAM- ERA,CD,DVD,FRONT,HDTV,LASER- DISC,LINE,MEDIAPLAYER,MINIDISC,PH ONO,SATEL- LITE,TAPE,TUNER,TV,VCR,VIDEO and <inputNumber> is the instance number of the source select processInputCountEvent(count) ISourceSelectComponentListener INPUTCOUNT-<count>...
Page 314 Video Processor Functions (Cont.) Name Component Channel Level Command Constant Notes cycleVideoProcessorPreset() IVideoProcessorComponent VPROC_PRESET Momentary Function Channel: Cycle video processor preset when channel is activated getVideoProcessorPreset() IVideoProcessorComponent ?VPROCPRESET Query for video processor preset, responds with VPROCPRESET-<preset> saveVideoProcessorPreset(nPresetNum) IVideoProcessorComponent VPROCPRESET- Save video processor Preset where <pre- SAVE-<preset>...
Page 315: Video Projector
Video Projector IDisplayComponent IDisplayComponentListener ILampComponent ILampComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoProjectorComponent IVideoProjectorComponentListener IVolumeComponent IVolumeComponentListener Name: Video Projector Interface: IVideoProjector Video Projector Functions Name Component Channel Level Command Constant Notes adjustBrightness(1) IDisplayComponent BRIGHT_UP Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(-1) IDisplayComponent BRIGHT_DN...
Page 316 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes cycleFreeze() IDisplayComponent PIC_FREEZE Momentary Function Channel: Cycle freeze when channel is activated cyclePictureMute() IDisplayComponent PIC_MUTE Momentary Function Channel: Cycle pic- ture mute when channel is activated cyclePIP() IDisplayComponent Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() IDisplayComponent...
Page 317 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes setTint(level) IDisplayComponent TINT_LVL Set tint level, range is 0-255 setVideoType(vt) IDisplayComponent VIDEOTYPE-<vt> Set video type, where <vt> is AUTO,NTSC,PAL,SECAM swapPIP() IDisplayComponent PIP_SWAP Momentary Function Channel: Swap PIP when channel is activated processActiveWindowEvent(MultiScreenSe- IDisplayComponentListener ACTIVEWINDOW-...
Page 318 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes getLampTime() ILampComponent ?LAMPTIME Query for lamp time, responds with LAMP- TIME-<time> where <time> is in hours getWarmUpTime() ILampComponent ?WARMUP Query for warm up time, responds with WARMUP-<time> where <time> is in sec- onds setCoolDownTime(secs) ILampComponent...
Page 319 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes moveMenuCursor(DOWN_LEFT) IMenuComponent MENU_DN_LT Momentary Function Channel: Move menu cursor DOWN_LEFT moveMenuCursor(DOWN_RIGHT) IMenuComponent MENU_DN_RT Momentary Function Channel: Move menu cursor DOWN_RIGHT pressMenuButton(DIGIT_0) IMenuComponent DIGIT_0 Momentary Function Channel: Press menu button DIGIT_0 pressMenuButton(DIGIT_1) IMenuComponent DIGIT_1...
Page 320 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(ACCEPT) IMenuComponent MENU_ACCEPT Momentary Function Channel: Press menu button ACCEPT to answer an incoming call pressMenuButton(REJECT) IMenuComponent MENU_REJECT Momentary Function Channel: Press menu button REJECT to reject an incoming call pressMenuButton(LIVE_TV) IMenuComponent MENU_LIVE_TV...
Page 321 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(DASH) IMenuComponent MENU_DASH Momentary Function Channel: Press menu button DASH pressMenuButton(ASTERISK) IMenuComponent MENU_ASTERISK Momentary Function Channel: Press menu button ASTERISK pressMenuButton(DOT) IMenuComponent MENU_DOT Momentary Function Channel: Press menu button DOT pressMenuButton(POUND) IMenuComponent MENU_POUND...
Page 322 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(RECORD_SPEED) IMenuComponent MENU_RECORD_SPEED Momentary Function Channel: Press menu button RECORD_SPEED pressMenuButton(PROGRAM) IMenuComponent MENU_PROGRAM Momentary Function Channel: Press menu button PROGRAM pressMenuButton(AB_REPEAT) IMenuComponent MENU_AB_REPEAT Momentary Function Channel: Press menu button AB_REPEAT pressMenuButton(HELP) IMenuComponent MENU_HELP...
Page 323 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes pressMenuButton(J) IMenuComponent ALPHA-J Press menu button J pressMenuButton(K) IMenuComponent ALPHA-K Press menu button K pressMenuButton(L) IMenuComponent ALPHA-L Press menu button L pressMenuButton(M) IMenuComponent ALPHA-M Press menu button M pressMenuButton(N) IMenuComponent ALPHA-N Press menu button N...
Page 324 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes 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...
Page 325 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes setInputSource(VIDEO,1) ISourceSelectComponent SOURCE_VIDEO1 Momentary Function Channel: Selects input VIDEO,1 when channel is activated setInputSource(VIDEO,2) ISourceSelectComponent SOURCE_VIDEO2 Momentary Function Channel: Selects input VIDEO,2 when channel is activated setInputSource(VIDEO,3) ISourceSelectComponent SOURCE_VIDEO3 Momentary Function Channel: Selects input VIDEO,3 when channel is activated setInputSource(TAPE,1)
Page 326 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes processInputPropertyEvent(String[]) ISourceSelectComponentListener INPUTPROPERTY- Response to ?INPUTPROPERTY- <index>,<input- <index>,<group>,<label>,<signal- Group>,<deviceLa- Type>,<AVType>, where <group> is the bel>,<signalType>,<AV integer index based on mutually exclusive Type> inputs, <label> is the text on the device, <signalType>...
Page 327 Video Projector Functions (Cont.) Name Component Channel Level Command Constant Notes setVolumeRamp(UP) IVolumeComponent VOL_UP Ramping Channel: Volume is ramped up while channel is active setVolumeRamp(DOWN) IVolumeComponent VOL_DN Ramping Channel: Volume is ramped down while channel is active processVolumeEvent(int) IVolumeComponentListener VOL_LVL Volume changed, range is 0-255 processVolumeMuteEvent(boolean) IVolumeComponentListener...
Page 328 Standard NetLinx API (SNAPI) R 1.8.0...
Page 329: Video Wall
Video Wall IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVideoWallComponent IVideoWallComponentListener IWindowComponent IWindowComponentListener Name: Video Wall Interface: IVideoWall Video Wall Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent...
Page 330 Video Wall Functions (Cont.) Name Component Channel Level Command Constant Notes processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO processDeviceOnLineEvent(boolean) IModuleComponentListener DEVICE_COMMUNICATING Feedback Channel: Communication is established with device while channel is on processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received...
Page 331 Video Wall Functions (Cont.) Name Component Channel Level Command Constant Notes addWindowComponent(index,windowAd- IWindowComponent WINDOWADD- Add a window at a given index, where dress) <index>,<address> <index> is 1 through x and <address> is a window address and x is the maximum supported window index (see specific mod- ule documentation) adjustBrightness(1)
Page 332 Video Wall Functions (Cont.) Name Component Channel Level Command Constant Notes getWindowComponentAddress(index) IWindowComponent ?WINDOWADDR- Query for the address of the window at <index> index <index>, responds with WINDOW- ADDR-<index>,<address> getWindowComponentIndex(windowAddress) IWindowComponent ?WINDOWIDX- Query for the index of the window with <address>...
Page 333 Video Wall Functions (Cont.) Name Component Channel Level Command Constant Notes setImage(source, pos, size) IWindowComponent IMAGE- Set the image source, position and size rel- <source>,<x>,<y>,<hei ative to the window where <source> is 1 to ght>,<width> the maximum source number (see specific module documentation) and <x>...
Page 334 Video Wall Functions (Cont.) Name Component Channel Level Command Constant Notes processImageEvent(Position,Size) IWindowComponentListener IMAGE- Image position and/or size changed where <source>,<x>,<y>,<hei <source> is 1 to the maximum source num- ght>,<width> ber (see specific module documentation) processImageSourceEvent(int) IWindowComponentListener IMAGESOURCE- Image source for the window changed <source>...
Page 335: Volume Controller
Volume Controller IModuleComponent IModuleComponentListener IVolumeComponent IVolumeControllerComponent IVolumeControllerComponentListener IVolumeComponentListener Name: Volume Controller Interface: IVolumeController Volume Controller Functions Name Component Channel Level Command Constant Notes getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION...
Page 336 Volume Controller Functions (Cont.) Name Component Channel Level Command Constant Notes processDeviceOnLineEvent(boolean) IModuleComponentListener 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.
Page 337: Weather
Weather IModuleComponent IModuleComponentListener IWeatherComponent IWeatherComponentListener Name: Weather Interface: IWeather Weather Functions Name Component Channel Level Command Constant Notes 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>...
Page 338 Weather Functions (Cont.) Name Component Channel Level Command Constant Notes 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.
Page 339 Weather Functions (Cont.) Name Component Channel Level Command Constant Notes getWeatherConditions() IWeatherComponent ?FORECASTCONDI- Query for forecast conditions, responds TION with FORECASTCONDITION-<day 1>,<day 2>, etc.. Value list will contain one forcast condition for each forecast day. The first day is always today. Values will be BLIZZARD, BLOWINGSNOW, CLEAR, CLOUDY, DRIZZLE, DUST, FAIR, FOG, FREEZINGDRIZZLE, FREEZINGRAIN,...
Page 340 Weather Functions (Cont.) Name Component Channel Level Command Constant Notes processCurrentConditionEvent(WeatherCon- IWeatherComponentListener WEATHERCONDI- Weather condition changed, value will be ditions) TION-<condition> BLIZZARD, BLOWINGSNOW, CLEAR, CLOUDY, DRIZZLE, DUST, FAIR, FOG, FREEZINGDRIZZLE, FREEZINGRAIN, HAZE, HUMID, ICE, MOSTLYCLOUDY, MOSTLYSUNNY, PARTLYCLOUDY, RAIN, RAINSHOWERS, RAINSNOWMIX, SLEET, SMOKE, SNOW, SNOWFLURRIES, SNOWSHOWERS, SUNNY, THUNDER- STORMS, UNKNOWN, VERYCOLD,...
Page 341 Weather Functions (Cont.) Name Component Channel Level Command Constant Notes processOutdoorHumidityEvent(int) IWeatherComponentListener OUTDOOR_HUMID_LVL Outdoor humidity changed, value is in per- cent processOutdoorTemperatureEvent(float) IWeatherComponentListener OUTDOOR_TEMP_LVL Outdoor temperature changed, value is in degrees C or F depending on weather scale processRainfallEvent(float,Duration) IWeatherComponentListener WEATHERRAIN- Rain fall changed, where <duration>...
Page 342 Weather State Charts processBarometricTrendEvent State Channel 232 Channel 233 STEADY RISING FALLING OFF Standard NetLinx API (SNAPI) R 1.8.0...
Page 344 033-004-2994 9/06 ©2006 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time. 93-0070-59 REV: A...

This manual is also suitable for:

Cafe duet

AMX CAFE DUET STANDARD NETLINX API (SNAPI) DEVICES Instruction Manual

Quick Links

Need help?

Questions and answers

Related Manuals for AMX CAFE DUET STANDARD NETLINX API (SNAPI) DEVICES

Summary of Contents for AMX CAFE DUET STANDARD NETLINX API (SNAPI) DEVICES

This manual is also suitable for:

Table of Contents