com.upek.android.ptapi
Interface PtConnectionI

All Known Subinterfaces:
PtConnectionAdvancedI
All Known Implementing Classes:
PtConnection

public interface PtConnectionI

PTAPI connection interface.


Method Summary
 void authentify(int authentifyId, byte[] key)
          Authentifies the caller (host) to the FM, allow access to FM functions.
 void authentifyAdv(int accountId, byte[] wrappedProfile, byte[] authKey, byte[] publicKey, int mechanism, int keyLength, int flags, int version)
          Authentifies the caller (host) to the specific FM account allowing access to functions enabled for that account.
 void authentifyEx(int accountId, byte[] key)
          Authentifies the caller (host) to the specific FM account allowing access to functions enabled for that account.
 void calibrate(int type)
          Calibrates the fingerprint sensor to suite best to the given user.
 void cancel(int flags)
          Cancels currently running PTAPI command.
 void capture(byte purpose, PtBirArgI capturedTemplate, int timeout, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Scans the live finger and processes it into a template.
 void close()
          Closes the connection previously opened by open().
 void closeDevice()
          Closes connection interface, if communication session is still opened it is automatically closed.
 void closeSession()
          Closes communication session, device interface remains open.
 PtBir convertTemplate(PtInputBir inputBIR, int targetType, boolean returnPayload)
          Converts template to format currently set in session configuration.
 byte[] convertTemplateEx(int sourceType, int sourceEnvelope, byte[] inputData, int targetType, int targetEnvelope, byte[] supplementaryData, int flags)
          Converts template to specified format including standard ANSI/ISO formats.
 void deleteAllFingers()
          Deletes all fingerprint templates stored in slots in the non-volatile memory of the FM.
 void deleteFinger(int slotNr)
          Deletes fingerprint template stored in the selected slot in the non-volatile memory of the FM.
 void detectFingerEx(int timeout, int flags)
          Verifies, if there is a finger on the sensor.
 void enroll(byte purpose, PtInputBir storedTemplate, PtBirArgI newTemplate, IntegerArgI slotNr, byte[] payload, int timeout, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Scans the live finger once or several times, depending on the session settings, and combines the images into one enrollment template.
 PtExtendedInfo extendedInfo()
          Returns an additional information about the TFM/ESS.
 void formatInternalNVM(int nvmVersion, byte[] fsParams, byte[] nvmParams)
          Formats internal NVM for SONLY device.
 byte[] getAccessRights(int accountId)
          Gets access rights mask of given account
 byte[] getAppData(int area)
          Reads the application data stored in TFM's non-volatile memory.
 int getAvailableMemory(int type)
          Returns the size in bytes of the remaining EEPROM memory on the TFM available for application's usage.
 byte[] getFingerData(int slotNr)
          Reads the additional appliciation data associated with a finger template stored in FM's non-volatile memory.
 PtImgFormat getImageFormat(int operation)
          Gets current value of image format set for image acquiring or navigation operations.
 void getLED(IntegerArgI mode, IntegerArgI led1, IntegerArgI led2)
          Queires the state and behavior of the two user interface LEDs, which can be optionally connected to the TFM.
 java.lang.Object getSessionCfgEx(short cfgVersion)
          Gets the current session parameters of the TFM.
 void getSwipeInfo(PtSwipeInfoArgI swipeInfo, ByteArrayArgI skewInfo, ByteArrayArgI speedInfo)
          Returns information about last finger swipe
 byte[] grab(byte type, int timeout, boolean waitForAcceptableFinger, byte[] signData, ByteArrayArgI signature)
          Scans the live finger and returns the scanned image.
 byte[] grabWindow(byte compressionType, int timeout, boolean waitForAcceptableFinger, int rows, int rowOffset, int rowDelta, int cols, int colOffset, int colDelta, byte[] signData, ByteArrayArgI signature)
          Scans the live finger and returns the scanned image.
 short identifyMatchOnHost(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtInputBir capturedTemplate, PtInputBir[] storedTemplates, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload, PtMatchOnHostParams matchParams)
          Matches the supplied captured template against supplied list of enrollment templates.
 PtInfo info()
          Returns a set of information about the connection and the TFM, including the version of TFM.
 boolean isStrongEncryptionEnabled()
          Tests, whether strong ecnryption is enabled on opened device.
 PtFingerListItem[] listAllFingers()
          Returns list of all fingers stored in the FM's non-volatile memory together with their associated application data.
 PtBir loadFinger(int slotNr, boolean returnPayload)
          Reads template data stored in given slot.
 void navigate(int eventPeriod, PtNavigationCallback callback, byte[] postprocessingParams)
          Switches FM to navigation mode (a.k.a. biometric mouse).
 void navigateWithSleep(int eventPeriod, int idleTimeout, PtNavigationCallback callback, byte[] postprocessingParams)
          Switches FM to navigation mode (a.k.a. biometric mouse).
 void openSession(java.lang.String dsn)
          Opens communication session with TFM/ESS device.
 int scanQuality()
          Returns scan quality of last finger swipe
 void secureChannel(int mechanism, int keyLength, int flags)
          Establishes a secure channel for the given connection.
 void secureChannelEx(int mechanism, int keyLength, int flags, int version)
          Establishes a secure channel for the given connection.
 void setAppData(int area, byte[] appData)
          Stores a block of arbitrary binary data in TFM's non-volatile memory.
 void setFingerData(int slotNr, byte[] fingerData)
          Assigns an additional application data to a finger template stored in FM's non-volatile memory.
 void setFingerPayload(int slotNr, byte[] payload)
          Changes payload data of a finger template stored in TFM's non-volatile memory.
 void setGUICallbacks(PtGuiStreamingCallback guiStreamingCallback, PtGuiStateCallback guiStateCallback)
          Sets the references to the callback routines to be called if any called function involves displaying a biometric user interface.
 void setImageFormat(int operation, PtImgFormat format, int dataSections)
          Sets image format for following image acquiring or navigation operations.
 void setLED(int mode, int led1, int led2)
          Controls the state and behavior of the two user interface LEDs, which can be optionally connected to the TFM.
 void setSessionCfgEx(short cfgVersion, java.lang.Object sessionCfg)
          Sets the session parameters of the TFM.
 int sleep(int sleepMode, PtIdleCallback callback)
          Switches FM to deep sleep or standby mode.
 void sleepThenCapture(PtIdleCallback callback, byte purpose, int timeout, IntegerArgI wakeupCause, IntegerArgI captureGuiMessage, PtBirArgI capturedTemplate, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Switches FM to the standby (finger detect) mode.
 void sleepThenGrab(PtIdleCallback callback, byte grabType, int timeout, boolean assessImageQuality, IntegerArgI wakeupCause, IntegerArgI grabGuiMessage, ByteArrayArgI grabbedData, byte[] signData, ByteArrayArgI signature)
          Switches FM to the standby (finger detect) mode.
 int storeFinger(PtInputBir template)
          Stores given fingerprint template in the selected slot in the non-volatile memory of the TFM.
 byte[] transact(byte[] inPkt)
          Sends the request data packet to the FM, waits for a response and get the response data packet.
 void updateFingerPayload(int slotNr, int offset, byte[] data)
          Updates payload data of a finger template stored in TFM's non-volatile memory.
 boolean verify(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtInputBir storedTemplate, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload, int timeout, boolean capture, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Scans the live finger or uses the last captured finger data and tries to match it against the supplied enrollment template.
 int verifyAll(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload, int timeout, boolean capture, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Scans the live finger or uses the last captured finger data and tries to match it against the templates stored in TFM's non-volatile memory.
 short verifyEx(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtInputBir[] storedTemplates, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload, int timeout, boolean capture, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature)
          Scans the live finger or uses the last captured finger data and tries to match it against the set of supplied enrollment templates.
 boolean verifyMatch(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtInputBir capturedTemplate, PtInputBir storedTemplate, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload)
          Matches the supplied captured template against the supplied enrollment template.
 boolean verifyMatchOnHost(java.lang.Integer maxFARRequested, java.lang.Integer maxFRRRequested, java.lang.Boolean farPrecedence, PtInputBir capturedTemplate, PtInputBir storedTemplate, PtBirArgI adaptedTemplate, IntegerArgI farAchieved, IntegerArgI frrAchieved, ByteArrayArgI payload, PtMatchOnHostParams matchParams)
          Matches the supplied captured template against the supplied enrollment template.
 

Method Detail

authentify

void authentify(int authentifyId,
                byte[] key)
                throws PtException
Authentifies the caller (host) to the FM, allow access to FM functions. This function is used only when FM is configured to require authentication. In that case authentify() should be called right after open(). Without authentify() it is possible to use only specifically approved functions, namely info(), diagnostics(), firmwareGetCfg(), firmwareSetCfg() and firmwareUpdate(). Every TFM can be configured to belong to one authentication group, which is identified by its AuthentifyId. There is typically one group per costumer. Each authentication group is assigned one secret key, which must be provided by a caller to authentify(). AuthentifyId = 0 is reserved to "no authentication" group; TFMs belonging to this group do not require authentify(). It is possible to get AuthentifyId by calling info(). Note: authentify() is not implemented in TFM 1.1.

Parameters:
authentifyId - ID of the authentication group
key - The authentication key
Throws:
PtException - Error code of fail, if any was occured.

authentifyAdv

void authentifyAdv(int accountId,
                   byte[] wrappedProfile,
                   byte[] authKey,
                   byte[] publicKey,
                   int mechanism,
                   int keyLength,
                   int flags,
                   int version)
                   throws PtException
Authentifies the caller (host) to the specific FM account allowing access to functions enabled for that account. Optionally establish secure channel for the given connection. This function can also load and immediately use wrapped profile.

Parameters:
accountId - ID of the account to which the caller wants to be authentified.
wrappedProfile - Wrapped profile to be used, null if not used.
authKey - Authentication key, can be null if dwAccountId is PT_ACCOUNT_ANONYMOUS.
publicKey - Public part of the KEYEX (key exchange) key pair used for mutual authentication, can be null if not used.
mechanism - Crypto mechanism used for channel encryption, use PT_SECURECHANNEL_MECH_NONE if secure channel is not needed.
keyLength - Length of key (in bits) used for channel encryption. Note that only some key lengths are allowed for certain crypto mechanisms.
flags - Additional flags for secure channel encryption (like enabling encryption of GUI callbacks).
version - Version of secure channel protocol.
Throws:
PtException - Error code of fail, if any was occured.

authentifyEx

void authentifyEx(int accountId,
                  byte[] key)
                  throws PtException
Authentifies the caller (host) to the specific FM account allowing access to functions enabled for that account. Note: authentifyEx() is implemented only in ESS 2.2.

Parameters:
accountId - ID of the account to which the caller wants to be authentified,
key - The authentication key
Throws:
PtException - Error code of fail, if any was occured.

calibrate

void calibrate(int type)
               throws PtException
Calibrates the fingerprint sensor to suite best to the given user. The calibration data will be stored in NVM and used for all the following biometric operations, in this and future connections (communication sessions). calibrate() is currently used only for strip sensors (ESS). The standard calibration (PT_CALIB_TYPE_STANDARD) is an interactive operation. The user will be prompted to put, lift or swipe his finger. This feedback will be communicated using the GUI callbacks. For the success of this operation is therefore essential to enable and use the GUI callbacks. If the CallbackLevel member of the session configuration is set to CALLBACKS_NONE, calibrate() will directly fail. The GUI callbacks are also the only way how to interrupt this operation. If the host fails to use callbacks, the only way how to regain control over FM is to close and reopen the connection (communication session).

Parameters:
type - Type of calibration operation to be performed
Throws:
PtException - Error code of fail, if any was occured.

cancel

void cancel(int flags)
            throws PtException
Cancels currently running PTAPI command.

Parameters:
flags - Additional flags. Currently not used, set it to 0.
Throws:
PtException - Error code of fail, if any was occured.

capture

void capture(byte purpose,
             PtBirArgI capturedTemplate,
             int timeout,
             PtBirArgI auditData,
             byte[] signData,
             ByteArrayArgI signature)
             throws PtException
Scans the live finger and processes it into a template. The last template obtained through capture() will be remembered throughout the session and can be used by biometric matching functions. In addition it can be optionally returned to the caller. This function can call GUI callbacks.

Parameters:
purpose - Purpose of the enrollment. Use one of the PT_PURPOSE_xxxx values.
capturedTemplate - Address of the pointer, which will be set to point to the resulting template (BIR). If the template should be only remembered for use of next functions, leave this parameter NULL
timeout - Timeout in milliseconds. "-1" means default timeout.
auditData - Reserved, use NULL.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Throws:
PtException - Error code of fail, if any was occured.

close

void close()
           throws PtException
Closes the connection previously opened by open().

Throws:
PtException - Error code of fail, if any was occured.

closeDevice

void closeDevice()
                 throws PtException
Closes connection interface, if communication session is still opened it is automatically closed.

Throws:
PtException - Error code of fail, if any was occured.

closeSession

void closeSession()
                  throws PtException
Closes communication session, device interface remains open.

Throws:
PtException - Error code of fail, if any was occured.

convertTemplate

PtBir convertTemplate(PtInputBir inputBIR,
                      int targetType,
                      boolean returnPayload)
                      throws PtException
Converts template to format currently set in session configuration.

Parameters:
inputBIR - Source template
targetType - Target template type
returnPayload - If TRUE then the converted template is returned with its payload.
Returns:
Converted template (BIR). (Corresponds with parameter ppOutputBIR in original function)
Throws:
PtException - Error code of fail, if any was occured.

convertTemplateEx

byte[] convertTemplateEx(int sourceType,
                         int sourceEnvelope,
                         byte[] inputData,
                         int targetType,
                         int targetEnvelope,
                         byte[] supplementaryData,
                         int flags)
                         throws PtException
Converts template to specified format including standard ANSI/ISO formats.

Parameters:
sourceType - Source format type (see PT_TEMPLATE_TYPE_xxxx). If PT_TEMPLATE_TYPE_AUTO is used then source template type is detected automatically.
sourceEnvelope - Source template envelope (see PT_TEMPLATE_ENVELOPE_xxxx).
inputData - Source template data.
targetType - Target template type (see PT_TEMPLATE_TYPE_xxxx).If PT_TEMPLATE_TYPE_AUTO is used then target template type is choosed automatically.
targetEnvelope - Target template envelope (see PT_TEMPLATE_ENVELOPE_xxxx).
supplementaryData - Reserved for future use, set to NULL.
flags - Additional flags (see PT_CONVTEMPL_FLAG_xxxx).
Returns:
converted template in the target format.
Throws:
PtException - Exception with operation status (error) code.

deleteAllFingers

void deleteAllFingers()
                      throws PtException
Deletes all fingerprint templates stored in slots in the non-volatile memory of the FM. This function is an extension to BioAPI. The standard BioAPI interface for this functionality are the database functions (DbStoreBIR, DbGetBIR etc.). However, this interface is too heavyweight for the FM's needs.

Throws:
PtException - Error code of fail, if any was occured.

deleteFinger

void deleteFinger(int slotNr)
                  throws PtException
Deletes fingerprint template stored in the selected slot in the non-volatile memory of the FM. This function is an extension to BioAPI. The standard BioAPI interface for this functionality are the database functions (DbStoreBIR, DbGetBIR etc.). However, this interface is too heavyweight for the FM's needs.

Parameters:
slotNr - Number of slot to delete (0..N-1)
Throws:
PtException - Error code of fail, if any was occured.

detectFingerEx

void detectFingerEx(int timeout,
                    int flags)
                    throws PtException
Verifies, if there is a finger on the sensor. If timeout is nonzero, the function waits for the specified time interval until the required conditions are met. This function is an extension to BioAPI. BioAPI handles finger detection through MODULE_EVENT events. However, this mechanism is not suitable for implementation on FM (requires a possibility to send out asynchronous events, while FM is purely slave device). If needed, a BioAPI-compatible event behavior can be built using the detectFingerEx() function, but the implementation will be inefficient. detectFingerEx() is a superset of an obsolete function detectFinger(), which was used in previous versions of FM. detectFinger() is equivalent to detectFingerEx (timeout, PT_DETECT_ACCEPTABLE | PT_DETECT_GUI).

Parameters:
timeout - Timeout in milliseconds. "-1" means default timeout. "0" is an acceptable value for this function, it means "test if the current state meats the required conditions".
flags - Bit mask, determining the behavior of the function and the conditions for which the function waits.
Throws:
PtException - Error code of fail, if any was occured.

enroll

void enroll(byte purpose,
            PtInputBir storedTemplate,
            PtBirArgI newTemplate,
            IntegerArgI slotNr,
            byte[] payload,
            int timeout,
            PtBirArgI auditData,
            byte[] signData,
            ByteArrayArgI signature)
            throws PtException
Scans the live finger once or several times, depending on the session settings, and combines the images into one enrollment template. The last template obtained through enroll() will be remembered throughout the session and can be used by biometric matching functions. This function can call GUI callbacks.

Parameters:
purpose - Purpose of the enrollment. Use one of the PT_PURPOSE_xxxx values.
storedTemplate - Reserved, use NULL.
newTemplate - Address of the pointer, which will be set to point to the resulting template (BIR). If the template should be stored only in TFM's non-volatile memory, leave this parameter NULL.
slotNr - Pointer to a variable which receives slot number (0..N-1) where the template was stored. If the value is NULL, template is not stored on TFM.
payload - Data to be embedded into the resulting template. Payload data is an output parameter from @c verify() and @c verifyEx() when successful match is achieved.
timeout - Timeout in milliseconds. "-1" means default timeout.
auditData - Reserved, use NULL.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Throws:
PtException - Error code of fail, if any was occured.

extendedInfo

PtExtendedInfo extendedInfo()
                            throws PtException
Returns an additional information about the TFM/ESS.

Returns:
Structure with extended TFM/ESS information. (Corresponds with parameter ppExtInfo in original function)
Throws:
PtException - Error code of fail, if any was occured.

formatInternalNVM

void formatInternalNVM(int nvmVersion,
                       byte[] fsParams,
                       byte[] nvmParams)
                       throws PtException
Formats internal NVM for SONLY device.

Parameters:
nvmVersion - Version of NVM to be created. If set to 0 then default version is created.
fsParams - Pointer to additional file system creation parameters. If set to null then filesystem is created with default parameters.
nvmParams - Pointer to NVM platform specific parameters. Can be null if no parameters are needed.
Throws:
PtException - Error code of fail, if any was occured.

getAccessRights

byte[] getAccessRights(int accountId)
                       throws PtException
Gets access rights mask of given account

Parameters:
accountId - ID of account which access rights mask has to be returned
Returns:
Resulting access rights mask of given user's account. (Corresponds with parameter ppAccessRights in original function)
Throws:
PtException - Error code of fail, if any was occured.

getAppData

byte[] getAppData(int area)
                  throws PtException
Reads the application data stored in TFM's non-volatile memory.

Parameters:
area - Area to read. One of the PT_AREA_xxx values.
Returns:
Resulting application data. If no data are stored in NVM, the result will be a data block with zero length. (Corresponds with parameter ppAppData in original function)
Throws:
PtException - Error code of fail, if any was occured.

getAvailableMemory

int getAvailableMemory(int type)
                       throws PtException
Returns the size in bytes of the remaining EEPROM memory on the TFM available for application's usage.

Parameters:
type - Requested type of memory (see values PT_MEMTYPE_xxxx)
Returns:
Returned size of remaining EEPROM memory. (Corresponds with parameter pdwAvailableMemory in original function)
Throws:
PtException - Error code of fail, if any was occured.

getFingerData

byte[] getFingerData(int slotNr)
                     throws PtException
Reads the additional appliciation data associated with a finger template stored in FM's non-volatile memory.

Parameters:
slotNr - The slot number of the template whose application data should be read.
Returns:
Application data associated with given fingerprint. If no data are associated with the fingerprint, the result will be a data block with zero length. (Corresponds with parameter ppFingerData in original function)
Throws:
PtException - Error code of fail, if any was occured.

getImageFormat

PtImgFormat getImageFormat(int operation)
                           throws PtException
Gets current value of image format set for image acquiring or navigation operations.

Parameters:
operation - Type of biometric operation which image format setting is requested (one of PT_IMGFORMAT_OPER_xxxx values).
Returns:
image format which is currently set for specified operation type.
Throws:
PtException

getLED

void getLED(IntegerArgI mode,
            IntegerArgI led1,
            IntegerArgI led2)
            throws PtException
Queires the state and behavior of the two user interface LEDs, which can be optionally connected to the TFM.

Parameters:
mode - Mode of the LEDs. See setLED() for details.
led1 - Parameter defining the detailed behavior of the first LED. This parameter is mode-specific. See setLED() for details.
led2 - Parameter defining the detailed behavior of the second LED. This parameter is mode-specific. See setLED() for details.
Throws:
PtException - Error code of fail, if any was occured.

getSessionCfgEx

java.lang.Object getSessionCfgEx(short cfgVersion)
                                 throws PtException
Gets the current session parameters of the TFM. The parameters influence especially the behavior of the biometric functions - e.g. should we use the advanced or the standard templates etc. getSessionCfgEx() is an extension of the now obsolete function PTGetSessionCfg.

Parameters:
cfgVersion - Requested version of the configuration data
Returns:
Returned session configuration. (Corresponds with parameter ppSessionCfg in original function)
Throws:
PtException - Error code of fail, if any was occured.

getSwipeInfo

void getSwipeInfo(PtSwipeInfoArgI swipeInfo,
                  ByteArrayArgI skewInfo,
                  ByteArrayArgI speedInfo)
                  throws PtException
Returns information about last finger swipe

Parameters:
swipeInfo - Resulting PtSwipeInfo structure with last swipe information.
skewInfo - Resulting last swipe skew information.
speedInfo - Resulting last swipe speed information.
Throws:
PtException - Error code of fail, if any was occured.

grab

byte[] grab(byte type,
            int timeout,
            boolean waitForAcceptableFinger,
            byte[] signData,
            ByteArrayArgI signature)
            throws PtException
Scans the live finger and returns the scanned image.

Parameters:
type - Requested type of the returned data. The data may be compressed, subsampled, etc. Use one of the PT_GRAB_TYPE_xxx values.
timeout - Timeout in miliseconds. "-1" means default timeout.
waitForAcceptableFinger - - If true, the function verifies the quality of the finger image and returns only when the finger quality would be acceptable for other biometric functions. If false, the function return immediately without verifying image quality.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Returns:
Resulting grabbed data. (Corresponds with parameter ppGrabbedData in original function)
Throws:
PtException - Error code of fail, if any was occured.

grabWindow

byte[] grabWindow(byte compressionType,
                  int timeout,
                  boolean waitForAcceptableFinger,
                  int rows,
                  int rowOffset,
                  int rowDelta,
                  int cols,
                  int colOffset,
                  int colDelta,
                  byte[] signData,
                  ByteArrayArgI signature)
                  throws PtException
Scans the live finger and returns the scanned image. Only a defined window of the sensor will be returned.

Parameters:
compressionType - Requested type of compression of the data. Use one of the PT_GRAB_COMPRESSION_TYPE_xxxx values.
timeout - Timeout in milliseconds. "-1" means default timeout.
waitForAcceptableFinger - If true, the function verifies the quality of the finger image and returns only when the finger quality would be acceptable for other biometric functions. If false, the function returns immediately without verifying image quality.
rows - Number of rows to grab. This is the number of actually grabbed rows, taking into account the subsampling factor. Example: If rows=4, rowOffset=10 and rowDelta=2, the resulting image will contain rows 10, 12, 14 and 16. This is the number of actually grabbed rows, taking into account the subsampling factor.
cols - Number of columns to grab
rowOffset - First row to grab. [0,0] = Upper left corner.
colOffset - First column to grab. [0,0] = Upper left corner.
rowDelta - Subsampling factor = number of rows to advance between the neighbour used rows. 1=Normal full image.
colDelta - Subsampling factor = number of columns to advance between the neighbour used columns. 1=Normal full image.
signData - Reserved, use NULL.
signature - Reserved, use NULL. Result container will contain reference at byte[].
Returns:
Resulting grabbed data.
Throws:
PtException - Error code of fail, if any was occured. Note: Due to memory limitations TFM it is not possible to grab the full image from the whole sensor. The caller has to use such combination of rows, cols and rowDelta, colDelta parameters to fit into the memory requirements. Otherwise grabWindow() will return an error. You can use info() function to get the max. guaranteed size of the output data. The value is stored in maxGrabWindow field. The value is valid for uncompressed images; for compress images please review the description of given compression method to get relevant data. maxGrabWindow is the max. guaranteed size of the output data in bytes. Therefore the following equation applies: maxGrabWindow >= rows * cols Please note that maxGrabWindow is just the max. guaranteed size. It is possible that in some cases grabWindow() may succeed even for bigger image data, but this is not guaranteed.

identifyMatchOnHost

short identifyMatchOnHost(java.lang.Integer maxFARRequested,
                          java.lang.Integer maxFRRRequested,
                          java.lang.Boolean farPrecedence,
                          PtInputBir capturedTemplate,
                          PtInputBir[] storedTemplates,
                          PtBirArgI adaptedTemplate,
                          IntegerArgI farAchieved,
                          IntegerArgI frrAchieved,
                          ByteArrayArgI payload,
                          PtMatchOnHostParams matchParams)
                          throws PtException
Matches the supplied captured template against supplied list of enrollment templates. This function does not scan live finger and therefore does not call GUI callbacks. Unlike PTVerifyMatch this function is completely performed on host without communication with FM.

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: PT_TRUE -> FAR, PT_FALSE -> FRR. Value of this parameter is currently ignored.
capturedTemplate - The template to verify - only BIR data can be used.
storedTemplates - An array of templates to be verified against - only BIR data can be used.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Reserved, use NULL.
matchParams - Pointer to structure with additional parameters for matching.
Returns:
The result: The zero-based index of the best matching template or -1 if no match. (Corresponds with parameter pshResult in original function)
Throws:
PtException - Error code of fail, if any was occured.

info

PtInfo info()
            throws PtException
Returns a set of information about the connection and the TFM, including the version of TFM.

Returns:
Structure with TFM/ESS information. (Corresponds with parameter ppInfo in original function)
Throws:
PtException - Error code of fail, if any was occured.

isStrongEncryptionEnabled

boolean isStrongEncryptionEnabled()
                                  throws PtException
Tests, whether strong ecnryption is enabled on opened device.

Returns:
True - strong encryption is enabled.
Throws:
PtException - Error code of fail, if any was occured.

listAllFingers

PtFingerListItem[] listAllFingers()
                                  throws PtException
Returns list of all fingers stored in the FM's non-volatile memory together with their associated application data.

Returns:
List of stored fingerprints and their associated data. (Corresponds with parameter ppFingerList in original function)
Throws:
PtException - Error code of fail, if any was occured.

loadFinger

PtBir loadFinger(int slotNr,
                 boolean returnPayload)
                 throws PtException
Reads template data stored in given slot.

Parameters:
slotNr - Number of slot from which the template should be read
returnPayload - If TRUE then the template is returned with its payload.
Returns:
Loaded template (BIR). (Corresponds with parameter ppStoredTemplate in original function)
Throws:
PtException - Error code of fail, if any was occured.

navigate

void navigate(int eventPeriod,
              PtNavigationCallback callback,
              byte[] postprocessingParams)
              throws PtException
Switches FM to navigation mode (a.k.a. biometric mouse). In this mode FM will provide navigation info to the host. During the navigate() call the FM sends periodically packets with navigation data to the host. The arrived packets trigger calling the callback to deliver the data to the application. Please note, that a new callback will not be called until the current returns. If the callback processing takes too long, some navigation data may be lost. Also other communication errors may lead to a lost navigation data - due to the nature of navigation it makes no sense to use error-correcting protocol. If eventPeriod = -1, FM will use on-demand mode. In this mode FM at beginning sends one navigation data packet and then waits with sending next navigation data until it receives a request from the host. The request is sent every time when the pfnCallback function on the host returns. This mode is suitable for host applications with slow callback processing, it protects against losing navigation data due to an overrun. navigate() will finish, when the callback returns with cancel request value. Due to asynchronous communication the host may still receive a few navigation callbacks after the cancel was requested.

Parameters:
eventPeriod - Delay in milliseconds between sending navigation data from FM. FM will send one packet per period, with all the navigation data accumulated over the period. If eventPeriod is set to "-1", FM will use an on-demand mode.
callback - Callback function, called every time when a navigation data packet arrives to the host. Null, if system navigation should be applied.
postprocessingParams - Parameters of navigation data postprocessing library. Null, if no postprocessing should be applied.
Throws:
PtException - Error code of fail, if any was occured.

navigateWithSleep

void navigateWithSleep(int eventPeriod,
                       int idleTimeout,
                       PtNavigationCallback callback,
                       byte[] postprocessingParams)
                       throws PtException
Switches FM to navigation mode (a.k.a. biometric mouse). In this mode FM will provide navigation info to the host. If finger is not present on the sensor for specified time, FM is switched to power-saving mode until finger is again put on the sensor. During the navigate() call the FM sends periodically packets with navigation data to the host. The arrived packets trigger calling the callback to deliver the data to the application. Please note, that a new callback will not be called until the current returns. If the callback processing takes too long, some navigation data may be lost. Also other communication errors may lead to a lost navigation data - due to the nature of navigation it makes no sense to use error-correcting protocol. If eventPeriod = -1, FM will use on-demand mode. In this mode FM at beginning sends one navigation data packet and then waits with sending next navigation data until it receives a request from the host. The request is sent every time when the pfnCallback function on the host returns. This mode is suitable for host applications with slow callback processing, it protects against losing navigation data due to an overrun. navigate() will finish, when the callback returns with cancel request value. Due to asynchronous communication the host may still receive a few navigation callbacks after the cancel was requested.

Parameters:
eventPeriod - Delay in milliseconds between sending navigation data from FM. FM will send one packet per period, with all the navigation data accumulated over the period. If eventPeriod is set to "-1", FM will use an on-demand mode.
idleTimeout - Timeout after which is FM switched to power-saving mode if no finger is detected. Value "-1" means default timeout, which is 5 seconds.
callback - Callback function, called every time when a navigation data packet arrives to the host. Null, if system navigation should be applied.
postprocessingParams - Parameters of navigation data postprocessing library. Null, if no postprocessing should be applied.
Throws:
PtException - Error code of fail, if any was occured.

openSession

void openSession(java.lang.String dsn)
                 throws PtException
Opens communication session with TFM/ESS device. Connection interface must be opened by previous call of PtGlobal.openDevice().

Parameters:
dsn - Currently not used, can be NULL.
Throws:
PtException - Error code of fail, if any was accoured.

scanQuality

int scanQuality()
                throws PtException
Returns scan quality of last finger swipe

Returns:
Returns scan quality of last finger swipe. (Corresponds with parameter pdwScanQuality in original function)
Throws:
PtException - Error code of fail, if any was occured.

secureChannel

void secureChannel(int mechanism,
                   int keyLength,
                   int flags)
                   throws PtException
Establishes a secure channel for the given connection. Secure channel can be established only after successful authentification via authentify()/authentifyEx() when session key is generated from exchanged challenges.

Parameters:
mechanism - Crypto mechanism used for channel encryption.
keyLength - Length of key (in bits) used for channel encryption. Note that only some key lengths are allowed for certain crypto mechanisms.
flags - Additional flags for channel encryption (like enabling encryption of GUI callbacks).
Throws:
PtException - Error code of fail, if any was occured.

secureChannelEx

void secureChannelEx(int mechanism,
                     int keyLength,
                     int flags,
                     int version)
                     throws PtException
Establishes a secure channel for the given connection. Secure channel can be established only after successful authentification via authentify()/authentifyEx() when session key is generated from exchanged challenges. This function uses specified version of secure channel protocol.

Parameters:
mechanism - Crypto mechanism used for channel encryption.
keyLength - Length of key (in bits) used for channel encryption. Note that only some key lengths are allowed for certain crypto mechanisms.
flags - Additional flags for channel encryption (like enabling encryption of GUI callbacks).
version - Version of secure channel protocol.
Throws:
PtException - Error code of fail, if any was occured.

setAppData

void setAppData(int area,
                byte[] appData)
                throws PtException
Stores a block of arbitrary binary data in TFM's non-volatile memory. There is only one block, shared by all applications.

Parameters:
area - Area to write. One of the PT_AREA_xxx values.
appData - The data to be stored in NVM. If the data length is zero, the application data will be deleted.
Throws:
PtException - Error code of fail, if any was occured.

setFingerData

void setFingerData(int slotNr,
                   byte[] fingerData)
                   throws PtException
Assigns an additional application data to a finger template stored in FM's non-volatile memory.

Parameters:
slotNr - The slot number of the template to be associated with data.
fingerData - The data to be stored together with the template. If the data length is zero, the application data associated with given fingerprint will be deleted
Throws:
PtException - Error code of fail, if any was occured.

setFingerPayload

void setFingerPayload(int slotNr,
                      byte[] payload)
                      throws PtException
Changes payload data of a finger template stored in TFM's non-volatile memory.

Parameters:
slotNr - The slot number of the template which payload data has to be set.
payload - New payload data.
Throws:
PtException - Error code of fail, if any was occured.

setGUICallbacks

void setGUICallbacks(PtGuiStreamingCallback guiStreamingCallback,
                     PtGuiStateCallback guiStateCallback)
                     throws PtException
Sets the references to the callback routines to be called if any called function involves displaying a biometric user interface.

Parameters:
guiStreamingCallback - A reference to an application callback to deal with the presentation of biometric streaming data. Reserved for future used, currently not implemented. Use NULL for this parameter.
guiStateCallback - A reference to an application callback to deal with GUI state changes
Throws:
PtException - Error code of fail, if any was occured.

setImageFormat

void setImageFormat(int operation,
                    PtImgFormat format,
                    int dataSections)
                    throws PtException
Sets image format for following image acquiring or navigation operations.

Parameters:
operation - Type of biometric operation for which the format is set (one of PT_IMGFORMAT_OPER_xxxx values).
format - Image format structure to be set.
dataSections - Bit mask specifying which additional sections of image data which should be returned with image data (combination of PT_IMGDATA_SECTION_xxxx flags). Used only for grab operations which return image data (PTGrab/PTSleepThenGrab). If selected section is not available then empty data section is returned.
Throws:
PtException

setLED

void setLED(int mode,
            int led1,
            int led2)
            throws PtException
Controls the state and behavior of the two user interface LEDs, which can be optionally connected to the TFM.

Parameters:
mode - Mode of the LEDs. Different modes define different behavior of the LEDs during specific operations, especially the biometrics. See PT_LED_MODE_xxxx.
led1 - Parameter definning the detailed behavior of the first LED. This parameter is mode-specific.
led2 - Parameter definning the detailed behavior of the second LED. This parameter is mode-specific.
Throws:
PtException - Error code of fail, if any was occured.

setSessionCfgEx

void setSessionCfgEx(short cfgVersion,
                     java.lang.Object sessionCfg)
                     throws PtException
Sets the session parameters of the TFM. The parameters influence especially the behavior of the biometric functions - e.g. should we use the advanced or the standard templates etc. The change of parameters is valid only for the current session. Each new session starts with the default settings. setSessionCfgEx() is an extension of the now obsolete function PTSetSessionCfg.

Parameters:
cfgVersion - Version of the configuration data. Use the constant PT_CURRENT_SESSION_CFG
sessionCfg - Session configuration to be set
Throws:
PtException - Error code of fail, if any was occured.

sleep

int sleep(int sleepMode,
          PtIdleCallback callback)
          throws PtException
Switches FM to deep sleep or standby mode. In this mode FM's CPU is stopped to minimize power consumption. FM can be woken up from the sleep mode either by the host or by another event (e.g. when a finger is detected on FM's sensor). When FM wakes up, the sleep() function completes and returns the cause of wake up to the caller.

Parameters:
sleepMode - Sleep mode to be used. Possible values are PT_SLEEP_MODE_DEEPSLEEP (fingerprint sensor is powered down (finger detect is not active), PT_SLEEP_MODE_STANDBY (finger detect is active).
callback - Callback function, called periodically all the time FM is sleeping. Optional, can be NULL.
Returns:
The cause of wakeup. Currently the following causes are possible: PT_WAKEUP_CAUSE_HOST (signal from the Host), PT_WAKEUP_CAUSE_FINGER (a finger was detected). (Corresponds with parameter pdwWakeupCause in original function)
Throws:
PtException - Error code of fail, if any was occured.

sleepThenCapture

void sleepThenCapture(PtIdleCallback callback,
                      byte purpose,
                      int timeout,
                      IntegerArgI wakeupCause,
                      IntegerArgI captureGuiMessage,
                      PtBirArgI capturedTemplate,
                      PtBirArgI auditData,
                      byte[] signData,
                      ByteArrayArgI signature)
                      throws PtException
Switches FM to the standby (finger detect) mode. If finger is detected, the FM wakes up and immediately scans the finger and processes it into a template. The last template obtained through sleepThenCapture() will be remembered throughout the session and can be used by biometric matching functions. In addition the trmplate can be optionally returned to the caller. This function is especially useful for low-power capturing.

Parameters:
callback - Callback function, called periodically all the time FM is sleeping. Optional, can be NULL. See the description of PT_IDLE_CALLBACK.
purpose - Purpose of the enrollment. Use one of the PT_PURPOSE_xxxx values.
timeout - Timeout in milliseconds. "-1" means default timeout. This timeout controls the max. time between HW finger detect (finger touched the metallic frame of the sensor) and start of the swipe (finger touched the sensor's surface). Timeout does not include the time needed for the scan itself (once the swipe starts, it will not be interrupted), template processing and transfer to the host. We recommend to use a short time, e.g. 1 sec.
wakeupCause - The cause of wakeup. Currently the following causes are possible: PT_WAKEUP_CAUSE_HOST (0) (signal from the Host) or PT_WAKEUP_CAUSE_FINGER (1) (a finger was detected)
captureGuiMessage - Assessment of the quality of the capture result. It is used to indicate problems like too fast, too skewed or too short finger swipe, or image quality problems (e.g. too right, too left etc.). The codes returned are the same as the GUI message codes in GUI callbacks (PT_GUIMSG_xxxx). Good image is indicated by a code PT_GUIMSG_GOOD_IMAGE. pdwGrabGuiMessage is valid only if wakeupCause is PT_WAKEUP_CAUSE_FINGER.
capturedTemplate - Resulting template (BIR). If the template should be only remembered for use of next functions and not returned to the host, leave this parameter NULL
auditData - Reserved, use NULL
signData - Reserved, use NULL
signature - Reserved, use NULL
Throws:
PtException - Error code of fail, if any was occured.

sleepThenGrab

void sleepThenGrab(PtIdleCallback callback,
                   byte grabType,
                   int timeout,
                   boolean assessImageQuality,
                   IntegerArgI wakeupCause,
                   IntegerArgI grabGuiMessage,
                   ByteArrayArgI grabbedData,
                   byte[] signData,
                   ByteArrayArgI signature)
                   throws PtException
Switches FM to the standby (finger detect) mode. If finger is detected, the FM wakes up and immediately starts an image grabbing operation. This function is especially useful for low-power image grabbing.

Parameters:
callback - Callback function, called periodically all the time FM is sleeping. Optional, can be NULL. See the description of PT_IDLE_CALLBACK.
grabType - Requested type of the returned data. the data may be compressed, subsampled, etc. Use one of the PT_GRAB_TYPE_xxxx values.
timeout - Timeout in milliseconds. "-1" means default timeout. This timeout controls the max. time between HW finger detect (finger touched the metallic frame of the sensor) and start of the swipe (finger touched the sensor's surface). Timeout does not include the time needed for the grab itself (once the swipe starts, it will not be interrupted), image processing and transfer to the host. We recommend to use a short time, e.g. 1 sec.
assessImageQuality - If true, the function will after a successful grab perform also image quality analyses. If there is any problem with the image quality, it will be reported via the grabGuiMessage. This parameter controls the same image quality checks, which are controlled in grab() by waitForAcceptableFinger.
wakeupCause - The cause of wakeup. Currently the following causes are possible: PT_WAKEUP_CAUSE_HOST (0) (signal from the Host) or PT_WAKEUP_CAUSE_FINGER (1) (a finger was detected).
grabGuiMessage - Assessment of the quality of the grab result. It is used to indicate problems like too fast, too skewed or too short finger swipe, or image quality problems (e.g. too right, too left etc.). The codes returned are the same as the GUI message codes in GUI callbacks (PT_GUIMSG_xxxx). Good image is indicated by a code PT_GUIMSG_GOOD_IMAGE. grabGuiMessage is valid only if wakeupCause is PT_WAKEUP_CAUSE_FINGER.
grabbedData - Resulting grabbed data. Valid only if wakeupCause is PT_WAKEUP_CAUSE_FINGER grabGuiMessage is PT_GUIMSG_GOOD_IMAGE.
signData - Reserved, use NULL
signature - Reserved, use NULL.
Throws:
PtException - Error code of fail, if any was occured.

storeFinger

int storeFinger(PtInputBir template)
                throws PtException
Stores given fingerprint template in the selected slot in the non-volatile memory of the TFM. If @param template is NULL, it only clears the slot. This function is an extension to BioAPI. The standard BioAPI interface for this functionality are the database functions (DbStoreBIR, DbGetBIR etc.). However, this interface is too heavyweight for the TFM's needs. The template cache consists of a predefined number of "slots". The slots are numbered 0..N-1 and accessible through setting byForm field in the PT_INPUT_BIR to PT_SLOT_INPUT. The "N" depends on the model of the TFM and can be found using the @c info() call. Please note, that the real number of templates storable in TFM is further limited by the available memory and can be therefore lower than "N".

Parameters:
template - Template (BIR) to be stored in the template cache
Returns:
Pointer to a variable which receives slot number (0..N-1) where the template was stored. If the value is NULL, the template is not stored. (Corresponds with parameter plSlotNr in original function)
Throws:
PtException - Error code of fail, if any was occured.

transact

byte[] transact(byte[] inPkt)
                throws PtException
Sends the request data packet to the FM, waits for a response and get the response data packet. This is a blocking function, which does not return until the request is processed. The request data are created by PtCommCallback interface and response data must be passed to PtCommCallback interface as return value.

Parameters:
inPkt - Packet, which has to be submitted to FM
Returns:
The response packet data. (Corresponds with parameter ppOutPkt in original function)
Throws:
PtException - Error code of fail, if any was occured.

updateFingerPayload

void updateFingerPayload(int slotNr,
                         int offset,
                         byte[] data)
                         throws PtException
Updates payload data of a finger template stored in TFM's non-volatile memory.

Parameters:
slotNr - The slot number of the template which payload data has to be changed.
offset - Offset from which are the payload data changed.
data - Data to be stored at the given offset in payload.
Throws:
PtException - Error code of fail, if any was occured.

verify

boolean verify(java.lang.Integer maxFARRequested,
               java.lang.Integer maxFRRRequested,
               java.lang.Boolean farPrecedence,
               PtInputBir storedTemplate,
               PtBirArgI adaptedTemplate,
               IntegerArgI farAchieved,
               IntegerArgI frrAchieved,
               ByteArrayArgI payload,
               int timeout,
               boolean capture,
               PtBirArgI auditData,
               byte[] signData,
               ByteArrayArgI signature)
               throws PtException
Scans the live finger or uses the last captured finger data and tries to match it against the supplied enrollment template. If the functions scans live finger, the template obtained will be remembered througout the session and can be used by other biometric matching functions. This function can call GUI callbacks (unless captured is true);

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: true -> FAR, false -> FRR. Value of this parameter is currently ignored.
storedTemplate - The template to be verified against - BIR data or one of the predefined handles.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Payload data, originally embedded in the @c storedTemplate. Payload data is available only when successful match is achieved.
timeout - Timeout in milliseconds. "-1" means default timeout.
capture - If true, verify() at first captures live fingerprint. If false, result of the last finger capturing function (e.g. capture() or enroll()) will be used.
auditData - Reserved, use NULL.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Returns:
The result: Match/no match (Corresponds with parameter pboResult in original function)
Throws:
PtException - Error code of fail, if any was occured.

verifyAll

int verifyAll(java.lang.Integer maxFARRequested,
              java.lang.Integer maxFRRRequested,
              java.lang.Boolean farPrecedence,
              PtBirArgI adaptedTemplate,
              IntegerArgI farAchieved,
              IntegerArgI frrAchieved,
              ByteArrayArgI payload,
              int timeout,
              boolean capture,
              PtBirArgI auditData,
              byte[] signData,
              ByteArrayArgI signature)
              throws PtException
Scans the live finger or uses the last captured finger data and tries to match it against the templates stored in TFM's non-volatile memory. If the function scans live finger, the template obtained will be remembered throughout the session and can be used by other biometric matching functions. Return the slot of the best matching template or -1 if no match. This is an extension to BioAPI. Its main purpose is to be able to match user's finger against all the enrolled templates in the TFM's database, but without the complexity of the heavy-weight BioAPI database mechanism. This is not a real one-to-many matching, but one-to-few matching.

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: true -> FAR, false -> FRR. Value of this parameter is currently ignored.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Address of the pointer, which will be set to point to the payload data, originally embedded in the @c storedTemplate. Payload data is available only when successful match is achieved.
timeout - Timeout in milliseconds. "-1" means default timeout.
capture - If true, verifyEx() at first captures live fingerprint. If false, result of the last finger capturing function (e.g. capture() or enroll()) will be used.
auditData - Reserved, use NULL.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Returns:
The result: The zero-based index of the best matching template or -1 if no match. (Corresponds with parameter plResult in original function)
Throws:
PtException - Error code of fail, if any was occured.

verifyEx

short verifyEx(java.lang.Integer maxFARRequested,
               java.lang.Integer maxFRRRequested,
               java.lang.Boolean farPrecedence,
               PtInputBir[] storedTemplates,
               PtBirArgI adaptedTemplate,
               IntegerArgI farAchieved,
               IntegerArgI frrAchieved,
               ByteArrayArgI payload,
               int timeout,
               boolean capture,
               PtBirArgI auditData,
               byte[] signData,
               ByteArrayArgI signature)
               throws PtException
Scans the live finger or uses the last captured finger data and tries to match it against the set of supplied enrollment templates. If the function scans live finger, the template obtained will be remembered throughout the session and can be used by other biometric matching functions. Return the index of the best matching template or -1 if no match. This is an extension to BioAPI. Its main purpose is to be able to match user's finger against all his enrolled fingers (i.e. up to 10 fingers) without the necessity to ask user several times to scan his finger.

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: true -> FAR, false -> FRR. Value of this parameter is currently ignored.
storedTemplates - An array of templates to be verified against - BIR data or one of the predefined handles.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Address of the pointer, which will be set to point to the payload data, originally embedded in the @c storedTemplate. Payload data is available only when successful match is achieved.
timeout - Timeout in milliseconds. "-1" means default timeout.
capture - If true, verifyEx() at first captures live fingerprint. If false, result of the last finger capturing function (e.g. capture() or enroll()) will be used.
auditData - Reserved, use NULL.
signData - Reserved, use NULL.
signature - Reserved, use NULL.
Returns:
The result: The zero-based index of the best matching template or -1 if no match. (Corresponds with parameter pshResult in original function)
Throws:
PtException - Error code of fail, if any was occured.

verifyMatch

boolean verifyMatch(java.lang.Integer maxFARRequested,
                    java.lang.Integer maxFRRRequested,
                    java.lang.Boolean farPrecedence,
                    PtInputBir capturedTemplate,
                    PtInputBir storedTemplate,
                    PtBirArgI adaptedTemplate,
                    IntegerArgI farAchieved,
                    IntegerArgI frrAchieved,
                    ByteArrayArgI payload)
                    throws PtException
Matches the supplied captured template against the supplied enrollment template. This function does not scan live finger and therefore does not call GUI callbacks.

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: true -> FAR, false -> FRR. Value of this parameter is currently ignored.
capturedTemplate - The template to verify - BIR data or one of the predefined handles. If NULL, the result of the last capture() or enroll() will be used.
storedTemplate - The template to be verified against - BIR data or one of the predefined handles.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Address of the pointer, which will be set to point to the payload data, originally embedded in the @c storedTemplate. Payload data is available only when successful match is achieved.
Returns:
The result: Match/no match (Corresponds with parameter pboResult in original function)
Throws:
PtException - Error code of fail, if any was occured.

verifyMatchOnHost

boolean verifyMatchOnHost(java.lang.Integer maxFARRequested,
                          java.lang.Integer maxFRRRequested,
                          java.lang.Boolean farPrecedence,
                          PtInputBir capturedTemplate,
                          PtInputBir storedTemplate,
                          PtBirArgI adaptedTemplate,
                          IntegerArgI farAchieved,
                          IntegerArgI frrAchieved,
                          ByteArrayArgI payload,
                          PtMatchOnHostParams matchParams)
                          throws PtException
Matches the supplied captured template against the supplied enrollment template. This function does not scan live finger and therefore does not call GUI callbacks. Unlike PTVerifyMatch this function is completely performed on host without communication with FM.

Parameters:
maxFARRequested - Max. FAR requested by the caller. Value of this parameter is currently ignored.
maxFRRRequested - Max. FRR requested by the caller. Optional, can be NULL. Value of this parameter is currently ignored.
farPrecedence - If both FAR and FRR are provided, this parameter decides which of them takes precedence: PT_TRUE -> FAR, PT_FALSE -> FRR. Value of this parameter is currently ignored.
capturedTemplate - The template to verify - only BIR data can be used.
storedTemplate - The template to be verified against - only BIR data can be used.
adaptedTemplate - Reserved, use NULL.
farAchieved - Reserved, use NULL.
frrAchieved - Reserved, use NULL.
payload - Reserved, use NULL.
matchParams - Pointer to structure with additional parameters for matching.
Returns:
The result: Match/no match (Corresponds with parameter pboResult in original function)
Throws:
PtException - Error code of fail, if any was occured.