Programmatic TWAIN Interface

Overview

The TWAIN driver's programmatic (non-GUI) interface supports 34 capabilities from the TWAIN specification version 2.1 in addition to 10 other custom capabilities that are available with Zebra imaging scanners.

For additional information on standard TWAIN capabilities, please visit www.twain.org.

See Table 2 below for the custom capabilities specific to Zebra imaging scanners


Zebra Scanner TWAIN Driver Supported Capabilities

The Zebra TWAIN driver supports the standard TWAIN capabilities (shown in Table 1) through the programmatic (non-GUI) interface.

Table 1: Supported Standard TWAIN Capabilities

Standard TWAIN Capability Type Supported Values (default in bold text)
CAP_SUPPORTEDCAPS TWTY_UINT16 lists the supported capabilities
ICAP_XFERMECH TWTY_UINT16 TWSX_NATIVE, TWSX_FILE, TWSX_MEMORY
ICAP_PIXELFLAVOR TWTY_UINT16 TWPF_CHOCOLATE
ICAP_COMPRESSION TWTY_UINT16 TWCP_NONE, TWCP_JPEG
ICAP_PHYSICALWIDTH TWTY_FIX32 1024.00
ICAP_PHYSICALHEIGHT TWTY_FIX32 1280.00
ICAP_MINIMUMHEIGHT TWTY_FIX32 320.00
ICAP_MINIMUMWIDTH TWTY_FIX32 256.00
ICAP_UNITS TWTY_UINT16 TWUN_PIXELS
CAP_DEVICEONLINE TWTY_BOOL TRUE, FALSE
ICAP_BRIGHTNESS TWTY_FIX32 Range: -1000.00 to 1000.00, step 1.00, default = 0.00
ICAP_PIXELTYPE TWTY_UINT16 TWPT_BW, TWPT_GRAY
ICAP_BITDEPTH TWTY_UINT16 4, 8
ICAP_SUPPORTEDSIZES TWTY_UINT16 TWSS_USLETTER
ICAP_XNATIVERESOLUTION TWTY_FIX32 512.00
ICAP_YNATIVERESOLUTION TWTY_FIX32 640.00
ICAP_XRESOLUTION TWTY_FIX32 1024.00, 512.00, 256.00
ICAP_YRESOLUTION TWTY_FIX32 1280.00, 640.00, 320.00
CAP_XFERCOUNT TWTY_INT16 -1
ICAP_IMAGEFILEFORMAT TWTY_UINT16 TWFF_TIFF, TWFF_BMP, TWFF_JFIF
ICAP_ROTATION TWTY_FIX32 0.00, 90.00, 180.00, 270.00
CAP_UICONTROLLABLE TWTY_BOOL TRUE, FALSE
CAP_ENABLEDSUIONLY TWTY_BOOL TRUE, FALSE
ICAP_LAMPSTATE TWTY_BOOL TRUE, FALSE
ICAP_EXTIMAGEINFO TWTY_BOOL TRUE, FALSE
CAP_REACQUIREALLOWED TWTY_BOOL TRUE, FALSE
CAP_POWERSUPPLY TWTY_UINT16 TWPS_EXTERNAL
ICAP_BITORDER TWTY_UINT16 TWBO_LSBFIRST, TWBO_MSBFIRST
ICAP_PLANARCHUNKY TWTY_UINT16 TWPC_CHUNKY, TWPC_PLANAR
CAP_SERIALNUMBER TWTY_STR32 Serial number of imaging scanner
CAP_CUSTOMDSDATA TWTY_BOOL TRUE, FALSE
ICAP_IMAGEFILTER TWTY_UINT16 TWIF_NONE, TWIF_LOWPASS, TWIF_BANDPASS, TWIF_HIGHPASS
ICAP_ORIENTATION TWTY_UINT16 TWOR_ROT0
ICAP_JPEGQUALITY TWTY_UINT16 Range: 0 to 100, step 1, default = 65

Table 2 below shows the custom TWAIN capabilities specific to Zebra imaging scanners which are available through the Zebra TWAIN driver's programmatic (non-GUI) interface. See Advanced Settings for descriptions of advanced capabilities. For additional information on features, consult the specific Zebra imaging scanner's Product Reference Guide available at: www.zebra.com/support

Table 2: Custom TWAIN Capabilities Specific to Zebra Imaging Scanners

Zebra Imaging Scanner Capability Cap ID Item Type Supported Msg(s) GetContainerType CurrentContainer Type Supported Values (default in bold text)
IMOTCAP_AUTOEXPOSURE 0x8001 TWTY_BOOL TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_ONEVALUE TWON_ONEVALUE TRUE: Enable
FALSE: Disable
IMOTCAP_GAINEXPOSUREPRIORITY 0x8002 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_ENUMERATION TWON_ONEVALUE GAIN_EXPOSURE_PRIORITY_LOW_GAIN: 0
GAIN_EXPOSURE_PRIORITY_LOW_EXPOSURE: 1
GAIN_EXPOSURE_PRIORITY_AUTO: 2
IMOTCAP_FIXEDEXPOSURE 0x8003 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE Range: 5 to 5000, Default = 100
IMOTCAP_FIXEDGAIN 0x8004 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE Range: 1 to 100, Default = 50
IMOTCAP_ILLUMINATIONBANKCONTROL 0x8005 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_ENUMERATION TWON_ONEVALUE ILLUMINATION_BANK_CONTROL_FULL: 0
ILLUMINATION_BANK_CONTROL_AUTO: 1
ILLUMINATION_BANK_CONTROL_LEFT: 2
ILLUMINATION_BANK_CONTROL_RIGHT: 3
IMOTCAP_CROP 0x8006 TWTY_BOOL TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_ONEVALUE TWON_ONEVALUE FALSE: Disable
IMOTCAP_LEFTPIXEL 0x8007 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE 0 - 1279
IMOTCAP_RIGHTPIXEL 0x8008 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE 0 - 1279
IMOTCAP_TOPPIXEL 0x8009 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE 0 - 1023
IMOTCAP_BOTTOMPIXEL 0x8010 TWTY_UINT16 TWQC_GET,
TWQC_GETDEFAULT,
TWQC_GETCURRENT,
TWQC_RESET,
TWQC_SET
TWON_RANGE TWON_ONEVALUE 0 - 1023