ACS AET65 Application Programming Interface
  1. Manuals
  2. Brands
  3. ACS Manuals
  4. Card Reader
  5. AET65
  6. Application programming interface

ACS AET65 Application Programming Interface

Fingerprint reader
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Application Programming Interface
AET65
Fingerprint Reader
Application Programming Interface
idvation GmbH
Otto-Hesse-Straße 19 / T5
D-64293 Darmstadt
info@idvation.com
Phone +49 6151 9926567
Fax
+49 6151 3689296
www.idvation.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AET65 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for ACS AET65

Summary of Contents for ACS AET65

  • Page 1 Application Programming Interface AET65 Fingerprint Reader Application Programming Interface idvation GmbH Otto-Hesse-Straße 19 / T5 Phone +49 6151 9926567 D-64293 Darmstadt +49 6151 3689296 info@idvation.com www.idvation.com...
  • Page 2 • Based on UPEK’s BSAPI Reference Manual; Changed document filename to API_AET65_v1.0 August 6 2010 Melissa Balmes • Changed Title to AET65 Fingerprint Reader Application Programming Interface • Added Introduction • August 26 2010 Melissa Balmes Removed all details on BSSRV...

  • Page 3: Table Of Contents

    AET65 API Version 1.0 Table of Contents 1.0. Introduction ......................6 2.0. BSAPI ........................7 2.1. Terminology ........................... 7 2.2. Overview ..........................7 2.3. Architecture ..........................7 2.4. Naming Conventions ......................8 3.0. BSAPI.DLL Functions ..................... 9 3.1. General Description ....................... 9 3.1.1.
  • Page 4 AET65 API Version 1.0 4.2. GUI Customization ....................... 37 4.3. Default Callback Implementation ..................37 4.3.1. ABSDefaultCallback ....................37 4.4. ABS_DEFAULT_CALLBACK_CONTEXT ................38 4.5. Flags for ABS_DEFAULT_CALL BACK_CONTEXT .............. (ABS Default_CALLBACK_FLAG_xxxx) ................38 5.0. Declarations ......................39 5.1. Basic Types ......................... 39 5.2.
  • Page 5 8.7. ABS_CALLBACK and Threads.................... 84 8.8. Support for Terminal and Citrix .................... 84 Figures Figure 1: AET65 System Block Diagram ..................6 Figure 2: AET65 Connection ......................6 Page 5 of 84 idvation GmbH Otto-Hesse-Straße 19 / T5 Phone +49 6151 9926567...

  • Page 6: Introduction

    Version 1.0 1.0. Introduction The AET65 is a composite device, consisting of a smart card reader and a swipe fingerprint sensor. The smart card reader and the fingerprint sensor can be used independently, but combining the two technologies provide a higher level of security in applications. The AET65’s system diagram is shown below:...

  • Page 7: Bsapi

    AET65 API Version 1.0 2.0. BSAPI 2.1. Terminology • BSAPI – Biometric Services API • FM – fingerprint module (fingerprint reader device) connected to host • HOST – computer where the FM is connected to • BioAPI – the industry standard for biometric API, developed by BioAPI Consortium [www.bioapi.org].

  • Page 8: Naming Conventions

    AET65 API Version 1.0 Application developers can choose from several approaches on how to deal with the GUI: • Use BSGUI.DLL as it is, will guarantee appearance of the applications, consistent with their own applications. • Use BSGUI.DLL, with customized .zip file (some or all of the graphics in the .zip file can be modified or replaced with other graphics).

  • Page 9: Bsapi.dll Functions

    AET65 API Version 1.0 3.0. BSAPI.DLL Functions 3.1. General Description BSAPI.DLL provides a set of functions which can read data from supported fingerprint sensor devices, and which apply various biometric algorithms to these data. The main header file declaring functions of BSAPI is bsapi.h. The header includes bstypes.h and bserror.h which declare types and error status codes.

  • Page 10: Anti-Latent Checking

    AET65 API Version 1.0 including multiple biometric operations on one FM. If multiple threads call BSAPI.DLL function which communicates with FM, one of the calls is blocked (for caller it seems that the operation is still processing) and it is resumed after the thread communicating with the device is finished.

  • Page 11: Application General Functions

    AET65 API Version 1.0 3.2. Application General Functions The Application General Functions initialize the BSAPI library, open and close logical connections to FM, and perform other miscellaneous tasks. 3.2.1. ABSInitialize ABS_STATUS ABSInitialize( void Initialize the BSAPI library. BSAPI must be initialized before you can Description call any other function.

  • Page 12: Absopen

    AET65 API Version 1.0 3.2.4. ABSOpen ABS_STATUS ABSOpen( IN const ABS_CHAR *pszDsn OUT ABS_CONNECTION *phConnection Description Open a new session with a FM connected to this host. Parameters Zero-terminated ASCII string describing the FM connection pszDsn parameters. Resulting connection handle. At the end of the connection it should phConnection be closed with ABSClose.

  • Page 13: Absclose

    AET65 API Version 1.0 3.2.5. ABSClose ABS_STATUS ABSClose( IN ABS_CONNECTION hConnection Close a connection previously opened by ABSOpen. Description Parameters Connection handle of the connection to be closed hConnection Result code. ABS_STATUS_OK (0) means ABS_STATUS Return Value success. Every successful call of ABSOpen should be paired with a call to Remarks ABSClose.

  • Page 14: Absgetdeviceproperty

    AET65 API Version 1.0 3.2.7. ABSGetDeviceProperty ABS_STATUS ABSGetDeviceProperty( IN ABS_CONNECTION hConnection IN ABS_DWORD dwPropertyId OUT ABS_DATA **ppPropertyData Return data describing some property of device associated with the Description current open session. Parameters hConnection Handle to the connection to FM. One of ABS_DEVPROP_xxxx constants, specifying what device dwPropertyld property the caller is interested in.

  • Page 15: Biometric Functions

    AET65 API Version 1.0 3.3. Biometric Functions We will describe the biometric functions in this chapter. 3.3.1. ABSEnroll ABS_STATUS ABSEnroll( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation OUT ABS_BIR **ppEnrolledTemplate IN ABS_DWORD dwFlags Description Scan the live finger, process it into a fingerprint template and return it to the caller.

  • Page 16: Absverify

    AET65 API Version 1.0 3.3.2. ABSVerify ABS_STATUS ABSVerify( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwTemplateCount IN ABS_BIR **pTemplateArray OUT ABS_LONG *pResult IN ABS_DWORD dwFlags Description This function captures sample from the FM, processes it into template and compares it with templates, specified by the pTemplateArray parameter and finds out the first template which matches the swiped finger.

  • Page 17: Absverifymatch

    AET65 API Version 1.0 3.3.3. ABSVerifyMatch ABS_STATUS ABSVerifyMatch( IN ABS_CONNECTION hConnection IN ABS_BIR *pEnrolledTemplate IN ABS_BIR *pVerificationTemplate OUT ABS_BOOL *pResult IN ABS_DWORD dwFlags Description Compares whether two given templates match or not. Parameters hConnection Handle to the connection to FM.

  • Page 18: Abscapture

    AET65 API Version 1.0 3.3.4. ABSCapture ABS_STATUS ABSCapture( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwPurpose OUT ABS_BIR **ppCapturedTemplate IN ABS_DWORD dwFlags This function captures sample for the purpose specified and creates Description a new fingerprint template from it.

  • Page 19: Abschecklatent

    AET65 API Version 1.0 3.3.5. ABSCheckLatent ABS_STATUS ABSCheckLatent( IN ABS_CONNECTION hConnection IN void *pReserved OUT ABS_BOOL *pboIsLatent IN ABS_DWORD dwFlags Perform anti-latent check. Note that ABSEnroll and ABSVerify perform the check implicitly unless disabled with global parameter ABS_PARAM_LATENT_CHECK, so you should not call this...

  • Page 20: Absnavigate

    AET65 API Version 1.0 3.3.6. ABSNavigate ABS_STATUS ABSNavigate( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwFlags Switch FM to navigation mode (a.k.a. biometric mouse). Not all devices support this mode. If the navigation is not supported by the device, ABS_STATUS_NOT_SUPPORTED is returned.

  • Page 21: Image Grabbing Functions

    AET65 API Version 1.0 3.4. Image Grabbing Functions There are 4 functions for retrieving fingerprint image from the sensor, each having its advantages and disadvantages. Here we summarize their differences among the functions, in order to give you enough information to select the right one to fulfill your task.

  • Page 22: Idvation Gmbh

    AET65 API Version 1.0 Return Value ABS_STATUS Result code. ABS_STATUS_OK (0) means success. Page 22 of 84 Page 22 of 84 idvation GmbH Otto-Hesse-Straße 19 / T5 Phone +49 6151 9926567 Document Title Here D-64293 Darmstadt +49 6151 3689296 info@idvation.com...

  • Page 23: Absrawgrab

    AET65 API Version 1.0 3.4.2. ABSRawGrab ABS_STATUS ABSRawGrab( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwProfileSize IN ABS_PROFILE_DATA *pProfileData OUT ABS_IMAGE **ppImage OUT ABS_SWIPE_INFO **ppSwipeInfo IN ABS_DWORD dwFlags Description Grabs image sample from the FM. This function is similar to ABSGrab, but it is more low level.

  • Page 24: Abslistimageformats

    AET65 API Version 1.0 dwFlags Bitmask specifying flags, which modify slightly behavior of the function. Only flag ABS_FLAG_STRICT_PROFILE is supported. By default the profile data are respected to the degree possible i.e. those which are not supported by the device are silently ignored. In...

  • Page 25: Absgrabimage

    AET65 API Version 1.0 3.4.4. ABSGrabImage ABS_STATUS ABSGrabImage( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwPurpose IN ABS_IMAGE_FORMAT *pImageFormat OUT ABS_IMAGE **ppImage OUT ABS_SWIPE_INFO **ppSwipeInfo IN void *pReserved IN ABS_DWORD dwFlags Description Grabs image sample from the FM. Please note that unless an error occurs or it is canceled with ABSCancelOperation, the grab operation is automatically repeated until an image of some minimal quality is provided.

  • Page 26: Absrawgrabimage

    AET65 API Version 1.0 3.4.5. ABSRawGrabImage ABS_STATUS ABSRawGrabImage( IN ABS_CONNECTION hConnection IN ABS_OPERATION *pOperation IN ABS_DWORD dwProfileSize IN ABS_PROFILE_DATA *pProfileData IN ABS_IMAGE_FORMAT *pImageFormat OUT ABS_IMAGE **ppImage OUT ABS_SWIPE_INFO **ppSwipeInfo IN void *pReserved IN ABS_DWORD dwFlags Description Grabs image sample from the FM. This function is similar to ABSGrabImage, but it is more low level.

  • Page 27: Idvation Gmbh

    AET65 API Version 1.0 dwFlags Bitmask specifying flags, which modify slightly, the behavior of the function. Only flag ABS_FLAG_STRICT_PROFILE is supported. By default the profile data are respected to the degree possible i.e. those which are not supported by the device are silently ignored. In...

  • Page 28: Miscellaneous Functions

    AET65 API Version 1.0 3.5. Miscellaneous Functions 3.5.1. ABSCancelOperation ABS_STATUS ABSCancelOperation( IN ABS_CONNECTION hConnection IN ABS_DWORD dwOperationID Description Cancels a running interactive operation. Function of the canceled operation returns ABS_STATUS_CANCELED. Parameters hConnection Handle to the connection to FM. dwOperationID ID of the operation to be canceled, or zero to cancel the currently processed operation in the current thread.

  • Page 29: Absgetappdata

    AET65 API Version 1.0 3.5.3. ABSGetAppData ABS_STATUS ABSGetAppData( IN ABS_CONNECTION hConnection OUT ABS_DATA **ppAppData Description Retrieves the data stored on the FM. See also description of function SetAppData. Parameters hConnection Handle to the connection to FM. ppAppData Output parameter, to be set to the newly allocated structure ABS_DATA.

  • Page 30: Absgetsessionparameter

    AET65 API Version 1.0 3.5.5. ABSGetSessionParameter ABS_STATUS ABSGetSessionParameter( IN ABS_CONNECTION hConnection IN ABS_DWORD dwParamID OUT ABS_DATA **ppParamValue Description Retrieves value of session-wide parameter. Please note that in the current version all parameters are global and can be set only with ABSSetGlobalParameter(). Therefore this function returns ABS_STATUS_INVALID_PARAMETER as it does not support any dwParamID value currently.

  • Page 31: Idvation Gmbh

    AET65 API Version 1.0 Return Value ABS_STATUS Result code. ABS_STATUS_OK (0) means success. Page 31 of 84 Page 31 of 84 idvation GmbH Otto-Hesse-Straße 19 / T5 Phone +49 6151 9926567 Document Title Here D-64293 Darmstadt +49 6151 3689296 info@idvation.com...

  • Page 32: Absgetglobalparameter

    AET65 API Version 1.0 3.5.7. ABSGetGlobalParameter ABS_STATUS ABSGetGlobalParameter( IN ABS_DWORD dwParamID OUT ABS_DATA **ppParamValue Description Retrieves value of global-wide parameter. Parameters dwParamID parameter retrieve. description ABS_PARAM_xxxx constants. pParamValue Output parameter for the retrieved value. The function sets it to point to newly allocated ABS_DATA.

  • Page 33: Abssetled

    AET65 API Version 1.0 3.5.8. ABSSetLED ABS_STATUS ABSSetLED( IN ABS_CONNECTION hConnection IN ABS_DWORD dwMode IN ABS_DWORD dwLED1 IN ABS_DWORD dwLED2 Description This function allows the application to control the state and behavior of the two user interface LEDs, which can be optionally connected to the FM.

  • Page 34: Absgetled

    AET65 API Version 1.0 Remarks The default status of LEDs after FM boot is a manual mode (dwMode = 0), with both LEDs off. When a connection (session) is closed, the LEDs will keep the last status they had. If the LEDs were blinking, they will keep blinking.

  • Page 35: Absbinarizesampleimage

    AET65 API Version 1.0 3.5.10. ABSBinarizeSampleImage ABS_STATUS ABSBinarizeSampleImage( INOUT ABS_IMAGE *pGrayScaleImage OUT ABS_IMAGE **ppBinarizedImage Description The function converts gray-scale image (as obtain from callback, ABSGrab or ABSRawGrab) to binarized form, with only two colors. I.e. the binarized image sample has ColorCount set to 2. The two colors are then interpreted as black (1) and white (0).

  • Page 36: Absgetlasterrorinfo

    AET65 API Version 1.0 3.5.11. ABSGetLastErrorInfo void ABSGetLastErrorInfo( OUT ABS_DWORD *pErrorCode OUT const ABS_CHAR **ppErrorMessage Description Retrieves additional information about last BSAPI error, which occurred in the current thread. Please note that information provided by this function is not intended to be displayed to the end user.

  • Page 37: Bsgui.dll Functions

    AET65 API Version 1.0 4.0. BSGUI.DLL Functions 4.1. Using BSGUI.DLL BSGUI.DLL provides a default ABS_CALLBACK implementation for BSAPI.DLL. To use the default callback implementation, link your application with both BSAPI.DLL and BSGUI.DLL. Therefore, whenever any interactive operation is started, set member Callback of structure ABS_OPERATION to pointer to function ABSDefaultCallback from BSGUI.DLL.

  • Page 38: Abs_Default_Callback_Context

    AET65 API Version 1.0 4.4. ABS_DEFAULT_CALLBACK_CONTEXT Structure to be optionally passed as a context data into ABSDefaultCallback. This allows tuning of exact behavior of the default callback implementation. To use it, setup the structure members and set Context of ABS_OPERATION to address of the structure.

  • Page 39: Declarations

    AET65 API Version 1.0 5.0. Declarations 5.1. Basic Types typedef char ABS_CHAR Signed integer type (1 byte) typedef unsigned char ABS_BYTE Unsigned integer type (1 byte) typedef short ABS_SHORT Signed integer type (2 bytes) typedef unsigned short ABS_WORD Unsigned integer type (2 bytes)

  • Page 40: Abs_Bir_Header

    AET65 API Version 1.0 5.2.2. ABS_BIR_HEADER This is the header of the BIR. This type is equivalent to BioAPI's structure BioAPI_BIR_HEADER. In the typical use the BIR is handled as an opaque data, it is not necessary to know the structure of its header.

  • Page 41: Abs_Bir

    AET65 API Version 1.0 5.2.3. ABS_BIR This is a container for biometric data. The abbreviation BIR stands for Biometric Identification Record. In BSAPI it represents a fingerprint template, but potentially can contain other data as well, e.g. audit data. BIR consists of a header, followed by the opaque data and optionally by a signature.

  • Page 42: Abs_Operation

    AET65 API Version 1.0 5.2.4. ABS_OPERATION Holds common data used by all interactive operation functions. typedef struct abs_operation { ABS_DWORD OperationID; void* Context; ABS_CALLBACK Callback; ABS_LONG Timeout; ABS_DWORD Flags; } ABS_OPERATION Description OperationID Unique operation ID or zero. When set to non-zero, the value identifies the operation. You can then use the ID to cancel the operation with ABSCancel-Operation, even from other thread.

  • Page 43: Abs_Profile_Data

    AET65 API Version 1.0 5.2.5. ABS_PROFILE_DATA Profile data for tuning raw grab operation (ABSRawGrab). This allows setting of various special modes and attributes of the raw grab, including various FM dependent ones. Function ABSRawGrab takes pointer to array of structure ABS_PROFILE_DATA. (Other parameter specifies number of items in the profile array.) Each record in the array is composed of key-value pair.

  • Page 44: Idvation Gmbh

    AET65 API Version 1.0 MsgID Quality feedback message ID. Depending on the settings of the raw grab profile, various tests quality checks can be processed during the raw grab operation. If all the tests pass successfully (or if all of them are disabled) MsgId is set to ABS_MSG_PROCESS_SUCCESS.

  • Page 45: Abs_Image_Format

    AET65 API Version 1.0 5.2.7. ABS_IMAGE_FORMAT Type ABS_IMAGE_FORMAT describes desired image format for functions ABSGrabImage and AB- SRawGrabImage. Use function ABSListImageFormats to retrieve list of available formats. The resolution is always in DPI (dots per inch). Scan resolution is a resolution of the sensor during the scan.

  • Page 46: Abs_Image

    AET65 API Version 1.0 5.2.8. ABS_IMAGE Type ABS_IMAGE holds data representing one sample image of swiped finger. Functions ABSCapture, ABSGrab and ABSRawGrab use this structure. Also certain messages sent to ABS_CALLBACK can have sample image in form of this structure passed as additional data.

  • Page 47: Abs_Process_Data

    AET65 API Version 1.0 5.2.9. ABS_PROCESS_DATA This structure is a container for additional data associated with ABS_MSG_PROCESS_xxxx messages sent to callback of an interactive operation. Note that some message ABS_MSG_PROCESS_xxxx use more specific structure, however all are binary compatible with ABS_PROCESS_DATA i.e. pointer to them can be safely cast to pointer to ABS_PROCESS_DATA.

  • Page 48: Abs_Process_Success_Data

    AET65 API Version 1.0 5.2.12. ABS_PROCESS_SUCCESS_DATA This structure is a container for additional data associated with ABS_MSG_PROCESS_SUCCESS message sent to callback of an interactive operation. typedef struct abs_process_success_data { ABS_DWORD ProcessID; ABS_IMAGE* SampleImage; ABS_BIR* Template; } ABS_PROCESS_SUCCESS_DATA Description Process ID ID of process stage.

  • Page 49: Abs_Device_List

    AET65 API Version 1.0 5.2.15. ABS_DEVICE_LIST The format of the data returned by ABSEnumerateDevices, it contains info about all enumerated devices. Please note, that the real output parameter from ABSEnumerateDevices has variable length – array List[] has NumDevices items. typedef struct abs_device_list { ABS_DWORD NumDevices;...

  • Page 50: Abs_Callback

    AET65 API Version 1.0 5.2.16. ABS_CALLBACK void ABS_CALLBACK( IN const ABS_OPERATION *pOperation IN ABS_DWORD dwMsgID IN void *pMsgData Page 50 of 84 Page 50 of 84 idvation GmbH Otto-Hesse-Straße 19 / T5 Phone +49 6151 9926567 Document Title Here D-64293 Darmstadt +49 6151 3689296 info@idvation.com...

  • Page 51: Idvation Gmbh

    AET65 API Version 1.0 Description A type of the callback functions that an application can supply to the BSAPI to enable itself to display GUI state information to user. The callback is passed into the BSAPI function of interactive operations...

  • Page 52: Idvation Gmbh

    AET65 API Version 1.0 dwMsgData ID of message. See description of ABS_MSG_xxxx constants. pMsgData Pointer to data with additional information related with the message. Its meaning is message dependent. Refer to the documentation of the specific BS_MSG_xxxx constants. Page 52 of 84...

  • Page 53: Specific Constants

    AET65 API Version 1.0 6.0. Specific Constants 6.1. Flags for ABSInitializeEx (ABS_INIT_FLAG_xxxx) The following flags can be used in function ABSInitializeEx. ABS_INIT_FLAG_NT_SERVICE Initializes the library in a mode compatible with Windows NT service. This mode is supported only on MS Windows. You should use this flag only when your application is running as NT service.

  • Page 54: Flags For Biometric And Image Grabbing Functions (Abs_Flag_Xxxx)

    AET65 API Version 1.0 6.3. Flags for Biometric and Image Grabbing Functions (ABS_FLAG_xxxx) The following flags can be used for biometric functions. Note that not all functions accept all flags. See documentation of respective function for more information. ABS_FLAG_NOTIFICATION Enables notification mode of the biometric operation.

  • Page 55: Template Purpose Constants (Abs_Purpose_Xxxx)

    AET65 API Version 1.0 6.4. Template Purpose Constants (ABS_PURPOSE_xxxx) Possible values used where purpose of fingerprint template (BIR) Biometric functions which take purpose as one of their parameter can use this information to optimize operation processing. For example enrollment usually requires a higher template quality, so built-in biometric tests for template quality are stricter when ABS_PURPOSE_ENROLL is specified.

  • Page 56: Key Constants For Abs_Profile_Data (Abs_Pkey_Xxxx)

    AET65 API Version 1.0 6.5. Key Constants for ABS_PROFILE_DATA (ABS_PKEY_xxxx) Constants ABS_PKEY_xxxx are possible values for member Key of: ABS_PKEY_WAIT_FOR_ACCEPTABLE Disables default one-attempt approach of ABSRawGrab. When set to zero (default), ABSRawGrab lets the user swipe only once. If the quality checks are unsatisfied and thus no image is retrieved, the function still returns ABS_STATUS_OK and NULL is passed through the output parameter ppImage.

  • Page 57: Idvation Gmbh

    AET65 API Version 1.0 ABS_PKEY_REC_TERMINATION_POLICY Specifies image reconstruction termination policy. It can be any ABS_PVAL_RTP_xxxx constant. It determines when the FM stops to scan the finger. Default value depends on the FM model used: • TFM 2.0: ABS_PVAL_RTP_CORE • ESS 2.1: ABS_PVAL_RTP_CORE •...

  • Page 58: Idvation Gmbh

    AET65 API Version 1.0 ABS_PKEY_REC_FLAG_GRADIENT Enables gradient compensation algorithm. When set to non-zero, the algorithm is enabled. When zero, it is disabled. Supported only by TCD 50. ABS_PKEY_REC_SWIPE_DIRECTION Specifies swipe direction mode. ABS_PVAL_SWIPEDIR_xxxx constant. default value ABS_PVAL_SWIPEDIR_STANDARD. If you set it to any non-default value you should set ABS_PKEY_SCAN_QUALITY_QUERY to zero as well.

  • Page 59: Idvation Gmbh

    AET65 API Version 1.0 ABS_PKEY_SENSOR_SECURITY_MODE Sensor security mode. It specifies whether (and how) are encrypted communication data sent between the FM sensor and chipset or computer which processes them. It can be set to any ABS_PVAL_SSM_xxxx constant. For SONLY the default mode is ABS_PVAL_SSM_ENCRYPT (the data are sent from sensor to the computer), for other FM models (where the data stay in the FM device) the default is ABS_PVAL_SSM_DISABLED.

  • Page 60: Abs_Pkey_Image_Format Values (Abs_Pval_Ifmt_Xxxx)

    AET65 API Version 1.0 6.6. ABS_PKEY_IMAGE_FORMAT Values (ABS_PVAL_IFMT_xxxx) Possible image formats. Please note that the desired image format is always evaluated in a strict mode of raw grab profile. Note that the symbolic constant names contain some marginal parameters of the desired format: horizontal and vertical resolution in dots per inch (DPI), bits per pixel (they determine color count of the resulted sample image).

  • Page 61: Idvation Gmbh

    AET65 API Version 1.0 ABS_PVAL_IFMT_254_254_4 Grab the whole finger with 1:2 sub-sampling (254 x 254 DPI, 8 bits), and cut off to 4 bits per pixel. Supported by ESS only. ABS_PVAL_IFMT_508_508_8_WIDTH208 Grabs centered windows of size 208 x 288 pixels, in full resolution of 508 x 508 DPI and 8 bits/pixel.

  • Page 62: Idvation Gmbh

    AET65 API Version 1.0 ABS_PVAL_IFMT_508_508_8_COMPRESS2 Grab the whole finger in full resolution (508 DPI), 8 bits per pixel. Supported by ESS 2.2. ABS_PVAL_IFMT_381_381_8_SCAN381 Grab the whole finger with 3:4 sub-sampling (every 4 pixels scaled down to 3 pixels, 381 x 381 DPI), 8 bits/pixel.

  • Page 63: Idvation Gmbh

    AET65 API Version 1.0 ABS_PVAL_IFMT_381_381_8_BINARIZED_VLP Grab the whole finger with 3:4 sub-sampling (every 4 pixels scaled down to 3 pixels, 381 x 381 DPI), 8 bits/pixel, and binarize to 1 bit/pixel, uses very low power consumption mode. Supported by ESS 2.2 with serial connection not faster than 57600 kbps.

  • Page 64: Abs_Pkey_Rec_Termination_Policy Values (Abs_Pval_Rtp_Xxxx)

    AET65 API Version 1.0 ABS_PVAL_IFMT_508_254_4_LP Supported by TCD 50. ABS_PVAL_IFMT_381_381_8_FAST_LP Supported by TCD 50. ABS_PVAL_IFMT_381_381_4_FAST_LP Supported by TCD 50. ABS_PVAL_IFMT_381_381_8_BINARIZED_FAST_LP Supported by TCD 50. 6.7. ABS_PKEY_REC_TERMINATION_POLICY Values (ABS_PVAL_RTP_xxxx) See description of ABS_PKEY_REC_TERMINATION_POLICY for more information. ABS_PVAL_RTP_BASIC Basic image reconstruction termination policy.

  • Page 65: Abs_Pkey_Rec_Swipe_Direction Values (Abs_Pval_Swipedir_Xxxx)

    AET65 API Version 1.0 6.8. ABS_PKEY_REC_SWIPE_DIRECTION Values (ABS_PVAL_SWIPEDIR_xxxx) See description of ABS_PKEY_REC_SWIPE_DIRECTION for more information. ABS_PVAL_SWIPEDIR_STANDARD Standard swipe direction. ABS_PVAL_SWIPEDIR_INVERTED Inverted swipe direction. ABS_PVAL_SWIPEDIR_AUTODETECT Auto-detection at the beginning of the swipe. ABS_PVAL_SWIPEDIR_STANDARD_WARN Standard swipe direction with warning. If backward swipe is detected, message ABS_MSG_QUALITY_BACKWARD is sent to callback.

  • Page 66: Abs_Pkey_Sensor_Security_Mode Values (Abs_Pval_Ssm_Xxxx)

    AET65 API Version 1.0 6.10. ABS_PKEY_SENSOR_SECURITY_MODE values (ABS_PVAL_SSM_xxxx) See description of ABS_PKEY_SENSOR_SECURITY_MODE for more information. ABS_PVAL_SSM_DISABLED Sensor security mode is disabled. ABS_PVAL_SSM_ENCRYPT Sensor security is set to 'encryption' mode. ABS_PVAL_SSM_SIGN_ALL Sensor security is set to 'sign all' mode. ABS_PVAL_SSM_SIGN_PARTIAL_V1 Sensor security is set to 'sign partial ver. 1'.

  • Page 67: Swipe Info Flags (Abs_Swipe_Flag_Xxxx)

    AET65 API Version 1.0 6.11. Swipe Info Flags (ABS_SWIPE_FLAG_xxxx) Member Flags of structure ABS_SWIPE_INFO is a bitmask describing various attributes of user's swipe in ABSRawGrab. ABS_SWIPE_FLAG_TOO_FAST 0x01 The swipe was too fast. If user swipes too fast, the device is not able to process all the data.

  • Page 68: Process Constants (Abs_Process_Xxxx)

    AET65 API Version 1.0 6.12. Process Constants (ABS_PROCESS_xxxx) These constants identify interactive operation processes. Structures ABS_PROCESS_DATA, ABS_PROCESS_BEGIN_DATA ABS_PROCESS_SUCCESS_DATA have member called Process which identifies the stage the operation enters. Some high level biometric operations consist of multiple processes. Generally the interactive operation is composed from tree of processes.

  • Page 69: Idvation Gmbh

    AET65 API Version 1.0 28. ABS_MSG_PROCESS_BEGIN (ProcessID = ABS_PROCESS_GRAB) 29..messages leading the user to correctly swipe his finger 30. ABS_MSG_PROCESS_END (end of ABS_PROCESS_GRAB) 31. ABS_MSG_PROCESS_PROGRESS (Percentage=88%) 32. ABS_MSG_PROCESS_END (end of ABS_PROCESS_CAPTURE) 33. ABS_MSG_PROCESS_BEGIN (ProcessID = ABS_PROCESS_CAPTURE) 34. ABS_MSG_PROCESS_BEGIN (ProcessID = ABS_PROCESS_GRAB) 35.

  • Page 70: Idvation Gmbh

    AET65 API Version 1.0 ABS_PROCESS_MATCH Process of matching template against set of templates. ABS_PROCESS_GRAB Process of sample image grab from scanner. It's relatively low level process retrieving a fingerprint sample image from the sensor. ABS_PROCESS_NOTIFY Process of notification. This process is used by functions which allow notification mode (see ABS_FLAGF_NOTIFICATION).

  • Page 71: Device Property Constants (Abs_Devprop_Xxxx)

    AET65 API Version 1.0 6.13. Device Property Constants (ABS_DEVPROP_xxxx) The following constants are suitable as values for dwPropertyId parameter: ABS_DEVPROP_DEVICE_VERSION Identifies version of the FM device ROM. Output ABS_DATA contains 4 bytes, interpreted as ABS_DWORD. Highest byte specifies major version, second highest byte specifies minor version and low word specifies subversions/revisions.

  • Page 72: Session And Global Parameter Constants (Abs_Param_Xxxx)

    AET65 API Version 1.0 6.14. Session and Global Parameter Constants (ABS_PARAM_xxxx) These constants identify each parameter and can be used as value of parameter dwParamID of ABS- SetSessionParameter and ABSGetSessionParameter (for session parameters) functions, or ABSSet- GlobalParameter and ABSGetGlobalParameter (for global parameters).

  • Page 73: Idvation Gmbh

    AET65 API Version 1.0 ABS_PARAM_POWER_SAVE_TIMEOUT Determines for how long time the user is considered to be active after touching sensor, or using keyboard or mouse. It has effect to power management only if ABS_PARAM_POWER_SAVE_MODE is set to 2. Value is represented as ABS_DATA with 4 bytes of length. The value is interpreted as ABS_DWORD, determining number of seconds.

  • Page 74: Idvation Gmbh

    AET65 API Version 1.0 ABS_PARAM_IFACE_VERSION Read-only global parameter which determines version of BSAPI interface. Value is represented as ABS_DATA with 1 byte of length. This version of BSAPI uses version 2 of the interface. Note that corresponding versions of BSAPI.DLL always get the same value of this parameter.

  • Page 75: Parameter Abs_Param_Consolidation_Type Values

    AET65 API Version 1.0 6.15. Parameter ABS_PARAM_CONSOLIDATION_TYPE Values (ABS_CONSOLIDATION_xxxx) These constants are intended as possible values of parameter: ABS_CONSOLIDATION_NORMAL Normal consolidation algorithm is used. Enrollment template is constructed either from a subset of collected templates, or it uses one (the best) of provided templates.

  • Page 76: Parameter Abs_Param_Antispoofing_Policy Values

    AET65 API Version 1.0 6.17. Parameter ABS_PARAM_ANTISPOOFING_POLICY Values (ABS_ANTISPOOFING_xxxx) These constants are intended as possible values of parameter: ABS_ANTISPOOFING_DISABLED Anti-spoofing checks are explicitly turned off on the fingerprint sensor. This is default value. ABS_ANTISPOOFING_AUTODETECT Anti-spoofing checks are explicitly turned on on the fingerprint sensor if the device supports it.

  • Page 77: Idvation Gmbh

    AET65 API Version 1.0 ABS_MSG_PROCESS_SUSPEND 0x13000000 Execution of the interactive operation has been suspended. It happens when some other operation (with the same or higher priority) acquires the sensor. After this interrupting operation finishes, the process is resumed again. pMsgData points to additional data stored in structure ABS_PROCESS_DATA.

  • Page 78: Idvation Gmbh

    AET65 API Version 1.0 ABS_MSG_PROMPT_CLEAN 0x25000000 Callback should prompt the user to clean the sensor. pMsgData is always NULL. ABS_MSG_QUALITY 0x30000000 Swipe quality is low. Note that if possible BSAPI sends more specific ABS_MSG_QUALITY_xxxx messages, this message is sent only when no more specific message is appropriate.

  • Page 79: Idvation Gmbh

    AET65 API Version 1.0 ABS_MSG_QUALITY_TOO_DRY 0x31220000 Swipe quality is low. The swipe is too dry. pMsgData is always NULL. ABS_MSG_QUALITY_TOO_SMALL 0x31230000 Swipe quality is low. The swipe is too small. pMsgData is always NULL. ABS_MSG_QUALITY_TOO_SHORT 0x32000000 Swipe quality is low. The swipe is too short.

  • Page 80: Idvation Gmbh

    AET65 API Version 1.0 ABS_MSG_DLG_SHOW 0x51000000 Notifies that the feedback dialog should be shown. pMsgData is always NULL. ABS_MSG_DLG_HIDE 0x52000000 Notifies that the feedback dialog should be hidden. pMsgData is always NULL. ABS_MSG_IDLE Special message, which gives the callback a chance to cancel the interactive operation. pMsgData is always NULL.

  • Page 81: List Of Defined Result Codes

    AET65 API Version 1.0 7.0. List of Defined Result Codes The following result codes can be returned as the PT_STATUS values. Success returns status. ABS_STATUS_OK General, unknown, or unspecified error. ABS_STATUS_GENERAL_ERROR (-5001) Internal error. ABS_STATUS_INTERNAL_ERROR (-5002) BSAPI has been already initialized.

  • Page 82: New Features In Version 3.5

    AET65 API Version 1.0 8.0. New Features in Version 3.5 8.1. Global Parameter ABS_PARAM_IFACE_VERSION New global parameter ABS_PARAM_IFACE_VERSION was added, which allows the caller to detect the interface of the BSAPI because version 3.5 of BSAPI brings one incompatibility with previous version: dynamic enrollment (see below).

  • Page 83: Image Grabbing Functions

    AET65 API Version 1.0 Member ProcessID structures ABS_PROCESS_DATA, ABS_PROCESS_BEGIN_DATA, ABS_PROCESS_PROGRESS_DATA and ABS_PROCESS_SUCCESS_DATA is never set to the value. The constant is kept in bstypes.h header for backward compatibility of application source codes which might use it. 8.3. Image Grabbing Functions 8.3.1.

  • Page 84: Compatibility With Windows Nt Services

    AET65 API Version 1.0 8.6. Compatibility with Windows NT Services Since version 3.5 BSAPI.DLL provides new function ABSInitializeEx, taking a bitmask flags as its only parameter. This function can be (on Windows platform) used to initialize in a mode compatible with Windows NT service.

Table of Contents