FingerprintB.ModuleMode1 (BaseLibrary_Function

java.lang.Object
- com.senter.function.openapi.unstable.FingerprintB.ModuleMode1

Enclosing class:

FingerprintB

Deprecated.
deprecated，please use FingerprintB.ModuleMode1Api2 instead
```
@Deprecated
public static final class FingerprintB.ModuleMode1
extends java.lang.Object
```
operating class corresponding to FingerprintB.ModuleMode.ModuleMode1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`FingerprintB.ModuleMode1.ErrorCode` Deprecated. Error code
`static class`	`FingerprintB.ModuleMode1.FingerprintCharacter` Deprecated. Fingerprint character
`static class`	`FingerprintB.ModuleMode1.FingerprintCharacterBuffer` Deprecated.
`static class`	`FingerprintB.ModuleMode1.FingerprintImage` Deprecated.
`static class`	`FingerprintB.ModuleMode1.FingerprintImageSize` Deprecated. Fingerprint image size，256288，256360
`static class`	`FingerprintB.ModuleMode1.NotePage` Deprecated. Note page,every module has 512 note pages,every note page contains 32 bytes.
`static class`	`FingerprintB.ModuleMode1.Password` Deprecated. Password
`static class`	`FingerprintB.ModuleMode1.Result` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`deleteAllTemplatesOnChip()` Deprecated.
`int`	`deleteTemplatesOnChip(int templateStartIndex, int count)` Deprecated.
`int`	`errorCode()` Deprecated.
`boolean`	`errorOk()` Deprecated.
`java.lang.Integer`	`generateARandomNumber()` Deprecated.
`int`	`generateCharacterByImageOnChip(int destinationCharacterBuffer)` Deprecated.
`FingerprintB.ModuleMode1.FingerprintCharacter`	`getCharacter(int sourceCharacterBuffer)` Deprecated.
`java.lang.Integer`	`getCountOfTemplatesInLibrary()` Deprecated.
`FingerprintB.ModuleMode1.FingerprintImage`	`getImage()` Deprecated.
`FingerprintB.ModuleMode1.FingerprintImage`	`getImage(java.io.File sourceBmpFile)` Deprecated.
`boolean`	`init(FingerprintB.ModuleMode1.Password password)` Deprecated.
`int`	`loadCharacter(int destinationCharacterBuffer, java.io.File sourceCharacterFile)` Deprecated.
`int`	`loadCharacter(int destinationCharacterBuffer, FingerprintB.ModuleMode1.FingerprintCharacter sourceTemplate)` Deprecated.
`int`	`loadCharacter(int destinationCharacterBuffer, int sourceTemplateIndexInLibrary)` Deprecated.
`int`	`loadImage(FingerprintB.ModuleMode1.FingerprintImage sourceImage)` Deprecated.
`FingerprintB.ModuleMode1.Result.ResultOfMatchCharacterBufferAAndB`	`matchCharacterBufferAAndB()` Deprecated.
`int`	`mergeCharacterBufferAAndBToModelBuffer()` Deprecated.
`FingerprintB.ModuleMode1.NotePage`	`readNotePage(int sourceUserInfoIndex)` Deprecated.
`protected int`	`readParTable(char[] pParTable)` Deprecated.
`int`	`saveCharacter(int sourceCharacterBuffer, java.io.File destinationCharacterFile)` Deprecated.
`int`	`saveCharacter(int sourceCharacterBuffer, int destinationTemplateIndexInLibrary)` Deprecated.
`int`	`saveImage(FingerprintB.ModuleMode1.FingerprintImage sourceImage, java.io.File destinationBmpFile)` Deprecated.
`java.lang.Integer`	`search(int characterBufferOfSample, int templateIndexOfLibrary, int templateCount)` Deprecated.
`java.lang.Integer`	`searchFast(int characterBufferOfSample, int templateIndexOfLibrary, int templateCount)` Deprecated.
`protected int`	`setBaudrate(int nBaudNum)` Deprecated. 设置波特率参数： nBaudNum：需设置的波特率大小（9600-57600）返回值： 0 为成功，其它返回值请参考错误返回码
`int`	`setImageSize(int imagesize)` Deprecated.
`protected int`	`setPacketSize(int nSize)` Deprecated. 27、设置数据包大小函数参数： nSize：需设置的数据包大小（32/64/128/256）返回值： 0 为成功，其它返回值请参考错误返回码
`int`	`setPassword(FingerprintB.ModuleMode1.Password password)` Deprecated.
`int`	`setSecurityLevel(int securityLevel)` Deprecated.
`int`	`tryCaptureFingerprintOnSensor()` Deprecated.
`int`	`uninit()` Deprecated.
`int`	`verifyPassword(FingerprintB.ModuleMode1.Password password)` Deprecated.
`int`	`writeNotePage(int destinationNotePageIndex, FingerprintB.ModuleMode1.NotePage userInfo)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - errorCode
```
@Deprecated
public int errorCode()
```
    Deprecated.
    
    FingerprintB.ModuleMode1.ErrorCode of last operation
    
    Returns:
    
    last operation FingerprintB.ModuleMode1.ErrorCode
  - errorOk
```
@Deprecated
public boolean errorOk()
```
    Deprecated.
    
    return whether last operation FingerprintB.ModuleMode1.ErrorCode is FingerprintB.ModuleMode1.ErrorCode
    
    Returns:
    
    true:if last operation successed,false:other condition
  - init
```
@Deprecated
public boolean init(FingerprintB.ModuleMode1.Password password)
```
    Deprecated.
  - setImageSize
```
@Deprecated
public int setImageSize(int imagesize)
```
    Deprecated.
    
    set image size
    
    Parameters:
    
    imagesize - [FingerprintB.ModuleMode1.FingerprintImageSize.ImageSize256x288,FingerprintB.ModuleMode1.FingerprintImageSize.ImageSize256x360]
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - uninit
```
@Deprecated
public int uninit()
```
    Deprecated.
    
    uninitialize
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - tryCaptureFingerprintOnSensor
```
@Deprecated
public int tryCaptureFingerprintOnSensor()
```
    Deprecated.
    
    try to collect fingerprint imgage on sensor
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - generateCharacterByImageOnChip
```
@Deprecated
public int generateCharacterByImageOnChip(int destinationCharacterBuffer)
```
    Deprecated.
    
    generate character by image on chip
    
    Parameters:
    
    destinationCharacterBuffer - destination FingerprintB.ModuleMode1.FingerprintCharacterBuffer used to store character,[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB]
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - matchCharacterBufferAAndB
```
@Deprecated
public FingerprintB.ModuleMode1.Result.ResultOfMatchCharacterBufferAAndB matchCharacterBufferAAndB()
```
    Deprecated.
    
    match FingerprintB.ModuleMode1.FingerprintCharacters in FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB
    
    Returns:
    
    Returns score on success or null otherwise
  - search
```
@Deprecated
public java.lang.Integer search(int characterBufferOfSample,
                                             int templateIndexOfLibrary,
                                             int templateCount)
```
    Deprecated.
    
    search the specified FingerprintB.ModuleMode1.FingerprintCharacterBuffer in library
    
    Parameters:
    
    characterBufferOfSample - FingerprintB.ModuleMode1.FingerprintCharacterBuffer contains the sample character
    
    templateIndexOfLibrary - start index in library,[0-999]
    
    templateCount - count,[1-1000],(templateIndexOfLibrary+templateCount)<=1000
    
    Returns:
    
    Returns template index on success or null otherwise
  - mergeCharacterBufferAAndBToModelBuffer
```
@Deprecated
public int mergeCharacterBufferAAndBToModelBuffer()
```
    Deprecated.
    
    mege FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA and FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB to FingerprintB.ModuleMode1.FingerprintCharacterBuffer.ModelBuffer
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - saveCharacter
```
@Deprecated
public int saveCharacter(int sourceCharacterBuffer,
                                      int destinationTemplateIndexInLibrary)
```
    Deprecated.
    
    save FingerprintB.ModuleMode1.FingerprintCharacter in specified FingerprintB.ModuleMode1.FingerprintCharacterBuffer to library at the specified index
    
    Parameters:
    
    sourceCharacterBuffer - source FingerprintB.ModuleMode1.FingerprintCharacterBuffer,[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.ModelBuffer]
    
    destinationTemplateIndexInLibrary - destination index in library
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - loadCharacter
```
@Deprecated
public int loadCharacter(int destinationCharacterBuffer,
                                      int sourceTemplateIndexInLibrary)
```
    Deprecated.
    
    load the specified template in library to FingerprintB.ModuleMode1.FingerprintCharacterBuffer on chip
    
    Parameters:
    
    destinationCharacterBuffer - destination FingerprintB.ModuleMode1.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB]
    
    sourceTemplateIndexInLibrary - index of source template will be loaded
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - getCharacter
```
@Deprecated
public FingerprintB.ModuleMode1.FingerprintCharacter getCharacter(int sourceCharacterBuffer)
```
    Deprecated.
    
    get FingerprintB.ModuleMode1.FingerprintCharacter from FingerprintB.ModuleMode1.FingerprintCharacterBuffer on chip
    
    Parameters:
    
    sourceCharacterBuffer - source {@link FingerprintCharacterBuffer},[{@link FingerprintCharacterBuffer#CharacterBufferA}、{@link FingerprintCharacterBuffer#CharacterBufferB}、{@link FingerprintCharacterBuffer#ModelBuffer}]
    
    Returns:
    
    Returns FingerprintB.ModuleMode1.FingerprintCharacter on success or null otherwise
  - loadCharacter
```
@Deprecated
public int loadCharacter(int destinationCharacterBuffer,
                                      FingerprintB.ModuleMode1.FingerprintCharacter sourceTemplate)
```
    Deprecated.
    
    load the specified FingerprintB.ModuleMode1.FingerprintCharacter to FingerprintB.ModuleMode1.FingerprintCharacterBuffer on chip
    
    Parameters:
    
    destinationCharacterBuffer - destination FingerprintB.ModuleMode1.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB]
    
    sourceTemplate - source template
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - getImage
```
@Deprecated
public FingerprintB.ModuleMode1.FingerprintImage getImage()
```
    Deprecated.
    
    get FingerprintB.ModuleMode1.FingerprintImage from fingerprint image buffer on chip
    
    Returns:
    
    Returns FingerprintB.ModuleMode1.FingerprintImage on success or null otherwise
  - loadImage
```
@Deprecated
public int loadImage(FingerprintB.ModuleMode1.FingerprintImage sourceImage)
```
    Deprecated.
    
    load specified FingerprintB.ModuleMode1.FingerprintImage to fingerprint image buffer on chip
    
    Parameters:
    
    sourceImage - source fingerprint image
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - saveImage
```
@Deprecated
public int saveImage(FingerprintB.ModuleMode1.FingerprintImage sourceImage,
                                  java.io.File destinationBmpFile)
```
    Deprecated.
    
    save FingerprintB.ModuleMode1.FingerprintImage to BMP file
    
    Parameters:
    
    sourceImage - source FingerprintB.ModuleMode1.FingerprintImage would be saved
    
    destinationBmpFile - destination bmp file name,absolute path
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - getImage
```
@Deprecated
public FingerprintB.ModuleMode1.FingerprintImage getImage(java.io.File sourceBmpFile)
```
    Deprecated.
    
    get FingerprintB.ModuleMode1.FingerprintImage from Fingerprint BMP file
    
    Parameters:
    
    sourceBmpFile - File name need to be read
    
    Returns:
    
    Returns FingerprintB.ModuleMode1.FingerprintImage on success or null otherwise
  - deleteTemplatesOnChip
```
@Deprecated
public int deleteTemplatesOnChip(int templateStartIndex,
                                              int count)
```
    Deprecated.
    
    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.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - deleteAllTemplatesOnChip
```
@Deprecated
public int deleteAllTemplatesOnChip()
```
    Deprecated.
    
    delete all templates in library
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - readParTable
```
@Deprecated
protected int readParTable(char[] pParTable)
```
    Deprecated.
    
    18、读参数表函数参数： pParTable：系统参数数据的存放地址返回值： 0 为成功，其它返回值请参考错误返回码
  - searchFast
```
@Deprecated
public java.lang.Integer searchFast(int characterBufferOfSample,
                                                 int templateIndexOfLibrary,
                                                 int templateCount)
```
    Deprecated.
    
    fast search the specified FingerprintB.ModuleMode1.FingerprintCharacterBuffer in library
    
    Parameters:
    
    characterBufferOfSample - FingerprintB.ModuleMode1.FingerprintCharacterBuffer contains the sample character
    
    templateIndexOfLibrary - start index in library,[0-999]
    
    templateCount - count,[1-1000],(templateIndexOfLibrary+templateCount)<=1000
    
    Returns:
    
    Returns template index on success or null otherwise
  - getCountOfTemplatesInLibrary
```
@Deprecated
public java.lang.Integer getCountOfTemplatesInLibrary()
```
    Deprecated.
    
    get count of template in library
    
    Returns:
    
    Returns template count on success or null otherwise
  - setPassword
```
@Deprecated
public int setPassword(FingerprintB.ModuleMode1.Password password)
```
    Deprecated.
    
    set FingerprintB.ModuleMode1.Password
    
    Parameters:
    
    password - FingerprintB.ModuleMode1.Password
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - verifyPassword
```
@Deprecated
public int verifyPassword(FingerprintB.ModuleMode1.Password password)
```
    Deprecated.
    
    Verify the password
    
    Parameters:
    
    password - FingerprintB.ModuleMode1.Password
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - readNotePage
```
@Deprecated
public FingerprintB.ModuleMode1.NotePage readNotePage(int sourceUserInfoIndex)
```
    Deprecated.
    
    read note page in notepad at the sepcified index
    
    Parameters:
    
    sourceUserInfoIndex - index of note page in note pad,[0-511]
    
    Returns:
    
    Returns FingerprintB.ModuleMode1.NotePage on success or null otherwise
  - writeNotePage
```
@Deprecated
public int writeNotePage(int destinationNotePageIndex,
                                      FingerprintB.ModuleMode1.NotePage userInfo)
```
    Deprecated.
    
    write FingerprintB.ModuleMode1.NotePage into notepad at the sepcified index
    
    Parameters:
    
    destinationNotePageIndex - destination note page index,[0-511]
    
    userInfo - note pageFingerprintB.ModuleMode1.NotePage
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - setBaudrate
```
protected int setBaudrate(int nBaudNum)
```
    Deprecated.
    
    设置波特率参数： nBaudNum：需设置的波特率大小（9600-57600）返回值： 0 为成功，其它返回值请参考错误返回码
  - setSecurityLevel
```
@Deprecated
public int setSecurityLevel(int securityLevel)
```
    Deprecated.
    
    set security level
    
    Parameters:
    
    securityLevel - Security level[1-5]
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - setPacketSize
```
protected int setPacketSize(int nSize)
```
    Deprecated.
    
    27、设置数据包大小函数参数： nSize：需设置的数据包大小（32/64/128/256）返回值： 0 为成功，其它返回值请参考错误返回码
  - saveCharacter
```
@Deprecated
public int saveCharacter(int sourceCharacterBuffer,
                                      java.io.File destinationCharacterFile)
```
    Deprecated.
    
    save FingerprintB.ModuleMode1.FingerprintCharacter in specified FingerprintB.ModuleMode1.FingerprintCharacterBuffer to file
    
    Parameters:
    
    sourceCharacterBuffer - source FingerprintB.ModuleMode1.FingerprintCharacterBuffer,[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB]
    
    destinationCharacterFile - destination character file
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - loadCharacter
```
@Deprecated
public int loadCharacter(int destinationCharacterBuffer,
                                      java.io.File sourceCharacterFile)
```
    Deprecated.
    
    load Character form file to FingerprintB.ModuleMode1.FingerprintCharacterBuffer on chip
    
    Parameters:
    
    destinationCharacterBuffer - destination FingerprintB.ModuleMode1.FingerprintCharacterBuffer，[FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferA、FingerprintB.ModuleMode1.FingerprintCharacterBuffer.CharacterBufferB]
    
    sourceCharacterFile - soruce Character File
    
    Returns:
    
    FingerprintB.ModuleMode1.ErrorCode.Ok on success or other FingerprintB.ModuleMode1.ErrorCode otherwise
  - generateARandomNumber
```
@Deprecated
public java.lang.Integer generateARandomNumber()
```
    Deprecated.
    
    get a random number
    
    Returns:
    
    a random number if successed,otherwise return null

Class FingerprintB.ModuleMode1

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

errorCode

errorOk

init

setImageSize

uninit

tryCaptureFingerprintOnSensor

generateCharacterByImageOnChip

matchCharacterBufferAAndB

search

mergeCharacterBufferAAndBToModelBuffer

saveCharacter

loadCharacter

getCharacter

loadCharacter

getImage

loadImage

saveImage

getImage

deleteTemplatesOnChip

deleteAllTemplatesOnChip

readParTable

searchFast

getCountOfTemplatesInLibrary

setPassword

verifyPassword

readNotePage

writeNotePage

setBaudrate

setSecurityLevel

setPacketSize

saveCharacter

loadCharacter

generateARandomNumber