FingerPrint API: Difference between revisions

From wizarPOS
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Functions ==
== API Overview ==
When the third party application to use these apis, it must creat its' store space to store the fingerpirnts. The apis are some utility methods.
When the third party application to use these API, it must create its' store space to store the fingerpirnt. The API are some utility methods.
=== open ===
=== <big>open</big> ===
  <syntaxhighlight lang="c">int fp_open()</syntaxhighlight >
  <syntaxhighlight lang="c">int fp_open()</syntaxhighlight >
Open the fingerprint.
Open the fingerprint.
Line 12: Line 12:
|}
|}
   
   
=== close ===
 
=== <big>close</big> ===
   <syntaxhighlight lang="c">int fp_close()</syntaxhighlight >
   <syntaxhighlight lang="c">int fp_close()</syntaxhighlight >
Close the fingerprint device.
Close the fingerprint device.
The open and close apis are pair operations. If you don’t want to use this device, you should call the close api to release this device.
The open and close API are pair operations. If you don’t want to use this device, you should call the close API to release this device.


{|class="wizarpostable"
{|class="wizarpostable"
Line 24: Line 25:
|}
|}
   
   
=== get_fea===
 
=== <big>get_fea</big>===
   <syntaxhighlight lang="c">int fp_get_fea(unsigned char *pFeaBuffer, int nFeaLength, int *pRealFeaLength, int n_TimeOut_S)</syntaxhighlight >
   <syntaxhighlight lang="c">int fp_get_fea(unsigned char *pFeaBuffer, int nFeaLength, int *pRealFeaLength, int n_TimeOut_S)</syntaxhighlight >
Get the feature of fingerprint.
Get the feature of fingerprint.
Line 40: Line 42:
| nTimeOut_S || '''int:''' Timeout, unit of time:s
| nTimeOut_S || '''int:''' Timeout, unit of time:s
|}
|}
 
{|
|-
| 
|}


{|class="wizarpostable"
{|class="wizarpostable"
Line 49: Line 54:
|}
|}
   
   
=== getLastImage===
 
=== <big>getLastImage</big>===
   <syntaxhighlight lang="c">int fp_getLastImage(unsigned char *pImgBuffer,int nImgLength, int *pRealImaLength, int *pImgWidth, int *pImgHeight)</syntaxhighlight >
   <syntaxhighlight lang="c">int fp_getLastImage(unsigned char *pImgBuffer,int nImgLength, int *pRealImaLength, int *pImgWidth, int *pImgHeight)</syntaxhighlight >
Get the image of fingerprint.
Get the image of fingerprint.
Line 68: Line 74:
| pImgHeight || '''int *:''' The height of the image
| pImgHeight || '''int *:''' The height of the image
|}
|}
 
{|
|-
| 
|}


{|class="wizarpostable"
{|class="wizarpostable"
Line 77: Line 86:
|}
|}


=== match===
 
=== <big>match</big>===
   <syntaxhighlight lang="c">int fp_match(unsigned char *pFeaBuffer1, int nFea1Length, unsigned char *pFealBuffer2, int nFea2Length)</syntaxhighlight >
   <syntaxhighlight lang="c">int fp_match(unsigned char *pFeaBuffer1, int nFea1Length, unsigned char *pFealBuffer2, int nFea2Length)</syntaxhighlight >
Match the fingerprint.
Match the fingerprint.
Line 94: Line 104:
| nFea2Lenghth || '''int:''' The length of the feature
| nFea2Lenghth || '''int:''' The length of the feature
|}
|}
 
{|
|-
| 
|}


{|class="wizarpostable"
{|class="wizarpostable"
Line 100: Line 113:
!  scope="row" colspan="2" | Returns
!  scope="row" colspan="2" | Returns
|-
|-
|  int || The result code, >= 0, success; <0 [[Error_code|error code]].
|  int || The result code, >= 0, success, the percent of matched similarity; <0 [[Error_code|error code]].
|}
|}


=== cancel===
=== <big>cancel</big>===
   <syntaxhighlight lang="c">int fp_cancel ()</syntaxhighlight >
   <syntaxhighlight lang="c">int fp_cancel ()</syntaxhighlight >
Cancel the fingerprint device operation.
Cancel the fingerprint device operation.

Latest revision as of 09:33, 11 March 2019

API Overview

When the third party application to use these API, it must create its' store space to store the fingerpirnt. The API are some utility methods.

open

int fp_open()

Open the fingerprint.

Returns
int The result code, >= 0, success; <0 error code.


close

int fp_close()

Close the fingerprint device. The open and close API are pair operations. If you don’t want to use this device, you should call the close API to release this device.

Returns
int The result code, >= 0, success; <0 error code.


get_fea

int fp_get_fea(unsigned char *pFeaBuffer, int nFeaLength, int *pRealFeaLength, int n_TimeOut_S)

Get the feature of fingerprint. When the finger touch the fingerprint device, the feature of the fingerprint will be return.

Parameters
pFeaBuffer char *: The buffer to store the feature, not null
nFeaLength int: The length of the buffer
pRealFeaLength int *: Reture the real length of the buffer
nTimeOut_S int: Timeout, unit of time:s
Returns
int The result code, >= 0, success; <0 error code.


getLastImage

int fp_getLastImage(unsigned char *pImgBuffer,int nImgLength, int *pRealImaLength, int *pImgWidth, int *pImgHeight)

Get the image of fingerprint. When the finger touch the fingerprint device, the image of the fingerprint will be return.

Parameters
pImgBuffer char *: The image buffer
nImgLength int: The length of image buffer
pRealImaLength int *: The real length of the image buffer
pImgWidth int *: The width of the image
pImgHeight int *: The height of the image
Returns
int The result code, >= 0, success; <0 error code.


match

int fp_match(unsigned char *pFeaBuffer1, int nFea1Length, unsigned char *pFealBuffer2, int nFea2Length)

Match the fingerprint. Input the two feature of the fingerprint, it will get the result of match .

Parameters
pFeaBuffer1 char *: The feature of the old fingerprint
nFea1Length int: The length of the feature
pFeaBuffer2 char *: The feature of the new fingerprint
nFea2Lenghth int: The length of the feature
Returns
int The result code, >= 0, success, the percent of matched similarity; <0 error code.

cancel

int fp_cancel ()

Cancel the fingerprint device operation.

Returns
int The result code, >= 0, success; <0 error code.
Retrieved from "http://sdkwiki.wizarpos.com/index.php?title=FingerPrint_API&oldid=949"