User Guide

Standard NetLinx API (SNAPI) R 1.8.0
164
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
getZOrder() ?WINDOWZORDER Get the Z-order. Responds with WINDOWZORDER-<value> where <value> is 1 to the
maximum z-order of the device, 1 is the top-most z-order (see specific module docu-
mentation)
pan(DOWN) 133 PAN_DN Momentary Function Channel: Image is moved down one step within the window when
channel is activated
pan(LEFT) 134 PAN_LT Momentary Function Channel: Image is moved left one step within the window when
channel is activated
pan(RIGHT) 135 PAN_RT Momentary Function Channel: Image is moved right one step within the window when
channel is activated
pan(UP) 132 PAN_UP Momentary Function Channel: Image is moved up one step within the window when
channel is activated
removeWindowCompo-
nent(index)
WINDOWREMOVEIDX-<index> Remove the window at index <index>, where <index> is 1 through x and x is the maxi-
mum supported window index (see specific module documentation)
removeWindowCompo-
nent(windowAddress)
WINDOWREMOVEADDR-
<address>
Remove the window with address <address>, where <address> is a window address
setBrightness(level) 10 BRIGHT_LVL Set brightness level, range is 0-255
setColor(level) 11 COLOR_LVL Set color level, range is 0-255
setContrast(level) 12 CONTRAST_LVL Set contrast level, range is 0-255
setFreezeOn(state) 214 PIC_FREEZE_ON Discrete Function Channel: Freeze is on while channel is active
setImage(source, pos,
size)
IMAGE-
<source>,<x>,<y>,<height>,<width>
Set the image source, position and size relative to the window where <source> is 1 to
the maximum source number (see specific module documentation) and <x> and <y>
are the window coordinates for the upper-left hand corner of the image and <height>
and <width> are the size of the image to be displayed in the window. Used to change
the position of the image visible in the window.
setImageSource(int) IMAGESOURCE-<source> Set the image source for the window where <source> is 1 to the maximum source num-
ber (see specific module documentation)
setPictureMuteOn(state) 211 PIC_MUTE_ON Discrete Function Channel: Picture Mute is on while channel is active
setSharpness(level) 13 SHARP_LVL Set sharpness level, range is 0-255
setTint(level) 14 TINT_LVL Set tint level, range is 0-255
setWindow(pos,size) WINDOW-<x>,<y>,<height>,<width> Set the window position and size relative to the display where <x> and <y> are the dis-
play coordinates for the upper-left hand corner of the window and <height> and <width>
are the size of the window to be displayed in the display. Used to change the position
of the window visible in the display.
setZOrder(position) WINDOWZORDER-<position> Shuffle the window z-order relative to the other windows where <postiion> is FRONT,
BACK, FORWARD (up one level), BACKWARD (down one level)
setZOrder(value) WINDOWZORDER-<value> Set the Z-order where <value> is 1 to the maximum z-order of the device, 1 is the top-
most z-order (see specific module documentation)
zoomIn() 159 ZOOM_IN Momentary Function Channel: Image size is enlarged within the window (zoom in/tele)
when channel is activated
zoomOut() 158 ZOOM_OUT Momentary Function Channel: Image size is reduced within the window (zoom out/win-
dow) when channel is activated