FingerPrint API: Difference between revisions
(Created page with "== Functions == 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. === open ===...") |
No edit summary |
||
| Line 29: | Line 29: | ||
{| | {| | ||
|- | |- | ||
| ''pFeaBuffer'' || The buffer to store the feature, not null | | ''pFeaBuffer'' || char * || The buffer to store the feature, not null | ||
|- | |- | ||
| ''nFeaLength'' || The length of the buffer | | ''nFeaLength'' || int || The length of the buffer | ||
|- | |- | ||
| ''pRealFeaLength'' || Reture the real length of the buffer | | ''pRealFeaLength'' || int * || Reture the real length of the buffer | ||
|- | |- | ||
| ''nTimeOut_S'' || Timeout, unit of time:s | | ''nTimeOut_S'' || int || Timeout, unit of time:s | ||
|} | |} | ||
| Line 51: | Line 51: | ||
{| | {| | ||
|- | |- | ||
| ''pImgBuffer'' || The image buffer | | ''pImgBuffer'' || char * || The image buffer | ||
|- | |- | ||
| ''nImgLength'' || The length of image buffer | | ''nImgLength'' || int || The length of image buffer | ||
|- | |- | ||
| ''pRealImaLength'' || The real length of the image buffer | | ''pRealImaLength'' || int * || The real length of the image buffer | ||
|- | |- | ||
| ''pImgWidth'' || The width of the image | | ''pImgWidth'' || int * || The width of the image | ||
|- | |- | ||
| ''pImgHeight'' || The height of the image | | ''pImgHeight'' || int * || The height of the image | ||
|} | |} | ||
'''Returns''' | '''Returns''' | ||
| Line 73: | Line 73: | ||
{| | {| | ||
|- | |- | ||
| ''pFeaBuffer1'' || The feature of the old fingerprint | | ''pFeaBuffer1'' || char * || The feature of the old fingerprint | ||
|- | |- | ||
| ''nFea1Length'' || The length of the feature | | ''nFea1Length'' || int || The length of the feature | ||
|- | |- | ||
| ''pFeaBuffer2'' || The feature of the new fingerprint | | ''pFeaBuffer2'' || char * || The feature of the new fingerprint | ||
|- | |- | ||
| ''nFea2Lenghth'' || The length of the feature | | ''nFea2Lenghth'' || int || The length of the feature | ||
|} | |} | ||
'''Returns''' | '''Returns''' | ||
Revision as of 07:06, 19 April 2018
Functions
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.
open
int fp_open()
Open the fingerprint.
Parameters
Returns
The result code, >= 0, success; <0 error code.
close
int fp_close()
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.
Parameters
Returns
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
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
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
The result code, >= 0, success; <0 error code.
cancel
int fp_cancel ()
Cancel the fingerprint device operation.
Parameters
Returns
The result code, >= 0, success; <0 error code.