Global

Members

# (constant) CapEnum :object

Enum of all available TWAIN enum capabilities and its possible values.

Type:
  • object
Properties
Name Type Description
Alarms object
AutoDiscardBlankPages object
AutoSize object
BarCodeSearchMode object
BatteryMinutes object
BatteryPercentage object
BitDepthReduction object
BitOrder object
CameraSide object
ClearBuffers object
Compression object
DeviceEvent object
DoubleFeedDetection object
DoubleFeedDetectionResponse object
DoubleFeedDetectionSensitivity object
Duplex object
FeederAlignment object
FeederOrder object
FeederPocket object
FeederType object
Filter object
FlashUsed object
FlipRotation object
IccProfile object
ImageFileFormat object
ImageFilter object
TWScanFormatType object
ImageMerge object
IndicatorsMode object
IPixelType object
IUnits object
IXferMech object
JobControl object
JpegQuality object
JpegSubsamplingQuality object
Language object
LightPath object
LightSource object
NoiseFilter object
Orientation object
OverScan object
PaperHandling object
PatchCode object
PatchCodeSearchMode object
PatchCodeSearchPriorities object
PixelFlavor object
PlanarChunky object
PowerSupply object
Printer object
PrinterFontStyle object
PrinterIndexTrigger object
PrinterMode object
Segmented object
SupportedBarCodeTypes object
SupportedDats object
SupportedExtImageInfo object
SupportedPatchCodeTypes object
SupportedSizes object
TiffCompression object

# (constant) CapName :object

List of all available capabilities.

Type:
  • object
Properties
Name Type Description
ALARMS Array.<CapEnum.TwAL>

[AudibleAlarms] Turns specific audible alarms on and off. CAP_ALARMS

ALARM_VOLUME int

[AudibleAlarms] Controls the volume of a device’s audible alarm. CAP_ALARMVOLUME

AUTOMATIC_CAPTURE int

[AutomaticCapture] The number of images to automatically capture. This does not refer to the number of images to be sent to the Application, use CAP_XFERCOUNT for that. CAP_AUTOMATICCAPTURE

AUTO_FEED bool

[Feeder] If TRUE, the Source will automatically feed the next page from the document feeder after the number of frames negotiated for capture from each page are acquired. CAP_FEEDERENABLED must be TRUE to use this capability. CAP_AUTOFEED

AUTHOR string

[ImageInformation] Author of acquired image (may include a copyright string). Gets the author. CAP_AUTHOR

AUTOMATIC_CROP_USES_FRAME bool

[AutomaticAdjustments] Reduces the amount of data captured from the device, potentially improving the performance of the driver. Read only. ICAP_AUTOMATICDESKEW

AUTO_SCAN bool

[AutomaticScanning] Enables the source’s automatic document scanning process. CAP_AUTOSCAN

AUTO_DISCARD_BLANK_PAGES CapEnum.TwBP

[AutomaticAdjustments] Discards blank pages. ICAP_AUTODISCARDBLANKPAGES

AUTO_BRIGHT bool

[ImageAcquire] The source Auto-brightness function (if any). ICAP_AUTOBRIGHT

AUTOMATIC_BORDER_DETECTION bool

[AutomaticAdjustments] Turns automatic border detection on and off. ICAP_AUTOMATICBORDERDETECTION

AUTOMATIC_SENSE_MEDIUM bool

[AutomaticAdjustments] Configures a Source to check for paper in the Automatic Document Feeder. CAP_AUTOMATICSENSEMEDIUM

AUTOMATIC_DESKEW bool

[AutomaticAdjustments] Turns automatic skew correction on and off. ICAP_AUTOMATICDESKEW

AUTOMATIC_ROTATE bool

[AutomaticAdjustments] When true, depends on source to automatically rotate the image. ICAP_AUTOMATICROTATE

AUTO_SIZE CapEnum.TwAS

[AutomaticAdjustments] Gets auto size capability. Force the output image dimensions to match either the current value of ICAP_SUPPORTEDSIZES or any of its current allowed values. ICAP_AUTOSIZE

AUTOMATIC_LENGTH_DETECTION bool

[AutomaticAdjustments] Controls the automatic detection of the length of a document, this is intended for use with an Automatic Document Feeder. ICAP_AUTOMATICLENGTHDETECTION

AUTOMATIC_COLOR_ENABLED bool

[AutomaticAdjustments] Detects the pixel type of the image and returns either a color image or a non-color image specified by CapName.AUTOMATIC_COLOR_NON_COLOR_PIXEL_TYPE. ICAP_AUTOMATICCOLORENABLED

AUTOMATIC_COLOR_NON_COLOR_PIXEL_TYPE CapEnum.TwPixelType

[AutomaticAdjustments] Specifies the non-color pixel type to use when automatic color is enabled. ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE.

BAR_CODE_MAX_SEARCH_PRIORITIES uint

[BarCodeDetection] Specifies the maximum number of supported search priorities. ICAP_BARCODEMAXSEARCHPRIORITIES

BAR_CODE_SEARCH_PRIORITIES CapEnum.TwBT

[BarCodeDetection] A prioritized list of bar code types dictating the order in which bar codes will be sought. ICAP_BARCODESEARCHPRIORITIES

BAR_CODE_SEARCH_MODE CapEnum.TwBD

[BarCodeDetection] Restricts bar code searching to certain orientations, or prioritizes one orientation over the other. ICAP_BARCODESEARCHMODE

BAR_CODE_MAX_RETRIES uint

[BarCodeDetection] Restricts the number of times a search will be retried if none are found on each page. ICAP_BARCODEMAXRETRIES

BAR_CODE_TIMEOUT uint

[BarCodeDetection] Gets the bar code timeout. Restricts the total time spent on searching for a bar code on each page. ICAP_BARCODETIMEOUT

BAR_CODE_DETECTION_ENABLED bool

[BarCodeDetection] Support this capability if the scanner supports any Bar code recognition. If the device allows this feature to be turned off, then default to off. ICAP_BARCODEDETECTIONENABLED

BATTERY_MINUTES CapEnum.TwBM1

[PowerMonitoring] The minutes of battery power remaining to the device. Read only. CAP_BATTERYMINUTES

BATTERY_PERCENTAGE CapEnum.TwBM2

[PowerMonitoring] When used with MSG_GET, return the percentage of battery power level on camera. If -1 is returned, it indicates that the battery is not present. Read only. CAP_BATTERYPERCENTAGE

BIT_DEPTH ushort

[ImageType] Specifies the pixel bit depths for the Current value of . ICAP_BITDEPTH

BIT_DEPTH_REDUCTION Array.<CapEnum.TwBR>

[ImageType] Specifies the Reduction Method the Source should use to reduce the bit depth of the data. Most commonly used with = to reduce gray data to black and white. ICAP_BITDEPTHREDUCTION

BIT_ORDER Array.<CapEnum.TwBO>

[Compression] Specifies how the bytes in an image are filled by the Source. indicates that the leftmost bit in the byte (usually bit 7) is the byte’s Most Significant Bit. ICAP_BITORDER

BIT_ORDER_CODES CapEnum.TwBO

[Compression] Used for CCITT data compression only. Indicates the bit order representation of the stored compressed codes. ICAP_BITORDERCODES

BRIGHTNESS float

[ImageAcquire] The brightness values available within the Source. ICAP_BRIGHTNESS

CAMERA_ENABLED bool

[AutomaticScanning] When set to true the device will deliver images from the current camera. CAP_CAMERAENABLED

CAMERA_ORDER Array.<CapEnum.TwPixelType>

[AutomaticScanning] This capability selects the order of output for Single Document Multiple Image (SDMI) mode based on an array of pixel types; it does not constrain the allowed pixel types. CAP_CAMERAORDER

CAMERA_PREVIEW_UI bool

[UserInterface] This capability queries the Source for UI support for preview mode. If true, the Source supports preview UI. Read only. CAP_CAMERAPREVIEWUI

CAMERA_SIDE CapEnum.TwCS

[AutomaticScanning] TWAIN models a duplex scanner as conceptually having two 'cameras' - a 'top' camera that captures the front of each page, and a 'bottom' camera that captures the back. CAP_CAMERASIDE

CAPTION string

[ImageFormation] General note about acquired image. CAP_CAPTION

CCITT_K_FACTOR ushort

[Compression] Used for CCITT Group 3 2-dimensional compression.The ‘K’ factor indicates how often the new compression baseline should be re-established.A value of 2 or 4 is common in facsimile communication.A value of zero in this field will indicate an infinite K factor—the baseline is only calculated at the beginning of the transfer. ICAP_CCITTKFACTOR

CLEAR_BUFFERS CapEnum.TwCB

[AutomaticScanning] Getting Value reports the presence of data in the scanner’s buffers. Setting with a value of TwCB.Clear immediately clears the buffers. CAP_CAMERASIDE

CLEAR_PAGE bool

[Feeder] Source will eject the current page being acquired from and will leave the feeder acquire area empty. CAP_CLEARPAGE

COLOR_MANAGEMENT_ENABLED bool

[Color] Disables the Source’s color and gamma tables for color and grayscale images, resulting in output that that could be termed “raw”. ICAP_COLORMANAGEMENTENABLED

CONTRAST float

[ImageAcquire] The contrast values available within the Source. ICAP_CONTRAST

CUSTOM_DS_DATA bool

[UserInterface] Allows the application to query the data source to see if it supports the new operation triplets. CAP_CUSTOMDSDATA

CUSTOM_INTERFACE_GUID string

[UserInterface] Uniquely identifies an interface for a Data Source, so that an Application can properly interpret its custom content. This is a read only capability. Read only. CAP_CUSTOMINTERFACEGUID

CUST_HALFTONE byte

[ImageType] Specifies the square-cell halftone (dithering) matrix the Source should use to halftone the image. ICAP_CUSTHALFTONE

DEVICE_EVENT Array.<CapEnum.TwDE>

[AsyncDeviceEvents] Selects which events the application wants the source to report. CAP_DEVICEEVENT

DEVICE_ONLINE bool

[Device] If true, the physical hardware (e.g., scanner, digital camera, image database, etc.) that represents the image source is attached, powered on, and communicating. Read only. CAP_DEVICEONLINE

DEVICE_TIME_DATE string

[Device] The date and time of the device’s clock. Managed in the form “YYYY/MM/DD HH:mm:SS:sss” CAP_DEVICETIMEDATE

DOUBLE_FEED_DETECTION Array.<CapEnum.TwDF>

[DoubleFeedDetection] Type of the double feed detection method. To disable set empty array. CAP_DOUBLEFEEDDETECTION

DOUBLE_FEED_DETECTION_LENGTH float

[DoublefeedDetection] When includes , it allows an Application to set the minimum length for detecting double feed documents.A value of zero always means “off”. CAP_DOUBLEFEEDDETECTIONLENGTH

DOUBLE_FEED_DETECTION_SENSITIVITY CapEnum.TwUS

[DoublefeedDetection] When includes , allows an Application to set how sensitive the double feed detection is. CAP_DOUBLEFEEDDETECTIONSENSITIVITY

DOUBLE_FEED_DETECTION_RESPONSE Array.<CapEnum.TwDP>

[DoublefeedDetection] It allows an Application to set how the source will respond to detecting a double feed. CAP_DOUBLEFEEDDETECTIONRESPONSE

DUPLEX CapEnum.TwDX

[Duplex] This indicates whether the scanner supports duplex. If so, it further indicates whether one-path or two-path duplex is supported. CAP_DUPLEX

DUPLEX_ENABLED bool

[Duplex] Is duplex enabled. CAP_DUPLEXENABLED

ENABLE_DS_UI_ONLY bool

[UserInterface] Allows an application to query a source to see if it implements the new user interface settings dialog. Read only. CAP_ENABLEDSUIONLY

ENDORSER uint

[ImprinterEndorser] Allows the application to specify the scanner’s starting endorser / imprinter number. CAP_ENDORSER

EXT_IMAGE_INFO bool

[ImageInformation] Allows the application to query the data source to see if it supports the new operation triplet DG_IMAGE/DAT_EXTIMAGEINFO/ MSG_GET. ICAP_EXTIMAGEINFO

EXPOSURE_TIME float

[Device] Specifies the exposure time used to capture the image, in seconds. ICAP_EXPOSURETIME

EXTENDED_CAPS Array.<CapEnum.TwCap>

[Caps] Returns a list of the capabilities already negotiated. Read only. CAP_EXTENDEDCAPS

FEED_PAGE bool

[Feeder!] If TRUE, the Source will eject the current page and advance the next page in the document feeder into the feeder acquire area. If CAP_AUTOFEED is TRUE, the same action just described will occur and CAP_AUTOFEED will remain active. CAP_FEEDERENABLED must equal TRUE to use this capability

FEEDER_ALIGNMENT CapEnum.TwFA

[Feeder] Indicates the alignment of the document feeder. CAP_FEEDERALIGNMENT

FEEDER_ENABLED bool

[Feeder] If true, Source’s feeder is enabled. CAP_FEEDERENABLED

FEEDER_LOADED bool

[Feeder] Reflect whether there are documents loaded in the Source’s feeder. This is a read only capability. Read only. CAP_FEEDERLOADED

FEEDER_ORDER CapEnum.TwFO

[Feeder] Indicates the alignment of the document feeder. CAP_FEEDERORDER

FEEDER_PREP bool

[Feeder] Improve the movement of paper through a scanner ADF. If CAP_FEEDERENABLED is TRUE, and CAP_FEEDERPREP is TRUE, then the scanner will perform any action needed to improve the movement of paper through the transport. CAP_FEEDERPREP

FEEDER_POCKET Array.<CapEnum.TwFP>

[Feeder] Report what pockets are available to receive paper as it exits from the device. This capability enumerates the available output or collation pockets on the device. TWFP_POCKET1 - TWFP_POCKET16 are organized from top to bottom and left to right, facing in the direction of the motion of the paper. CAP_FEEDERPOCKET

FEEDER_TYPE CapEnum.TwFE

[Feeder] Allows application to set scan parameters depending on the type of feeder being used. ICAP_FEEDERTYPE

FILTER Array.<CapEnum.TwFT>

[Color] Describes the color characteristic of the subtractive filter applied to the image data. Multiple filters may be applied to a single acquisition. ICAP_FILTER

FLASH_USED2 CapEnum.TwFL

[Device] For devices that support flash. MSG_SET selects the flash to be used (if any). MSG_GET reports the current setting.This capability replaces ICAP_FLASHUSED, which is only able to negotiate the flash being on or off. ICAP_FLASHUSED2

FLIP_ROTATION CapEnum.TwFR

[AutomaticAdjustments] Orients images that flip orientation every other image. ICAP_FLIPROTATION

FRAMES RectangleF

[Page] The list of frames the Source will acquire on each page. ICAP_FRAMES

GAMMA float

[Color] Gamma correction value for the image data. ICAP_GAMMA

HALFTONES string

[ImageType] A list of names of the halftone patterns available within the Source. ICAP_HALFTONES

HIGHLIGHT float

[ImageAcquire] Specifies which value in an image should be interpreted as the lightest “highlight.” All values “lighter” than this value will be clipped to this value. ICAP_HIGHLIGHT

ICC_PROFILE CapEnum.TwIC

[Color] Informs the application if the source has an ICC profile and can embed or link it in the current ICAP_IMAGEFILEFORMAT.Tells the source if the application would like an ICC profile embedded or linked into the image file the source will write. ICAP_ICCPROFILE

ICOMPRESSION CapEnum.TwCompression

[Transfer] Buffered Memory transfer compression schemes. ICAP_COMPRESSION

IMAGE_DATA_SET Array.<uint>

[ImageAcquire] Gets or sets the image indices that will be delivered during the standard image transfer. ICAP_IMAGEDATASET

IMAGE_FILE_FORMAT CapEnum.TwFF

[Transfer] File formats for file transfers. ICAP_IMAGEFILEFORMAT

IMAGE_FILTER CapEnum.TwIF

[Device] For devices that support image enhancement filtering. This capability selects the algorithm used to improve the quality of the image. ICAP_IMAGEFILTER

IMAGE_MERGE CapEnum.TwIM

[AutomaticAdjustments] Merges the front and rear image of a document in one of four orientations: front on the top, front on the bottom, front on the left or front on the right. ICAP_IMAGEMERGE

IMAGE_MERGE_HEIGHT_THRESHOLD float

[AutomaticAdjustments] Specifies a Y-Offset in ICAP_UNITS units. Front and rear images less than or equal to this value are merged according to the settings of ICAP_IMAGEMERGE. If either the front or the rear image is greater than this value, they are not merged. ICAP_IMAGEMERGEHEIGHTTHRESHOLD

INDICATORS bool

[UserInterface] If true, the Source displays a progress indicator during acquisition and transfer, regardless of whether the Source's user interface is active. If FALSE, the progress indicator is suppressed if the Source's user interface is inactive. The Source displays device-specific instructions and error messages if either the user interface or progress indicator is turned on.In this case it returns TWCC_OPERATIONERROR to alert the application that it handled the error, and communicated the problem to the user. If both the user interface and progress indicator are turned off, then the Source never displays any message to the user, even if TWCC_OPERATIONERROR is returned.Messages to the user are under the sole control of the Application. CAP_INDICATORS

INDICATORS_MODE CapEnum.TwCI

[UserInterface] Specify what messages can be displayed if is TRUE. CAP_INDICATORSMODE

IPIXEL_TYPE CapEnum.TwPixelType

[ImageType] The type of pixel data (B/W, gray, color, etc.). ICAP_PIXELTYPE

IUNITS CapEnum.TwUnits

[Device] Unless a quantity is dimensionless or uses a specified unit of measure, this setting determines the unit of measure for all quantities. ICAP_UNITS

IXFER_MECH CapEnum.TwSX

[Transfer] Gets the transfer mechanism. ICAP_XFERMECH

JOB_CONTROL CapEnum.TwJC

[Transfer] Allows multiple jobs in batch mode. The application can decide how the job can be processed, according to the flags listed below. CAP_JOBCONTROL

JPEG_PIXEL_TYPE CapEnum.TwPixelType

[Compression] Allows the application and Source to agree upon a common set of color descriptors that are made available by the Source.This ICAP is only useful for JPEG-compressed buffered memory image transfers. ICAP_JPEGPIXELTYPE

JPEG_SUB_SAMPLING CapEnum.TwJS

[Compression] Use this capability and JpegQuality as a shortcut to select JPEG quantization. ICAP_JPEGSUBSAMPLING

JPEG_QUALITY CapEnum.TwJQ

[Compression] Use this capability as a shortcut to select JPEG quantization tables that tradeoff quality versus compressed image size. Used in concert with DAT_JPEGCOMPRSSION it is possible for an Application to obtain the tables that are appropriate for varying percentages of quality within a given Source. ICAP_JPEGQUALITY

LAMP_STATE bool

[Device] TRUE means the lamp is currently, or should be set to ON.Sources may not support MSG_SET operations. ICAP_LAMPSTATE

LANGUAGE CapEnum.TwLanguage

[Language] Allows application and source to identify which languages they have in common. CAP_LANGUAGE

LIGHT_PATH CapEnum.TwLP

[Device] Describes whether the image was captured transmissively or reflectively. ICAP_LIGHTPATH

LIGHT_SOURCE CapEnum.TwLS

[Device] Describes the general color characteristic of the light source used to acquire the image. ICAP_LIGHTSOURCE

MAX_BATCH_BUFFERS uint

. [AutomaticScanning] Describes the number of pages that the scanner can buffer. CAP_MAXBATCHBUFFERS

MAX_FRAMES ushort

[Page] The maximum number of frames the Source can provide or the application can accept per page. This is a bounding capability only.It does not establish current or future behavior. ICAP_MAXFRAMES

MICR_ENABLED bool

[MICR] Gets the micr enabled capability. Get this capability to determine if the Source supports check scanning. If set to true check scanning is enabled, if set to false check scanning is disabled. CAP_MICRENABLED

MINIMUM_HEIGHT float

[Device] Allows the source to define the minimum height (Y-axis) that the source can acquire (measured in units of CapName.IUNITS). This is a read only capability. Read only. ICAP_MINIMUMHEIGHT

MINIMUM_WIDTH float

[Device] Allows the source to define the minimum width (X-axis) that the source can acquire (measured in units of CapName.IUNITS). This is a read only capability. Read only. ICAP_MINIMUMWIDTH

MIRROR CapEnum.TwMR

[ImageAcquire] How the Source can/should mirror the scanned image data prior to transfer. ICAP_MIRROR

NOISE_FILTER CapEnum.TwNF

[Device] For devices that support noise filtering, selects the algorithm to be used. ICAP_NOISEFILTER

ORIENTATION CapEnum.TwOR

[ImageAcquire] Defines which edge of the “paper” the image’s “top” is aligned with. ICAP_ORIENTATION

OVER_SCAN CapEnum.TwOV

[Device] Overscan is used to scan outside of the boundaries described by ICAP_FRAMES, and is used to help acquire image data that may be lost because of skewing. ICAP_OVERSCAN

PAPER_DETECTABLE bool

[Feeder] Determines whether source can detect documents on the ADF or flatbed. Read only. CAP_PAPERDETECTABLE

PAPER_HANDLING Array.<CapEnum.TwPH>

[Feeder] Control paper handling. CAP_PAPERHANDLING

PATCH_CODE_DETECTION_ENABLED bool

[PatchCodeDetection] Gets patch code detection enabled capability. Turns patch code detection on and off. ICAP_PATCHCODEDETECTIONENABLED

PATCH_CODE_MAX_RETRIES uint

[PatchCodeDetection] Restricts the number of times a search will be retried if none are found on each page. ICAP_PATCHCODEMAXRETRIES

PATCH_CODE_SEARCH_PRIORITIES Array.<CapEnum.TwPCH>

[PatchCodeDetection] A prioritized list of patch code types dictating the order in which patch codes will be sought. Read only. ICAP_PATCHCODESEARCHPRIORITIES

PATCH_CODE_MAX_SEARCH_PRIORITIES uint

[PatchCodeDetection] The maximum number of supported search priorities. ICAP_PATCHCODEMAXSEARCHPRIORITIES

PATCH_CODE_SEARCH_MODE CapEnum.TwBD

[PatchCodeDetection] Restricts patch code searching to certain orientations, or prioritizes one orientation over the other ICAP_PATCHCODESEARCHMODE

PATCH_CODE_TIMEOUT uint

[PatchCodeDetection] Restricts the total time spent on searching for a patch code on each page. ICAP_PATCHCODETIMEOUT

PIXEL_FLAVOR CapEnum.TwPF

[ImageType] Sense of the pixel whose numeric value is zero. ICAP_PIXELFLAVOR

PIXEL_FLAVOR_CODES CapEnum.TwPF

[Compression] Sense of the pixel whose numeric value is zero (minimum data value). ICAP_PIXELFLAVORCODES

PLANAR_CHUNKY CapEnum.TwPC

[Color] Allows the application and Source to identify which color data formats are available. There are two options, “planar” and “chunky.” ICAP_PLANARCHUNKY

POWER_SUPPLY CapEnum.TwPS

[PowerMonitoring] MSG_GET reports the kinds of power available to the device. MSG_GETCURRENT reports the current power supply in use. This is a read only capability. Read only. CAP_POWERSUPPLY

POWER_SAVE_TIME int

[PowerMonitoring] When used with MSG_SET, set the camera power down timer in seconds. When used with MSG_GET, return the current setting of the power down time. CAP_POWERSAVETIME

PRINTER CapEnum.TwPR

[ImprinterEndorser] It gets the current list of available printer devices, along with the one currently being used for negotiation. Setting value selects the current device for negotiation, and optionally constrains the list. Reseting restores all the available devices(useful after setting a value has been used to constrain the list). CAP_PRINTER

PRINTER_CHAR_ROTATION Array.<uint>

[ImprinterEndorser] Orientation of each character in the font. CAP_PRINTERCHARROTATION

PRINTER_ENABLED bool

[ImprinterEndorser] Turns the current imprinter device on or off. CAP_PRINTERENABLED

PHYSICAL_HEIGHT float

[Device] The maximum physical height (Y-axis) the Source can acquire (measured in units of CapName.IUNITS). Read only. ICAP_PHYSICALHEIGHT

PHYSICAL_WIDTH float

[Device] The maximum physical width (X-axis) the Source can acquire (measured in units of CapName.IUNITS). Read only. ICAP_PHYSICALWIDTH.

PRINTER_FONT_STYLE Array.<CapEnum.TwPrinterFontStyle>

[ImprinterEndorser] Style (ex: bold, italic…). CAP_PRINTERFONTSTYLE

PRINTER_INDEX uint

[ImprinterEndorser] Gets the index of the current imprinter. CAP_PRINTERINDEX

PRINTER_INDEX_LEAD_CHAR Array.<string>

[ImprinterEndorser] Lead character for padding. CAP_PRINTERINDEXLEADCHAR

PRINTER_INDEX_MAX_VALUE Array.<uint>

[ImprinterEndorser] Maximum allowed printer index value. CAP_PRINTERINDEXMAXVALUE

PRINTER_INDEX_NUM_DIGITS Array.<uint>

[ImprinterEndorser] Maximum allowed digits in printer index value. CAP_PRINTERINDEXNUMDIGITS

PRINTER_INDEX_STEP Array.<uint>

[ImprinterEndorser] Increment between printer index values. CAP_PRINTERINDEXSTEP

PRINTER_INDEX_TRIGGER Array.<CapEnum.TwPrinterIndexTrigger>

[ImprinterEndorser] Triggers for incrementing the printer index value. CAP_PRINTERINDEXTRIGGER

PRINTER_MODE CapEnum.TwPM

[ImprinterEndorser] Specifies the appropriate current imprinter device mode. CAP_PRINTERMODE

PRINTER_STRING string

[ImprinterEndorser] Specifies the string(s) that are to be used in the string component when the current imprinter device is enabled. CAP_PRINTERSTRING

PRINTER_STRING_PREVIEW Array.<string>

[ImprinterEndorser] Preview of what a printer string will look like. CAP_PRINTERSTRINGPREVIEW

PRINTER_SUFFIX string

[ImprinterEndorser] Specifies the string that shall be used as the current imprinter device’s suffix. CAP_PRINTERSUFFIX

PRINTER_VERTICAL_OFFSET float

[ImprinterEndorser] Gets the printer vertical offset. Specifies a Y-Offset in for the current imprinter device. CAP_PRINTERVERTICALOFFSET

REACQUIRE_ALLOWED bool

[Feeder] Capable of acquiring multiple images of the same page without changing the physical registration of that page. Read only. CAP_REACQUIREALLOWED

REWIND_PAGE bool

[Feeder] The Source will return the current page to the input side of the document feeder and feed the last page from the output side of the feeder back into the acquisition area. CAP_REWINDPAGE

ROTATION float

[ImageAcquire] How the Source can/should rotate the scanned image data prior to transfer. ICAP_ROTATION

SEGMENTED CapEnum.TwSG

[Page] Describes the segmentation setting for captured images. Image segmentation occurs when either the device, the Source or the Application breaks up an image into a stream of image components (text, pictures, graphics) that must be assembled by the application to reconstruct the original document. CAP_SEGMENTED

SERIAL_NUMBER string

[Device] A string containing the serial number of the currently selected device in the Source. Multiple devices may all report the same serial number. Read only. CAP_SERIALNUMBER

SHADOW float

[ImageAcquire] Darkest shadow, values darker than this value will be clipped to this value. ICAP_SHADOW

SUPPORTED_BAR_CODE_TYPES Array.<CapEnum.TwBT>

[BarCodeDetection] Provides a list of bar code types that can be detected by the current Data Source. This is a read only capability. Read only. ICAP_SUPPORTEDBARCODETYPES

SUPPORTED_CAPS Array.<CapEnum.TwCap>

[Caps] Returns a list of all the capabilities for which the Source will answer inquiries. Does not indicate which capabilities the Source will allow to be set by the application.Some capabilities can only be set if certain setup work has been done so the Source cannot globally answer which capabilities are “set-able.” Read only. CAP_SUPPORTEDCAPS

SUPPORTED_CAPS_SEGMENT_UNIQUE Array.<uint>

For Sources that allow unique values to be set for things like the top and bottom or for each segment on a page. Returns a list of all the capabilities for which the Source allows to have unique values. Read only. CAP_SUPPORTEDCAPSSEGMENTUNIQUE

SUPPORTED_DATS Array.<CapEnum.TwDG>

[Caps] Inquire Source’s DAT messages that are valid. Read only. CAP_SUPPORTEDDATS

SUPPORTED_EXT_IMAGE_INFO Array.<CapEnum.TwEI>

[ImageInformation] Gets the supported ext image information. Lists all of the information that the Source is capable of returning from a call to DAT_EXTIMAGEINFO. Read only. ICAP_SUPPORTEDEXTIMAGEINFO

SUPPORTED_PATCH_CODE_TYPES Array.<CapEnum.TwPCH>

[PatchCodeDetection] A list of patch code types that may be detected by the current Data Source. This is a read only capability. Read only. ICAP_SUPPORTEDPATCHCODETYPES

SUPPORTED_SIZES CapEnum.TwSS

[Page] Gets the supported sizes capability. For devices that support fixed frame sizes. Defined sizes match typical page sizes. This specifies the size(s) the Source can/should use to acquire image data. ICAP_SUPPORTEDSIZES

THRESHOLD float

[ImageType] Specifies the dividing line between black and white. This is the value the Source will use to threshold, if needed, when = . ICAP_THRESHOLD

THUMBNAILS_ENABLED bool

[ImageAcquire] Allows an application to request the delivery of thumbnail representations for the set of images that are to be delivered. CAP_THUMBNAILSENABLED

TILES bool

[Transfer] This is used with buffered memory transfers. If TRUE, Source can provide application with tiled image data. ICAP_TILES

TIME_BEFORE_FIRST_CAPTURE int

[AutomaticCapture] For automatic capture, this value selects the number of milliseconds before the first picture is to be taken, or the first image is to be scanned. CAP_TIMEBEFOREFIRSTCAPTURE

TIME_BETWEEN_CAPTURES int

[AutomaticCapture] For automatic capture, this value selects the milliseconds to wait between pictures taken, or images scanned. CAP_TIMEBETWEENCAPTURES

TIME_FILL ushort

[Compression] Used only with CCITT data compression. Specifies the minimum number of words of compressed codes(compressed data) to be transmitted per line. ICAP_TIMEFILL

UI_CONTROLLABLE bool

[UserInterface] If true, indicates that this Source supports acquisition with/without the UI. Read only. CAP_UICONTROLLABLE

UNDEFINED_IMAGE_SIZE bool

[Transfer] If TRUE the Source will issue a MSG_XFERREADY before starting the scan. ICAP_UNDEFINEDIMAGESIZE

XFER_COUNT short

[Transfer] Number of images the application is willing to accept this session. CAP_XFERCOUNT

X_NATIVE_RESOLUTION float

[Resolution] Current/Available optical resolutions for x-axis. ICAP_XNATIVERESOLUTION

X_RESOLUTION float

[Resolution] Measured in units of pixels per unit as defined by CapName.IUNITS. ICAP_XRESOLUTION

X_SCALING float

[ImageAcquire] All the X-axis scaling values available. A value of ‘1.0’ is equivalent to 100% scaling. Do not use values less than or equal to zero. ICAP_XSCALING

Y_NATIVE_RESOLUTION float

[Resolution] Current/Available optical resolutions for x-axis. ICAP_YNATIVERESOLUTION

Y_RESOLUTION float

[Resolution] Measured in units of pixels per unit as defined by CapName.IUNITS. ICAP_YRESOLUTION

Y_SCALING float

[ImageAcquire] All the Y-axis scaling values available. A value of ‘1.0’ is equivalent to 100% scaling. Do not use values less than or equal to zero. ICAP_YSCALING

ZOOM_FACTOR short

[Device] Camera lens zooming. ICAP_ZOOMFACTOR

# (constant) PdfDocumentSecurityLevel :number

Enum for PDF Protection encryption level.

Type:
  • number
Properties
Name Type Description
NONE number

No encryption.

ENCRYPTED_40BIT number

40 bit encryption.

ENCRYPTED_128BIT number

128 bit encryption.

# (constant) TWDeviceName :string

Enum for TWDeviceName.

Type:
  • string
Properties
Name Type Description
DEFAULT string

Current default device name will be used.

SELECT_FROM_UI string

User will be prompted to select a device.

# (constant) TWDownloadMode :string

Enum for TWAIN JS Download Mode.

Type:
  • string
Properties
Name Type Description
LOCAL string

File will be downloaded to the client in the location specified by the client settings.

STANDARD string

File will be downloaded using the standard browser download dialog.

# (constant) TWEvent :string

Enum for TW TWAIN JS Events.

Type:
  • string
Properties
Name Type Description
SOCKET_CONNECTION_STATUS_CHANGED string

Connection status changes.

DEVICE_LIST_RETRIEVED string

Device list is retrieved.

DEVICE_INFO_RETRIEVED string

Device info is retrieved.

CURRENT_SETTINGS_RECEIVED string

Current settings are retrieved.

PAGE_SCANNED string

Page is scanned.

SCAN_FINISHED string

Scan has finished.

TW_ERROR string

Error occurred.

SINGLE_FILE_DOWNLOADED string

Single file has been downloaded.

DOWNLOAD_FINISHED string

Download has finished.

SINGLE_FILE_RETRIEVED string

Single file has been retrieved.

FILE_RETRIEVE_FINISHED string

Retrieve of file(s) has finished.

# (constant) TWJSConnectionStatus :object

Enum for TWAIN JS Connection Status.

Type:
  • object
Properties
Name Type Description
CONNECTING object

Connection is in progress.

CONNECTED object

Connection is established.

CLOSING object

Connection is in closing state.

CLOSED object

Connection is closed.

ERROR object

Connection is in error state.

Source:

# (constant) TWScanFinishedStatus :string

Enum for scan finished status.

Type:
  • string
Properties
Name Type Description
SUCCESS string

Scan finished successfully.

CANCELLED string

Scan was cancelled.

ERROR string

Scan failed.

Methods

# twConvertBinaryStringToUint8Array(binaryString) → {Uint8Array}

Converts a base64 encoded binary string to a Uint8Array.

Parameters:
Name Type Description
binaryString String

base64 encoded string

Returns:
Type
Uint8Array