User Guide

Standard NetLinx API (SNAPI) R 1.8.0
126
Document Camera Functions (Cont.)
Name Component Channel Level Command Constant Notes
setZoomRamp(OUT) IDocumentCameraComponent 158 ZOOM_OUT Ramping Channel: Zoom is ramped
out(far) while channel is active
setZoomRamp(IN) IDocumentCameraComponent 159 ZOOM_IN Ramping Channel: Zoom is ramped in
(tele) while channel is active
setZoomSpeed(speed) IDocumentCameraComponent 18 ZOOM_SPEED_LVL Set zoom speed, range is 0-255 (0=slow)
processAutoFocusEvent(boolean) IDocumentCameraComponentListener 162 AUTO_FOCUS_FB Feedback Channel: Auto focus is on if
channel is active
processAutoIrisEvent(boolean) IDocumentCameraComponentListener 163 AUTO_IRIS_FB Feedback Channel: Auto iris is on if chan-
nel is active
processFocusEvent(int) IDocumentCameraComponentListener 16 FOCUS_LVL Focus changed, range is 0-255 (0=near)
processFocusRampEvent(NEAR) IDocumentCameraComponentListener 160 FOCUS_NEAR_FB Feedback Channel: Focus is ramping near
while channel is on
processFocusRampEvent(FAR) IDocumentCameraComponentListener 161 FOCUS_FAR_FB Feedback Channel: Focus is ramping far
while channel is on
processFocusSpeedEvent(int) IDocumentCameraComponentListener 19 FOCUS_SPEED_LVL Focus speed changed, range is 0-255
(0=slow)
processIrisEvent(int) IDocumentCameraComponentListener 17 IRIS_LVL Iris changed, range is 0-255 (0=closed)
processIrisRampEvent(OPEN) IDocumentCameraComponentListener 174 IRIS_OPEN_FB Feedback Channel: Iris is ramping open
while channel is on
processIrisRampEvent(CLOSE) IDocumentCameraComponentListener 175 IRIS_CLOSE_FB Feedback Channel: Iris is ramping closed
while channel is on
processIrisSpeedEvent(int) IDocumentCameraComponentListener 20 IRIS_SPEED_LVL Iris speed changed, range is 0-255
(0=slow)
processLowerLightEvent(boolean) IDocumentCameraComponentListener 197 DOCCAM_LOWER_LIGHT_
FB
Feedback Channel: Lower light is on if
channel is active
processUpperLightEvent(boolean) IDocumentCameraComponentListener 198 DOCCAM_UPPER_LIGHT_
FB
Feedback Channel: Upper light is on if
channel is active
processZoomEvent(int) IDocumentCameraComponentListener 15 ZOOM_LVL Zoom changed, range is 0-255 (0=out/
wide)
processZoomRampEvent(OUT) IDocumentCameraComponentListener 158 ZOOM_OUT_FB Feedback Channel: Zoom is ramping out
(wide) while channel is on
processZoomRampEvent(IN) IDocumentCameraComponentListener 159 ZOOM_IN_FB Feedback Channel: Zoom is ramping in
(tele) while channel is on
processZoomSpeedEvent(int) IDocumentCameraComponentListener 18 ZOOM_SPEED_LVL Zoom speed changed, range is 0-255
(0=slow)
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>