|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void authentify(int authentifyId, byte[] key) throws PtException
authentifyId
- ID of the authentication groupkey
- The authentication key
PtException
- Error code of fail, if any was occured.void authentifyAdv(int accountId, byte[] wrappedProfile, byte[] authKey, byte[] publicKey, int mechanism, int keyLength, int flags, int version) throws PtException
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.
PtException
- Error code of fail, if any was occured.void authentifyEx(int accountId, byte[] key) throws PtException
accountId
- ID of the account to which the caller wants to be authentified,key
- The authentication key
PtException
- Error code of fail, if any was occured.void calibrate(int type) throws PtException
type
- Type of calibration operation to be performed
PtException
- Error code of fail, if any was occured.void cancel(int flags) throws PtException
flags
- Additional flags. Currently not used, set it to 0.
PtException
- Error code of fail, if any was occured.void capture(byte purpose, PtBirArgI capturedTemplate, int timeout, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature) throws PtException
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 NULLtimeout
- Timeout in milliseconds. "-1" means default timeout.auditData
- Reserved, use NULL.signData
- Reserved, use NULL.signature
- Reserved, use NULL.
PtException
- Error code of fail, if any was occured.void close() throws PtException
PtException
- Error code of fail, if any was occured.void closeDevice() throws PtException
PtException
- Error code of fail, if any was occured.void closeSession() throws PtException
PtException
- Error code of fail, if any was occured.PtBir convertTemplate(PtInputBir inputBIR, int targetType, boolean returnPayload) throws PtException
inputBIR
- Source templatetargetType
- Target template typereturnPayload
- If TRUE then the converted template is returned with its payload.
PtException
- Error code of fail, if any was occured.byte[] convertTemplateEx(int sourceType, int sourceEnvelope, byte[] inputData, int targetType, int targetEnvelope, byte[] supplementaryData, int flags) throws PtException
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).
PtException
- Exception with operation status (error) code.void deleteAllFingers() throws PtException
PtException
- Error code of fail, if any was occured.void deleteFinger(int slotNr) throws PtException
slotNr
- Number of slot to delete (0..N-1)
PtException
- Error code of fail, if any was occured.void detectFingerEx(int timeout, int flags) throws PtException
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.
PtException
- Error code of fail, if any was occured.void enroll(byte purpose, PtInputBir storedTemplate, PtBirArgI newTemplate, IntegerArgI slotNr, byte[] payload, int timeout, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature) throws PtException
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.
PtException
- Error code of fail, if any was occured.PtExtendedInfo extendedInfo() throws PtException
PtException
- Error code of fail, if any was occured.void formatInternalNVM(int nvmVersion, byte[] fsParams, byte[] nvmParams) throws PtException
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.
PtException
- Error code of fail, if any was occured.byte[] getAccessRights(int accountId) throws PtException
accountId
- ID of account which access rights mask has to be returned
PtException
- Error code of fail, if any was occured.byte[] getAppData(int area) throws PtException
area
- Area to read. One of the PT_AREA_xxx values.
PtException
- Error code of fail, if any was occured.int getAvailableMemory(int type) throws PtException
type
- Requested type of memory (see values PT_MEMTYPE_xxxx)
PtException
- Error code of fail, if any was occured.byte[] getFingerData(int slotNr) throws PtException
slotNr
- The slot number of the template whose application data should
be read.
PtException
- Error code of fail, if any was occured.PtImgFormat getImageFormat(int operation) throws PtException
operation
- Type of biometric operation which image format setting
is requested (one of PT_IMGFORMAT_OPER_xxxx values).
PtException
void getLED(IntegerArgI mode, IntegerArgI led1, IntegerArgI led2) throws PtException
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.
PtException
- Error code of fail, if any was occured.java.lang.Object getSessionCfgEx(short cfgVersion) throws PtException
cfgVersion
- Requested version of the configuration data
PtException
- Error code of fail, if any was occured.void getSwipeInfo(PtSwipeInfoArgI swipeInfo, ByteArrayArgI skewInfo, ByteArrayArgI speedInfo) throws PtException
swipeInfo
- Resulting PtSwipeInfo structure with last swipe information.skewInfo
- Resulting last swipe skew information.speedInfo
- Resulting last swipe speed information.
PtException
- Error code of fail, if any was occured.byte[] grab(byte type, int timeout, boolean waitForAcceptableFinger, byte[] signData, ByteArrayArgI signature) throws PtException
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.
PtException
- Error code of fail, if any was occured.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
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 grabrowOffset
- 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[].
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.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
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.
PtException
- Error code of fail, if any was occured.PtInfo info() throws PtException
PtException
- Error code of fail, if any was occured.boolean isStrongEncryptionEnabled() throws PtException
PtException
- Error code of fail, if any was occured.PtFingerListItem[] listAllFingers() throws PtException
PtException
- Error code of fail, if any was occured.PtBir loadFinger(int slotNr, boolean returnPayload) throws PtException
slotNr
- Number of slot from which the template should be readreturnPayload
- If TRUE then the template is returned with its payload.
PtException
- Error code of fail, if any was occured.void navigate(int eventPeriod, PtNavigationCallback callback, byte[] postprocessingParams) throws PtException
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.
PtException
- Error code of fail, if any was occured.void navigateWithSleep(int eventPeriod, int idleTimeout, PtNavigationCallback callback, byte[] postprocessingParams) throws PtException
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.
PtException
- Error code of fail, if any was occured.void openSession(java.lang.String dsn) throws PtException
dsn
- Currently not used, can be NULL.
PtException
- Error code of fail, if any was accoured.int scanQuality() throws PtException
PtException
- Error code of fail, if any was occured.void secureChannel(int mechanism, int keyLength, int flags) throws PtException
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).
PtException
- Error code of fail, if any was occured.void secureChannelEx(int mechanism, int keyLength, int flags, int version) throws PtException
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.
PtException
- Error code of fail, if any was occured.void setAppData(int area, byte[] appData) throws PtException
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.
PtException
- Error code of fail, if any was occured.void setFingerData(int slotNr, byte[] fingerData) throws PtException
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
PtException
- Error code of fail, if any was occured.void setFingerPayload(int slotNr, byte[] payload) throws PtException
slotNr
- The slot number of the template which payload data has to be set.payload
- New payload data.
PtException
- Error code of fail, if any was occured.void setGUICallbacks(PtGuiStreamingCallback guiStreamingCallback, PtGuiStateCallback guiStateCallback) throws PtException
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
PtException
- Error code of fail, if any was occured.void setImageFormat(int operation, PtImgFormat format, int dataSections) throws PtException
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.
PtException
void setLED(int mode, int led1, int led2) throws PtException
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.
PtException
- Error code of fail, if any was occured.void setSessionCfgEx(short cfgVersion, java.lang.Object sessionCfg) throws PtException
cfgVersion
- Version of the configuration data. Use the constant PT_CURRENT_SESSION_CFGsessionCfg
- Session configuration to be set
PtException
- Error code of fail, if any was occured.int sleep(int sleepMode, PtIdleCallback callback) throws PtException
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.
PtException
- Error code of fail, if any was occured.void sleepThenCapture(PtIdleCallback callback, byte purpose, int timeout, IntegerArgI wakeupCause, IntegerArgI captureGuiMessage, PtBirArgI capturedTemplate, PtBirArgI auditData, byte[] signData, ByteArrayArgI signature) throws PtException
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 NULLauditData
- Reserved, use NULLsignData
- Reserved, use NULLsignature
- Reserved, use NULL
PtException
- Error code of fail, if any was occured.void sleepThenGrab(PtIdleCallback callback, byte grabType, int timeout, boolean assessImageQuality, IntegerArgI wakeupCause, IntegerArgI grabGuiMessage, ByteArrayArgI grabbedData, byte[] signData, ByteArrayArgI signature) throws PtException
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 NULLsignature
- Reserved, use NULL.
PtException
- Error code of fail, if any was occured.int storeFinger(PtInputBir template) throws PtException
template
- Template (BIR) to be stored in the template cache
PtException
- Error code of fail, if any was occured.byte[] transact(byte[] inPkt) throws PtException
inPkt
- Packet, which has to be submitted to FM
PtException
- Error code of fail, if any was occured.void updateFingerPayload(int slotNr, int offset, byte[] data) throws PtException
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.
PtException
- Error code of fail, if any was occured.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
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.
PtException
- Error code of fail, if any was occured.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
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.
PtException
- Error code of fail, if any was occured.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
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.
PtException
- Error code of fail, if any was occured.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
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.
PtException
- Error code of fail, if any was occured.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
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.
PtException
- Error code of fail, if any was occured.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |