Classes
Class | Description | |
---|---|---|
AsyncDeviceEvents |
Class that represent event of Twain source.
| |
AudibleAlarms |
Class that control's audio of twain device.
Turning on and off audiable alarms is done through Alarms capability and to control device’s audible alarm Volume should be called.
| |
AutomaticAdjustments |
Class that represents a collection of automatic adjustments capability.
Settings are to change page behavior.
To force the output image dimensions to match either the current value of ICAP_SUPPORTEDSIZES AutoSize should be called
or to discards blank pages AutoDiscardBlankPages;
| |
AutomaticCapture |
Class that represents automaticCapture capabilities supported by device.
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.
| |
AutomaticScanning |
These settings are intended to boost the performance of a Source. The fundamental assumption
behind AutomaticScanning is that the device is able to capture the number of images indicated by the value
of CAP_XFERCOUNT without waiting for the Application to request the image transfers.This is
only possible if the device has internal buffers capable of caching the images it captures.
| |
BarCodeDetection |
Class that represents BarCodeDetection capabilities supported by device.
MaxRetries restricts the number of times a search will be retried if none are found on each page.
Refine this capability to limit the number of times the bar code search algorithm is retried on a page that contains no bar codes.
BarCodeSearchPriorities restricts bar code searching to certain orientations, or prioritizes one orientation over the other.
Negotiate this capability if the orientation of bar codes is already known to the application. Refinement of this capability can
speed the bar code search.
| |
Caps |
Class that represents a collection of capability.
| |
Color |
Class that represent color capabilities. Filter describes the color characteristic of the subtractive filter
applied to the image data. Multiple filters may be applied to a single acquisition.
| |
Compression |
Class that represents a collection of capabilities (compression) supported by device.
Use JpegQuality capability as a shortcut to select JPEG quantization tables that tradeoff quality versus
compressed image size.
Used in concert with DAT_JPEGCOMPRESSION it is possible for an Application to obtain the tables that are
appropriate for varying percentages of quality within a given Source. TWJQ_UNKNOWN is a read-only value
(get or getCurrent), the Application cannot set the Source to this value. This value is reported if the
Application uses DAT_JPEGCOMPRESSION to select the quantization tables, and the Source is unable to resolve
those tables to a percentage value. The next three TWJQ_ values are intended as markers into the quality
range, and are only applicable with set method. get, getCurrent and getDefault only return values in the
range 0 - 100. If an Application wishes to map a TWJQ_ value to a corresponding value in the range 0 - 100,
then it must issue a get after a set with one of the three TWJQ_ values. No assumption is made about the
meaning of the range 0 - 99, it may be derived from the JPEG standard or it may be optimized for the Source's
device. 100, though, implies a lossless form of compression. Applications are not encouraged to use this
value since it results in poor compression, as well as a format that is not currently widely supported in
the industry.
TWJQ_UNKNOWN - read-only; must be the setting for this capability if the user sets the JPEG compression tables
using DAT_JPEGCOMPRESSION, and the Source is not able to map the selected tables to a specific percentage of quality.
TWJQ_LOW - write-only; implies low quality; the images are at the maximum compression recommended by the Source.
TWJQ_MEDIUM - write-only; implies medium quality; the images are at the balance point between good compression
and good images. This is an arbitrary setting on the part of the Source writer that is expected to best represent
their device. This is the value that Applications are most encouraged to use.
TWJQ_HIGH - write-only; implies high quality; the images display the maximum quality that produces any kind of
meaningful compression. Note that images at this setting are still considered to be lossy.
| |
Device |
Class that allows to manipulate TWAIN device.
| |
DoublefeedDetection |
Control DFD functionality.
| |
Duplex |
Class that allows to manipulate duplex.
To check if duplex is supported or is duplex one-path , two-path use Mode (TwCap.Duplex),to check if
duplex is enable use Enable (TwCap.DuplexEnabled).
| |
Feeder |
Class that allows to manipulate the automatic document feeder of TWAIN device.
Cap AutoFeed if TRUE, the Source will automatically feed the next page from the document feeder after the
frame negotiated for capture from each page are acquired.
CAP_FEEDERENABLED must be TRUE to use this capability.
| |
ImageAcquire |
Class that allows to manipulate image capability supported by device.
Allows an application to request the delivery of thumbnail representations for the set of images that are to be
delivered. Setting CAP_THUMBNAILSENABLED to TRUE turns on thumbnail mode.
Images transferred thereafter will be sent at thumbnail size (exact thumbnail size is determined by the Data Source).
Setting this capability to FALSE turns thumbnail mode off and returns full size images.
A successful set of this capability to TRUE will cause the Source to deliver image thumbnails during normal data
transfer operations. This mode remains in effect until this capability is set back to FALSE.
Application can use this capability to inquire, set, or restrict the values for BRIGHTNESS used in the Source.
| |
ImageInformation |
Class that contains information about image.
| |
ImageType |
Class that represents a collection of ImageType capabilities supported by device.
| |
ImprinterEndorser |
Allows the application to specify the starting endorser / imprinter number.
All other endorser/ imprinter properties should be handled through the data source's user interface.
The user can set the starting number for the endorser.
| |
Language |
Class that contains information about Language.
Allows application and source to identify which languages they have in common for the exchange of string data,
and to select the language of the internal UI.
Note: Since the TWLG_xxxx codes include language and country data,
there is no separate capability for selecting the country. In multi-lingual environments,
it is the responsibility of the Application to recall the last selected language for a given User.
| |
MICR |
Class that contains information about MICR.
If set to true check scanning is enabled.
| |
Page |
Class that allows to manipulate Pages segments as frames,MaxFrames,sizes.
Capability sizes 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.
| |
PatchCodeDetection |
Support for patch PatchCodeDetection.
| |
PowerMonitoring |
Class to manipulate capability power of device.
Use batteryPercentage with get method to indicate to the user about the battery power status,
if -1 is returned, it indicates that the battery is not present. It
is recomended to use PowerSupply to indentify the power source first.
| |
Resolution |
Class that allows to manipulate resolutions supported by device.
All the X-axis resolutions the Source can provide. Measured in units of pixels per unit as
defined by ICAP_UNITS (pixels per TWUN_PIXELS yields dimensionless data).
That is, when the units are TWUN_PIXELS, both ICAP_XRESOLUTION and ICAP_YRESOLUTION shall
report 1 pixel/pixel.
Some data sources like to report the actual number of pixels that the device reports, but
that response is more appropriate in ICAP_PHYSICALHEIGHT and ICAP_PHYSICALWIDTH.
Setting this value will restrict the various resolutions that will be available to the user during acquisition.
Applications will want to ensure that the values set for this ICAP match those set for ICAP_YRESOLUTION.
| |
Transfer |
Class that allows to manipulate with image transfer of Twain device.
To get supported transfers capability MECHANISMS should be called.
XferCount set this capability to the number of images you are willing to
transfer per session.
Common values are: 1 Application wishes to transfer only one image this
session -1 Application is willing to transfer multiple images.
| |
UserInterface |
Class that allows to manipulate with UserInterface of Twain device.
To allow an application to query a source to see if it implements the new user interface
settings dialog capability EnableDSUIOnly should be call.
To check if source supports preview UI CameraPreviewUI should return TRUE. However,
the application can choose to use the Source's UI or not even if the Source supports it.
|