com.senter.function.openapi.unstable

Class FingerprintB.ModuleMode1Api2

java.lang.Object

com.senter.function.openapi.unstable.FingerprintB.ModuleMode1Api2

Enclosing class:

FingerprintB

public static final class FingerprintB.ModuleMode1Api2
extends java.lang.Object

operating class corresponding to FingerprintB.ModuleMode.ModuleMode1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FingerprintB.ModuleMode1Api2.ErrorCode Error code
static class	FingerprintB.ModuleMode1Api2.FingerprintCharacter Fingerprint character
static class	FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer Fingerprint character buffer
static class	FingerprintB.ModuleMode1Api2.FingerprintImage Fingerprint image
static class	FingerprintB.ModuleMode1Api2.LibraryStorageInfo Library storage info
static class	FingerprintB.ModuleMode1Api2.NotePage Note page,every module has 512 note pages,every note page contains 32 bytes.
static class	FingerprintB.ModuleMode1Api2.Password Password
static class	FingerprintB.ModuleMode1Api2.Result Some define of operation result

Method Summary

Modifier and Type	Method and Description
FingerprintB.ModuleMode1Api2.ErrorCode	deleteAllTemplatesOnChip() delete all templates in library
FingerprintB.ModuleMode1Api2.ErrorCode	deleteTemplatesOnChip(int templateStartIndex, int count) delete specified templates in library
FingerprintB.ModuleMode1Api2.Result.ResultOfGenerateARandomNumber	generateARandomNumber() get a random number
FingerprintB.ModuleMode1Api2.ErrorCode	generateCharacterByImageOnChip(int destinationCharacterBuffer) generate character by image on chip
FingerprintB.ModuleMode1Api2.Result.ResultOfGetCharacter	getCharacter(int sourceCharacterBuffer) get FingerprintB.ModuleMode1Api2.FingerprintCharacter from FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip
FingerprintB.ModuleMode1Api2.Result.ResultOfGetCountOfTemplatesInLibrary	getCountOfTemplatesInLibrary() get count of template in library
FingerprintB.ModuleMode1Api2.Result.ResultOfGetImage	getImage() get FingerprintB.ModuleMode1Api2.FingerprintImage from fingerprint image buffer on chip
FingerprintB.ModuleMode1Api2.FingerprintImage	getImage(java.io.File sourceBmpFile) get FingerprintB.ModuleMode1Api2.FingerprintImage from Fingerprint BMP file
FingerprintB.ModuleMode1Api2.Result.ResultOfGetLibraryStorageInfo	getLibraryStorageInfo() get FingerprintB.ModuleMode1Api2.LibraryStorageInfo from fingerprint image buffer on chip
FingerprintB.ModuleMode1Api2.ErrorCode	init() Deprecated.
FingerprintB.ModuleMode1Api2.ErrorCode	init(FingerprintB.ModuleMode1Api2.Password password) initialize fingerprint device
FingerprintB.ModuleMode1Api2.ErrorCode	loadCharacter(int destinationCharacterBuffer, java.io.File sourceCharacterFile) Deprecated.
FingerprintB.ModuleMode1Api2.ErrorCode	loadCharacter(int destinationCharacterBuffer, FingerprintB.ModuleMode1Api2.FingerprintCharacter sourceTemplate) Deprecated.
FingerprintB.ModuleMode1Api2.ErrorCode	loadCharacter(int destinationCharacterBuffer, int sourceTemplateIndexInLibrary) load the specified template in library to FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip
FingerprintB.ModuleMode1Api2.ErrorCode	loadImage(FingerprintB.ModuleMode1Api2.FingerprintImage sourceImage) Deprecated.
FingerprintB.ModuleMode1Api2.Result.ResultOfMatchCharacterBufferAAndB	matchCharacterBufferAAndB() match FingerprintB.ModuleMode1Api2.FingerprintCharacters in FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB
FingerprintB.ModuleMode1Api2.ErrorCode	mergeCharacterBufferAAndB() mege FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB,if successed, the contents in FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB are same
FingerprintB.ModuleMode1Api2.Result.ResultOfReadNotePage	readNotePage(int sourceUserInfoIndex) read note page in notepad at the sepcified index
FingerprintB.ModuleMode1Api2.ErrorCode	saveCharacter(int sourceCharacterBuffer, java.io.File destinationCharacterFile) save FingerprintB.ModuleMode1Api2.FingerprintCharacter in specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer to file
FingerprintB.ModuleMode1Api2.ErrorCode	saveCharacter(int sourceCharacterBuffer, int destinationTemplateIndexInLibrary) save FingerprintB.ModuleMode1Api2.FingerprintCharacter in specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer to library at the specified index
FingerprintB.ModuleMode1Api2.ErrorCode	saveImage(FingerprintB.ModuleMode1Api2.FingerprintImage sourceImage, java.io.File destinationBmpFile) save FingerprintB.ModuleMode1Api2.FingerprintImage to BMP file
FingerprintB.ModuleMode1Api2.Result.ResultOfSearch	search(int characterBufferOfSample, int templateIndexOfLibrary, int templateCount) search the specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer in library
FingerprintB.ModuleMode1Api2.Result.ResultOfSearchFast	searchFast(int characterBufferOfSample, int templateIndexOfLibrary, int templateCount) fast search the specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer in library
FingerprintB.ModuleMode1Api2.ErrorCode	setPassword(FingerprintB.ModuleMode1Api2.Password password) set FingerprintB.ModuleMode1Api2.Password
FingerprintB.ModuleMode1Api2.ErrorCode	setSecurityLevel(int securityLevel) set security level
FingerprintB.ModuleMode1Api2.ErrorCode	tryCaptureFingerprintOnSensor() try to collect fingerprint imgage on sensor
void	uninit() uninitialize
FingerprintB.ModuleMode1Api2.ErrorCode	verifyPassword(FingerprintB.ModuleMode1Api2.Password password) Verify the password
FingerprintB.ModuleMode1Api2.ErrorCode	writeNotePage(int destinationNotePageIndex, FingerprintB.ModuleMode1Api2.NotePage userInfo) write FingerprintB.ModuleMode1Api2.NotePage into notepad at the sepcified index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

@Deprecated
public FingerprintB.ModuleMode1Api2.ErrorCode init()

Deprecated.

initialize fingerprint device

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

init

public FingerprintB.ModuleMode1Api2.ErrorCode init(FingerprintB.ModuleMode1Api2.Password password)

initialize fingerprint device

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

uninit

public void uninit()

uninitialize

tryCaptureFingerprintOnSensor

public FingerprintB.ModuleMode1Api2.ErrorCode tryCaptureFingerprintOnSensor()

try to collect fingerprint imgage on sensor

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

generateCharacterByImageOnChip

public FingerprintB.ModuleMode1Api2.ErrorCode generateCharacterByImageOnChip(int destinationCharacterBuffer)

generate character by image on chip

Parameters:

destinationCharacterBuffer - destination FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer used to store character,[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

matchCharacterBufferAAndB

public FingerprintB.ModuleMode1Api2.Result.ResultOfMatchCharacterBufferAAndB matchCharacterBufferAAndB()

match FingerprintB.ModuleMode1Api2.FingerprintCharacters in FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB

Returns:

ResultOfMatchCharacterBufferAAndB

search

public FingerprintB.ModuleMode1Api2.Result.ResultOfSearch search(int characterBufferOfSample,
                                                                 int templateIndexOfLibrary,
                                                                 int templateCount)

search the specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer in library

Parameters:

characterBufferOfSample - FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer contains the sample character

templateIndexOfLibrary - start index in library,[0-999]

templateCount - count,[1-1000],(templateIndexOfLibrary+templateCount)<=1000

Returns:

ResultOfSearch

mergeCharacterBufferAAndB

public FingerprintB.ModuleMode1Api2.ErrorCode mergeCharacterBufferAAndB()

mege FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB,if successed, the contents in FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB are same

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

saveCharacter

public FingerprintB.ModuleMode1Api2.ErrorCode saveCharacter(int sourceCharacterBuffer,
                                                            int destinationTemplateIndexInLibrary)

save FingerprintB.ModuleMode1Api2.FingerprintCharacter in specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer to library at the specified index

Parameters:

sourceCharacterBuffer - source FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer,[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

destinationTemplateIndexInLibrary - destination index in library

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

loadCharacter

public FingerprintB.ModuleMode1Api2.ErrorCode loadCharacter(int destinationCharacterBuffer,
                                                            int sourceTemplateIndexInLibrary)

load the specified template in library to FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip

Parameters:

destinationCharacterBuffer - destination FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

sourceTemplateIndexInLibrary - index of source template will be loaded

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

getCharacter

public FingerprintB.ModuleMode1Api2.Result.ResultOfGetCharacter getCharacter(int sourceCharacterBuffer)

get FingerprintB.ModuleMode1Api2.FingerprintCharacter from FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip

Parameters:

sourceCharacterBuffer - source {@link FingerprintCharacterBuffer},[{@link FingerprintCharacterBuffer#CharacterBufferA}、{@link FingerprintCharacterBuffer#CharacterBufferB}、{@link FingerprintCharacterBuffer#ModelBuffer}]

Returns:

ResultOfGetCharacter

loadCharacter

@Deprecated
public FingerprintB.ModuleMode1Api2.ErrorCode loadCharacter(int destinationCharacterBuffer,
                                                                         FingerprintB.ModuleMode1Api2.FingerprintCharacter sourceTemplate)

Deprecated.

load the specified FingerprintB.ModuleMode1Api2.FingerprintCharacter to FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip

Parameters:

destinationCharacterBuffer - destination FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

sourceTemplate - source template

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

getImage

public FingerprintB.ModuleMode1Api2.Result.ResultOfGetImage getImage()

get FingerprintB.ModuleMode1Api2.FingerprintImage from fingerprint image buffer on chip

Returns:

ResultOfGetImage

loadImage

@Deprecated
public FingerprintB.ModuleMode1Api2.ErrorCode loadImage(FingerprintB.ModuleMode1Api2.FingerprintImage sourceImage)

Deprecated.

load specified FingerprintB.ModuleMode1Api2.FingerprintImage to fingerprint image buffer on chip

Parameters:

sourceImage - source fingerprint image

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

saveImage

public FingerprintB.ModuleMode1Api2.ErrorCode saveImage(FingerprintB.ModuleMode1Api2.FingerprintImage sourceImage,
                                                        java.io.File destinationBmpFile)
                                                 throws java.io.IOException

save FingerprintB.ModuleMode1Api2.FingerprintImage to BMP file

Parameters:

sourceImage - source FingerprintB.ModuleMode1Api2.FingerprintImage would be saved

destinationBmpFile - destination bmp file name,absolute path

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

Throws:

java.io.IOException

getImage

public FingerprintB.ModuleMode1Api2.FingerprintImage getImage(java.io.File sourceBmpFile)

get FingerprintB.ModuleMode1Api2.FingerprintImage from Fingerprint BMP file

Parameters:

sourceBmpFile - File name need to be read

Returns:

Returns FingerprintB.ModuleMode1Api2.FingerprintImage on success or null otherwise

deleteTemplatesOnChip

public FingerprintB.ModuleMode1Api2.ErrorCode deleteTemplatesOnChip(int templateStartIndex,
                                                                    int count)

delete specified templates in library

Parameters:

templateStartIndex - first template index need to be deleted[0-999]

count - count of template need to be deleted,[1-1000],(templateStartIndex+count)<=1000

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

deleteAllTemplatesOnChip

public FingerprintB.ModuleMode1Api2.ErrorCode deleteAllTemplatesOnChip()

delete all templates in library

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

searchFast

public FingerprintB.ModuleMode1Api2.Result.ResultOfSearchFast searchFast(int characterBufferOfSample,
                                                                         int templateIndexOfLibrary,
                                                                         int templateCount)

fast search the specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer in library

Parameters:

characterBufferOfSample - FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer contains the sample character

templateIndexOfLibrary - start index in library,[0-999]

templateCount - count,[1-1000],(templateIndexOfLibrary+templateCount)<=1000

Returns:

ResultOfSearchFast

getCountOfTemplatesInLibrary

public FingerprintB.ModuleMode1Api2.Result.ResultOfGetCountOfTemplatesInLibrary getCountOfTemplatesInLibrary()

get count of template in library

Returns:

ResultOfGetCountOfTemplatesInLibrary

setPassword

public FingerprintB.ModuleMode1Api2.ErrorCode setPassword(FingerprintB.ModuleMode1Api2.Password password)

set FingerprintB.ModuleMode1Api2.Password

Parameters:

password - FingerprintB.ModuleMode1Api2.Password

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

verifyPassword

public FingerprintB.ModuleMode1Api2.ErrorCode verifyPassword(FingerprintB.ModuleMode1Api2.Password password)

Verify the password

Parameters:

password - FingerprintB.ModuleMode1Api2.Password

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

readNotePage

public FingerprintB.ModuleMode1Api2.Result.ResultOfReadNotePage readNotePage(int sourceUserInfoIndex)

read note page in notepad at the sepcified index

Parameters:

sourceUserInfoIndex - index of note page in note pad,[0-511]

Returns:

ResultOfReadNotePage

writeNotePage

public FingerprintB.ModuleMode1Api2.ErrorCode writeNotePage(int destinationNotePageIndex,
                                                            FingerprintB.ModuleMode1Api2.NotePage userInfo)

write FingerprintB.ModuleMode1Api2.NotePage into notepad at the sepcified index

Parameters:

destinationNotePageIndex - destination note page index,[0-15]

userInfo - note pageFingerprintB.ModuleMode1Api2.NotePage

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

setSecurityLevel

public FingerprintB.ModuleMode1Api2.ErrorCode setSecurityLevel(int securityLevel)

set security level

Parameters:

securityLevel - Security level[1-5]

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

saveCharacter

public FingerprintB.ModuleMode1Api2.ErrorCode saveCharacter(int sourceCharacterBuffer,
                                                            java.io.File destinationCharacterFile)

save FingerprintB.ModuleMode1Api2.FingerprintCharacter in specified FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer to file

Parameters:

sourceCharacterBuffer - source FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer,[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

destinationCharacterFile - destination character file

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

loadCharacter

@Deprecated
public FingerprintB.ModuleMode1Api2.ErrorCode loadCharacter(int destinationCharacterBuffer,
                                                                         java.io.File sourceCharacterFile)

Deprecated.

load Character form file to FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer on chip

Parameters:

destinationCharacterBuffer - destination FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1Api2.FingerprintCharacterBuffer.CharacterBufferB]

sourceCharacterFile - soruce Character File

Returns:

FingerprintB.ModuleMode1Api2.ErrorCode.Ok on success or other FingerprintB.ModuleMode1Api2.ErrorCode otherwise

generateARandomNumber

public FingerprintB.ModuleMode1Api2.Result.ResultOfGenerateARandomNumber generateARandomNumber()

get a random number

Returns:

ResultOfGenerateARandomNumber

getLibraryStorageInfo

public FingerprintB.ModuleMode1Api2.Result.ResultOfGetLibraryStorageInfo getLibraryStorageInfo()

get FingerprintB.ModuleMode1Api2.LibraryStorageInfo from fingerprint image buffer on chip

Returns:

ResultOfGetLibraryStorageInfo