FingerPrint API - Revision history

Mahong at 09:33, 11 March 2019

2019-03-11T09:33:56Z

← Older revision		Revision as of 09:33, 11 March 2019
Line 1:		Line 1:
	== API Overview ==		== 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.
	=== <big>open</big> ===		=== <big>open</big> ===
	<syntaxhighlight lang="c">int fp_open()</syntaxhighlight >		<syntaxhighlight lang="c">int fp_open()</syntaxhighlight >
Line 16:		Line 16:
	<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"

Mahong: /* match */

2018-05-03T02:23:02Z

match

← Older revision		Revision as of 02:23, 3 May 2018
Line 113:		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]].
	\|}		\|}


	=== <big>cancel</big>===		=== <big>cancel</big>===

Mahong at 07:28, 2 May 2018

2018-05-02T07:28:43Z

← Older revision		Revision as of 07:28, 2 May 2018
Line 1:		Line 1:
	== API Overview ==		== 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 apis, it must creat its' store space to store the fingerpirnts. The apis 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.
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 103:		Line 116:
	\|}		\|}

	=== 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.

Mahong: /* Functions */

2018-05-02T06:07:58Z

Functions

← Older revision		Revision as of 06:07, 2 May 2018
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 apis, it must creat its' store space to store the fingerpirnts. The apis are some utility methods.
	=== open ===		=== open ===

Mahong at 06:07, 2 May 2018

2018-05-02T06:07:11Z

Show changes

Mahong at 07:06, 19 April 2018

2018-04-19T07:06:33Z

← Older revision		Revision as of 07:06, 19 April 2018
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'''

Mahong: 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 ===..."

2018-04-13T06:30:32Z

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 ===..."

New page

== 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|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|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'' || The buffer to store the feature, not null
|-
| ''nFeaLength'' || The length of the buffer
|-
| ''pRealFeaLength'' || Reture the real length of the buffer
|-
| ''nTimeOut_S'' || Timeout, unit of time:s
|}

'''Returns'''

The result code, >= 0, success; <0 [[Error_code|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'' || The image buffer
|-
| ''nImgLength'' || The length of image buffer
|-
| ''pRealImaLength'' || The real length of the image buffer
|-
| ''pImgWidth'' || The width of the image
|-
| ''pImgHeight'' || The height of the image
|}
'''Returns'''

The result code, >= 0, success; <0 [[Error_code|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'' || The feature of the old fingerprint
|-
| ''nFea1Length'' || The length of the feature
|-
| ''pFeaBuffer2'' || The feature of the new fingerprint
|-
| ''nFea2Lenghth'' || The length of the feature
|}
'''Returns'''

The result code, >= 0, success; <0 [[Error_code|error code]].

=== cancel===
int fp_cancel ()
Cancel the fingerprint device operation.

'''Parameters'''

'''Returns'''

The result code, >= 0, success; <0 [[Error_code|error code]].