IBScanUltimate API Manual For Java (And Android)

Machine Translated by Google
Manuel IBScanUltimateAPI pour Java (et Android)

Version 3.9.1 (30 mai 2022)
Copyright @20112022, Integrated Biometrics LLC. Tous droits réservés

Manuel API pour Java (et Android)
Table des matières
HISTORIQUE DES RÉVISIONS ................................................ ....................................... 5
1. DESCRIPTION DES API.......................................................... ...................................... 7
1.1. Résumé de l'API Java................................................. .................................................................. ........................7
1.1.1. Résumé de la classe principale et des méthodes d'interface.................................................. ............................7
1.1.2. Résumé des classes imbriquées ............................................ .................................................................. .....9
1.1.3. Résumé des cours communs................................................................ .................................................................. dix
1.1.4. Classe IBScan............................................................ .................................................................. ...................... 11
1.1.4.1. Résumé................................................. .................................................................. ...................... 11
1.1.4.2. activerTraceLog()................................................................ .................................................................. ...........11
1.1.4.3. getDeviceCount()................................................. .................................................................. ...........11
1.1.4.4. getDeviceDescription().................................................. .................................................................. ..11
1.1.4.5. getInitProgress() .................................................. .................................................................. ............12
1.1.4.6. getInstance() .............................................. .................................................................. ..................12
1.1.4.7. getInstance(Context) (Android uniquement).......................................... ......................................12
1.1.4.8. getSdkVersion() .................................................. .................................................................. ............13
1.1.4.9. hasPermission() (Android uniquement)............................................. ......................................13
1.1.4.10. isScanDevice() (Android uniquement)............................................. ........................................13
1.1.4.11. openDevice(int) .................................................. .................................................................. ............14
1.1.4.12. openDevice(int, String)............................................ .................................................................. .....14
1.1.4.13. openDeviceAsync(int).......................................... .................................................................. ....15
1.1.4.14. openDeviceAsync(int, String) ............................................ ........................................15
1.1.4.15. requestPermission() (Android uniquement) ............................................ ......................................15
1.1.4.16. setContext() (Android uniquement) ............................................ ......................................................16
1.1.4.17. setScanListener() .................................................. .................................................................. ...........16
1.1.4.18. déchargerBibliothèque()................................................ .................................................................. ..............16
1.1.4.19. updateUsbPermission()(Android uniquement)........................................... ................................17
1.1.4.20. getRequiredSDKVersion().................................................. ..................................................17
1.1.4.21. setClientClient()................................................. .................................................................. ..........17
1.1.4.22. getErrorString() .................................................. .................................................................. ............18
1.1.5. Classe IBScanDevice .................................................. .................................................................. ............19
1.1.5.1. Résumé................................................. .................................................................. ......................19
1.1.5.2. commencerCaptureImage()................................................................ .................................................................. .....19
1.1.5.3. calculerNfiqScore().................................................. .................................................................. ......19
1.1.5.4. annulerCaptureImage()................................................................ .................................................................. ....20
1.1.5.5. captureImage()............................................................ .................................................................. ............20
Page 1
1.1.5.6. captureImageExtended().................................................. .................................................................. 20
1.1.5.7. captureImageManuellement()................................................ .................................................................. 21
1.1.5.8. fermer() ............................................... .................................................................. ......................21
1.1.5.9. activerEvent().................................................. .................................................................. ............21
1.1.5.10. getContraste()................................................. .................................................................. ..................22
1.1.5.11. getLEDs() ............................................... .................................................................. ......................22
1.1.5.12. getLEOperationMode().................................................. .................................................................. ..22
1.1.5.13. getOperableLEDs().................................................. .................................................................. ........22
1.1.5.14. getPlatenStateAtCapture().................................................. ..................................................23
1.1.5.15. getProperty()............................................................ .................................................................. ..................23
1.1.5.16. getResultImageExt().................................................. .................................................................. ......23
1.1.5.17. getRollingInfo()................................................................ .................................................................. ............24
1.1.5.18. estCaptureActive()................................................................ .................................................................. ...........24
1.1.5.19. isCaptureAvailable().................................................. .................................................................. ......24
1.1.5.20. estFingerTouching() .................................................. .................................................................. ........25
1.1.5.21. est ouvert() ............................................... .................................................................. ......................25
1.1.5.22. setContraste()............................................................ .................................................................. ...................25
1.1.5.23. setLEDs().................................................. .................................................................. .......................26
1.1.5.24. setLEOperationMode().................................................. .................................................................. ..26
1.1.5.25. setProperty() ............................................................ .................................................................. ..................26
1.1.5.26. setPropertyReserved().................................................. .................................................................. ....27
1.1.5.27. setScanDeviceListener().................................................. .................................................................. 27
1.1.5.28. generateZoomOutImageEx().................................................. ......................................................27
1.1.5.29. wsqEncodeToFile().................................................. .................................................................. ........28
1.1.5.30. EnregistrerPngImage()................................................. .................................................................. ............29
1.1.5.31. EnregistrerJP2Image()................................................ .................................................................. ............29
1.1.5.32. EnregistrerBitmapImage ()............................................. .................................................................. ......30
1.1.5.33. getEnhancedImageReserved() .................................................. ......................................30
1.1.5.34. Valeurs de champ constantes ............................................ .................................................................. .....31
1.1.5.35. getCombineImage ()............................................................. .................................................................. ......31
1.1.5.36. getOperableBeeper().................................................. .................................................................. ......32
1.1.5.37. setBeeper()................................................. .................................................................. ......................32
1.1.5.38. getCombineImageEx().................................................. .................................................................. ...33
1.1.5.39. generateDisplayImage()............................................................ .................................................................. .33
1.1.5.40. supprimerFingerImage() .................................................. .................................................................. ....34
1.1.5.41. addFingerImage() .................................................. .................................................................. ..........35
1.1.5.42. isFingerDuplicate().................................................. .................................................................. ......35
1.1.5.43. isValidFingerGeometry().................................................. ......................................................36
1.1.5.44. SetEncryptionKey()................................................................ .................................................................. .......36
page 2
1.1.5.45. IsSpoofFingerDetected().................................................. .................................................................. 37

1.1.5.46. ConvertImageToISOANSI().................................................. ............................................37
1.1.6. Interface IBScanListener.................................................. .................................................................. ......38
1.1.6.1. Résumé................................................. .................................................................. ......................38

1.1.6.2. scanDeviceAttached() (Android uniquement)............................................. ......................................38
1.1.6.3. scanDeviceDetached() (Android uniquement) .............................................. ......................................38
1.1.6.4. scanDevicePermissionGranted() (Android)............................................ ......................38
1.1.6.5. scanDeviceCountChanged () .................................................. ......................................................39
1.1.6.6. scanDeviceInitProgress ().................................................. ......................................................39
1.1.6.7. scanDeviceOpenComplete ()............................................... ......................................................39
1.1.7. Interface IBScanDeviceListener.................................................. ......................................................40
1.1.7.1. Résumé................................................. .................................................................. ......................40

1.1.7.2. périphériqueCommunicationBroken().................................................. ......................................40
1.1.7.3. deviceImagePreviewAvailable().................................................. ......................................41
1.1.7.4. périphériqueFingerCountChanged().................................................. ......................................41
1.1.7.5. périphériqueFingerQualityChanged().................................................. ......................................41
1.1.7.6. périphériqueAcquisitionBegun().................................................. ..................................................42
1.1.7.7. périphériqueAcquisitionCompleted().................................................. ........................................42
1.1.7.8. périphériqueImageResultAvailable().................................................. ......................................42
1.1.7.9. deviceImageResultExtendedAvailable().................................................. ......................43
1.1.7.10. périphériquePlatenStateChanged().................................................. ............................................43
1.1.7.11. périphériqueWarningReceived().................................................. ......................................................44
1.1.7.12. périphériquePressedKeyButtons().................................................. ......................................................44
1.1.8. Classes imbriquées................................................. .................................................................. ......................45
1.1.8.1. Classe IBScan.DeviceDesc.......................................... ......................................................45
1.1.8.2. Classe IBScan.SdkVersion ............................................ ......................................................45
1.1.8.3. Énumération IBScan. Type de hachage................................................. ......................................45

1.1.8.4. Énumération IBScanDevice.EventType ............................................ ......................46
1.1.8.5. Énumération IBScanDevice.FingerCountState.......................................... ............46
1.1.8.6. Énumération IBScanDevice.FingerQualityState ............................................ ............47
1.1.8.7. Classe IBScanDevice.ImageData ............................................ .......................................47
1.1.8.8. Énumération IBScanDevice.ImageFormat ............................................ ......................48
1.1.8.9. Énumération IBScanDevice.ImageResolution ............................................ ............49
1.1.8.10. Énumération IBScanDevice.ImageType.......................................... ......................49

1.1.8.11. Classe IBScanDevice.LedState ............................................ ......................................49
1.1.8.12. Énumération IBScanDevice.LEOperationMode.......................................... ............50

1.1.8.13. Énumération IBScanDevice.PlatenState.......................................... ......................50
1.1.8.14. Énumération IBScanDevice.PropertyId.......................................... ........................50
1.1.8.15. Classe IBScanDevice.RollingData ............................................ ......................................55
page 3
1.1.8.16. Énumération IBScanDevice.RollingState.......................................... ......................55
1.1.8.17. Classe IBScanDevice.SegmentPosition.......................................................... ........................55
1.1.8.18. Énumération IBScanDevice.CombineImageWhichHand ............................................... .56
1.1.8.19. Énumération IBScanDevice.EncyptionMode ............................................ ...................56

1.1.9. Classes imbriquées communes .................................................. .................................................................. .......57
1.1.9.1. Classe IBCommon.ImageDataExt.............................................. ......................................57

1.1.9.2. Énumération IBCommon.ImageFormat ............................................ ......................57
1.1.9.3. Énumération IBCommon.ImpressionType ............................................ .......................58
1.1.9.4. Énumération IBCommon.FingerPosition ............................................ ......................59
1.1.9.5. Énumération IBCommon.CaptureDeviceTechId ............................................ ..............60
1.1.9.6. Classe IBCommon.StandardFormatData.......................................... ......................61
1.1.9.7. Énumération IBCommon.StandardFormat ............................................ .......................62
page 4
Historique des révisions
Date Remarques de l'auteur
2022/05 Milton [IBScanUltimate v3.9.0]

Ajout du champ « imageDataLength » dans la classe imbriquée IBCommon.ImageDataExt.
Ajout d'une description de la nouvelle classe imbriquée

IBCommon StandardFormatData.
Ajout d'une description du nouveau IBCommon imbriqué

énumération StandardFormat.
Ajout d'une description de la nouvelle méthode IBScanDevice

ConvertImageToISOANSI().
2022/02 Milton Modifications des valeurs PropertyID pour IBScanUltimate v3.8.1

L'ID de propriété a changé de VERTICAL_DIRECTION_SEGMENT
Vers DISABLE_SEGMENT_ROTATION
2021/09 Milton Ajout d'une description de la nouvelle méthode IBScanDevice

IsSpoofFingerDetected()
2020/09 Milton Ajout de descriptions de la nouvelle méthode IBScan setCustomerKey()

Ajout de descriptions de la nouvelle méthode IBScan getErrorString()
Ajout de descriptions du nouveau HashType d'énumération imbriquée IBScan
2020/08 Milton Ajout de descriptions des nouvelles valeurs PropertyID pour IBScanUltimate
v3.5.0
ADAPTIVE_CAPTURE_MODE,
ENABLE_KOJAK_BEHAVIOR_2_6
2020/04 Éthan Ajout de descriptions des nouvelles valeurs d'ID de propriété liées au rôle
pour IBScanUltimate v3.3.0
FINGERPRINT_SEGMENTATION_MODE,
ROLL_METHOD,
RENEWAL_OPPOSITE_IMGAE_LEVEL,
PREVIEW_IMAGE_QUALITY_FOR_KOJAK
2020/01 Milton Ajout de descriptions des nouvelles valeurs PropertyID pour IBScanUltimate
v3.2.0 : IS_SPOOF_SUPPORTED, ENABLE_SPOOF,
SPOOF_LEVEL
2019/06 Milton a ajouté la méthode SetEncryption() sur Android
Ajout d'une description du nouveau IBScanDevice imbriqué

énumération EncryptionMode
2018/11 Milton Ajout d'une description de la nouvelle méthode IBScan getRequiredSDKVersion()
Ajout de la méthode SavePngImage() sur Android
Ajout de la méthode SaveJP2Image() sur Android
Ajout de la méthode SaveBitmapImage() sur Android
2018/4 YOUNG Ajout d'une description de la nouvelle méthode IBScanDevice

generateDisplayImage()
Ajout d'une description de la nouvelle méthode IBScanDevice removeFingerImage()
page 5
Ajout d'une description de la nouvelle méthode IBScanDevice addFingerImage()
Description ajoutée de la nouvelle méthode IBScanDevice isFingerDuplicate()
Description ajoutée de la nouvelle méthode IBScanDevice

isValidFingerGeometry()
Ajout d'une description de la nouvelle méthode IBScanDevice SaveBitmapImage()
2017/4 Gon Ajout d'une description de la nouvelle méthode IBScanDevice

getCombineImageEx().
Ajout de descriptions des nouvelles valeurs PropertyID pour IBScanUltimate v1.9.6 :.

NO_PREVIEW_IMAGE, ROLL_IMAGE_OVERRIDE,
Warning_MESSAGE_INVALID_AREA,
ENABLE_WET_FINGER_DETECT, WET_FINGER_DETECT_LEVE.
Ajout de descriptions des nouvelles valeurs FingerQualityState pour

IBScanUltimate v1.9.6 : INVALID_AREA_BOTTOM.
Ajout des descriptions du nouveau code d'avertissement pour IBScanUltimate v1.9.6 :

QUALITÉ_INVALID_AREA,
QUALITÉ_INVALID_AREA_HORIZONTALLY,
QUALITÉ_INVALID_AREA_VERTICALLY,
QUALITÉ_INVALID_AREA_HORIZONTALLY_VERTICALLY,
INVALID_BRIGHTNESS_FINGERS, WET_FINGERS
2016/4 Yesica Ajout de descriptions des nouvelles valeurs PropertyID pour IBScanUltimate
v1.9.3 : ROLLED_IMAGE_WIDTH et ROLLED_IMAGE_HEIGHT.
2015/12 Yesica Ajout d'une description de la nouvelle méthode IBScanDevice getOperableBeeper ().
Ajout d'une description de la nouvelle méthode IBScanDevice setBeeper ().
Ajout d'une description de la nouvelle méthode IBScanDeviceListener

devicePressedKeyButtons ().
2015/8 Yesica Ajout d'une description de la nouvelle méthode IBScanDevice getCombineImage ().
Ajout d'une description de la nouvelle énumération imbriquée IBScanDevice

CombineImageWhichHand.
INTERDICTION 2013/10 Ajout de descriptions des nouvelles valeurs PropertyID pour IBScanUltimate v1.7.0 :
CAPTURE_TIMEOUT et ROLL_MIN_WIDTH.
Ajout de descriptions des nouvelles valeurs FingerQualityState pour

IBScanUltimate v1.7.0 : INVALID_AREA_TOP, INVALID_AREA_LEFT, INVALID_AREA_RIGHT.
Ajout d'une description de la nouvelle méthode IBScanDevice

captureImageExtended().
Ajout d'une description de la nouvelle classe imbriquée IBScanDevice SegmentPosition.
Ajout d'une description de la nouvelle méthode IBScanDeviceListener

deviceImageResultExtendedAvailable().
Ajout d'une description de la nouvelle méthode IBScanDevice activateEvent().
Ajout d'une description du nouveau EventType d'énumération imbriquée

IBScanDevice.
page 6
1. Descriptions des API

1.1. Résumé de l'API Java
L'API Java d'IBScanUltimate est contenue dans le package com.integratedbiometrics.ibscanultimate. Des
définitions communes supplémentaires sont contenues dans le package
com.integratedbiometrics.ibscancommon.
Certaines méthodes, marquées d'astérisques, sont disponibles uniquement sur Android.
1.1.1. Résumé de la classe principale et des méthodes d'interface
Aucune méthode
Méthodes IBScan (toutes plateformes)

1 public void activateLogTrace (boolean on) lance IBScanException
2 public int getDeviceCount() lance IBScanException
3 public IBScan.DeviceDesc getDeviceDescription (int deviceIndex) lance IBScanException
4 public int getInitProgress (int deviceIndex) lance IBScanException
5 IBScan statique public getInstance()
6* IBScan statique public getInstance ( contexte contextuel)

7 public IBScan.SdkVersion getSdkVersion() lance IBScanException
8* public booléen hasPermission(int deviceId)
9* isScanDevice booléen statique public ( périphérique UsbDevice)
10 public IBScanDevice openDevice (int deviceIndex) lance IBScanException

11 public IBScanDevice openDevice (int deviceIndex, String uniformityMaskPath)
lance IBScanException
12 public void openDeviceAsync (int deviceIndex) lance IBScanException
13 lancements de public void openDeviceAsync (int deviceIndex, String uniformityMaskPath)

IBScanException
14* public void requestPermission(int deviceId)
15* public void setContext ( contexte contextuel)
16 public void setScanListener (écouteur IBScanListener)
17 chaînes publiques getRequiredSDKVersion (final int deviceIndex) lancées

IBScanException
Méthodes IBScanDevice
1 public void beginCaptureImage (IBScanDevice.ImageType imageType,

IBScanDevice.ImageResolution imageResolution, int captureOptions) lève IBScanException
2 public int calculateNfiqScore ( image ImageData) lance IBScanException

3 public void CancelCaptureImage() lance IBScanException
4 public java.lang.Object[] captureImage() lance IBScanException
5 public java.lang.Object[] captureImageExtended() lance IBScanException
page 7
6 public void captureImageManually() lance IBScanException

7 public void close() lance IBScanException
8 public void activateEvent ( événement EventType, activation booléenne) lance
IBScanException
9 public int getContrast() lance IBScanException
10 getLEDs longs publics () lèvent IBScanException

11 public IBScanDevice.LEOperationMode getLEOperationMode() lance IBScanException
12 publics IBScanDevice.LedState getOperableLEDs() lance IBScanException
13 public IBScanDevice.PlatenState getPlatenStateAtCapture() lance IBScanException
14 La chaîne publique getProperty (IBScanDevice.PropertyId propertyId) lève

IBScanException
15 objet public[] getResultImageInfo(IBCommon.FingerPosition fingerPosition)

16 public IBScanDevice.RollingData getRollingInfo() lance IBScanException
17 public boolean isCaptureActive() lance IBScanException
18 public booléen isCaptureAvailable (IBScanDevice.ImageType imageType,

IBScanDevice.ImageResolution imageResolution) lance IBScanException
19 isFingerTouching() booléen public lève IBScanException
20 booléen public isOpened()
21 public void setContrast(int contrastValue) lance IBScanException
22 setLED publics vides (longues LED actives) lancent IBScanException
23 public void setLEOperationMode(IBScanDevice.LEOperationMode leOperationMode)

24 public void setProperty (IBScanDevice.PropertyId propertyId, String propertyValue)

25 public void setScanDeviceListener (écouteur IBScanDeviceListener)
26 Objet public getCombineImage (IBScanDevice.ImageData inImage1,

IBScanDevice.ImageData inImage2,int whichHand)
27 Public int getOperableBeeper (BeeperType bType)
28 Public void setBeeper (BeepPattern bPattern, long soundTone, longue durée, long réservé_1,
long réservé_2)
29 public Object[] getCombineImageEx(IBScanDevice.ImageData inImage1,

IBScanDevice.ImageData inImage2,int whichHand)
30 public int generateDisplayImage (byte[] image, int inWidth, int inHeight,

byte[]outImage, int outWidth, int outHeight, byte bkColor, int outFormat, int
outQualityLevel, Boolean outVerticalFlip)
31 public int RemoveFingerImage (long fIndex)
32 public int addFingerImage (image IBScanDevice.ImageData, long fIndex,

IBScanDevice.ImageType imageType, boolean flagForce)
33 public long isFingerDuplicate (image IBScanDevice.ImageData, long fIndex,
page 8
IBScanDevice.ImageType imageType, int securityLevel)
34 public booléen isValidFingerGeometry (image IBScanDevice.ImageData, longue

fIndex, IBScanDevice.ImageType imageType)
Méthodes IBScanListener
1* void scanDeviceAttached (int deviceId)
2* void scanDeviceDetached (int deviceId)
3 void scanDeviceCountChanged (int deviceCount)
4 void scanDeviceInitProgress (int deviceIndex, int progressValue)
5 void scanDeviceOpenComplete (int deviceIndex, périphérique IBScanDevice,

exception IBScanException)
6* void scanDevicePermissionGranted (int deviceId, booléen accordé)

Méthodes IBScanDeviceListener
1 périphérique videCommunicationBroken ( périphérique IBScanDevice)
2 void deviceImagePreviewAvailable ( périphérique IBScanDevice,

IBScanDevice.ImageData)
3 void deviceFingerCountChanged ( périphérique IBScanDevice,

IBScanDevice.FingerCountState fingerState)
4 void deviceFingerQualityChanged ( périphérique IBScanDevice,

IBScanDevice.FingerQualityState[]fingerQualities)
5 void deviceAcquisitionBegun ( périphérique IBScanDevice, IBScanDevice.ImageType

type d'image)
6 void deviceAcquisitionCompleted ( périphérique IBScanDevice,

IBScanDevice.ImageType imageType)
7 void deviceImageResultAvailable ( périphérique IBScanDevice,

Image IBScanDevice.ImageData, IBScanDevice.ImageType imageType,
IBScanDevice.ImageData[] splitImageArray)
8 void deviceImageResultExtendedAvailable ( périphérique IBScanDevice, IBScanException

imageStatus, image IBScanDevice.ImageData, IBScanDevice.ImageType
imageType, int détectéFingerCount, IBScanDevice.ImageData[]
segmentImageArray, SegmentPosition[] segmentPositionArray)
9 void devicePlatenStateChanged ( périphérique IBScanDevice,

IBScanDevice.PlatenState platenState)
10 void deviceWarningReceived ( périphérique IBScanDevice, avertissement IBScanException)
11 void devicePressedKeyButtons ( périphérique IBScanDevice, int pressingKeyButtons)
Tableau 1
*
Disponible uniquement sur Android
1.1.2. Résumé des classes imbriquées

Pas de classe
Classes imbriquées IBScan
1 classe statique publique IBScan.DeviceDesc
page 9
2 classe statique publique IBScan.SdkVersion
Classes imbriquées IBScanDevice
1 énumération statique publique IBScanDevice.EventType
2 énumération statique publique IBScanDevice.FingerCountState
3 énumération statique publique IBScanDevice.FingerQualityState
4 classe statique publique IBScanDevice.ImageData
5 énumération statique publique IBScanDevice.ImageFormat
6 énumération statique publique IBScanDevice.ImageResolution
7 énumération statique publique IBScanDevice.ImageType
8 classe statique publique IBScanDevice.LedState
9 énumération statique publique IBScanDevice.LedType
10 énumération statique publique IBScanDevice.LEOperationMode
11 énumération statique publique IBScanDevice.PlatenState
12 énumération statique publique IBScanDevice.PropertyId
13 classe statique publique IBScanDevice.RollingData
14 énumération statique publique IBScanDevice.RollingState
15 classe statique publique IBScanDevice.SegmentPosition
Tableau 2
1.1.3. Résumé des classes communes

Pas de classe
Classes imbriquées IBCommon
1 classe statique publique IBCommon.ImageDataExt
2 énumération statique publique IBCommon.ImageFormat
3 énumération statique publique IBCommon.ImpressionType
4 énumération statique publique IBCommon.FingerPosition
5 énumération statique publique IBCommon.CaptureDeviceTechId
Tableau 3
page 10
1.1.4. Classe IBScan
1.1.4.1. Résumé
La seule instance de cette classe peut être obtenue avec getInstance(). L'application w
J'enregistre généralement un IBScanListener pour recevoir des notifications pour des événements tels que devic
Changement de compte et échec de communication de l'appareil. Les instances d'appareil doivent être obtenues
né par la méthode bloquante openDevice() ou la méthode non bloquante openDeviceAsync().
Sur Android, l'activité accédant aux scanners IB doit définir le contexte des opérations avec setContext().
Plusieurs autres fonctions spécifiques à Android sont fournies pour gérer les périphériques USB.
1.1.4.2. activerTraceLog()
• Signature
Méthode public void activateTraceLog (boolean on) lance IBScanException
• Description
Active ou désactive le journal de trace dans la bibliothèque native. Le journal de trace est activé par défaut.
• Paramètre
Paramètre Description
sur true pour activer le journal de trace ; false pour désactiver le journal de trace
1.1.4.3. getDeviceCount()
• Signature
Méthode public int getDeviceCount() lance IBScanException
• Description
Récupérez le nombre de périphériques scanner USB IB connectés. Seuls les appareils connectés pour
lesquels l'appelant a obtenu l'autorisation seront pris en compte.
• Retour
nombre de périphériques scanner USB IB
1.1.4.4. getDeviceDescription()
• Signature
Méthode public IBScan.DeviceDesc getDeviceDescription (int deviceIndex)
• Description
page 11
Récupérez des informations détaillées sur l'appareil sur un scanner particulier par index logique.
• Paramètre
deviceIndex index de base zéro de l'appareil
• Retour
une description de l'appareil
1.1.4.5. getInitProgress()
• Signature
Méthode public int getInitProgress (int deviceIndex) lance
IBScanException
• Description
Obtenez la progression de l’initialisation.
• Paramètre
indexappareil index de base zéro de l'appareil
• Retour
progression de l'initialisation entre 0 et 100. Une valeur de 100 indique que cette initialisation est terminée
1.1.4.6. getInstance()
• Signature
Méthode public statique IBScan getInstance()
• Description
Obtenez une seule instance de classe. Sur Android, un contexte doit être associé à l'instance via un appel
ultérieur à setContext().
• Retour
instance unique d'IBScan
1.1.4.7. getInstance (Contexte) (Android uniquement)
• Signature
Méthode public statique IBScan getInstance ( contexte contextuel)
page 12
• Description
Obtenez une seule instance de classe.
• Paramètre
contexte le contexte du récepteur et des accès USB
• Retour
instance unique d'IBScan
1.1.4.8. getSdkVersion()
• Signature
Méthode public IBScan.SdkVersion getSdkVersion() lance IBScanException
• Description
Obtient des informations sur la version du produit et du logiciel.
• Retour
Version du SDK
1.1.4.9. hasPermission() (Android uniquement)
• Signature
Méthode public booléen hasPermission (int deviceId)
• Description
Détermine si l'appelant est autorisé à accéder à l'appareil.
• Paramètre
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil, obtenu via la

Reference de l'appareil
méthode UsbDevice getDeviceId().
• Retour
true si l'appelant a l'autorisation ; faux sinon.
1.1.4.10. isScanDevice() (Android uniquement)
• Signature
Méthode isScanDevice booléen statique public ( périphérique UsbDevice)
page 13
• Description
Déterminez si le périphérique est un périphérique d'analyse. Cela vérifie simplement si les identifiants du fournisseur
et du produit correspondent aux appareils reconnus.
• Paramètre
appareil appareil pour enquêter
• Retour
true si le périphérique est un périphérique d'analyse IB ; faux sinon
1.1.4.11. openDevice(int)
• Signature
Méthode public IBScanDevice openDevice (int deviceIndex) lance
IBScanException
• Description
Initialiser le périphérique, en fonction d'un index particulier par périphérique. Cette fonction se bloque
jusqu'à ce qu'une erreur se produise ou que l'initialisation soit terminée ; pendant ce temps, tout
IBScanListener enregistré recevra des rappels scanDeviceInitProgress() pour suivre la progression
de l'initialisation. Soit un objet périphérique sera renvoyé à l'application, soit une exception sera levée.
• Paramètre
• Retour
objet périphérique, si l'initialisation réussit ; nul sinon
1.1.4.12. openDevice (int, chaîne)

• Signature
Méthode public IBScanDevice openDevice (int deviceIndex, chaîne
uniformityMaskPath) lance IBScanException
• Description
Voir aussi openDevice(int).
• Paramètre
page 14
uniformityMaskPath chemin du masque d'uniformité
• Retour
objet périphérique, si l'initialisation réussit ; nul sinon
1.1.4.13. openDeviceAsync(int)
• Signature
Méthode public void openDeviceAsync (int deviceIndex) lance
IBScanException
• Description
Initialisez le périphérique de manière asynchrone, en fonction d'un index particulier par périphérique. Cette fonction
retours immédiatement. Tous les rappels IBScanListener va reçoit des
scanDeviceInitProgress() enregistrés pour suivre la progression de l'initialisation. Lorsqu'une erreur se

produit ou que l'initialisation est terminée, scanDeviceOpenComplete() sera invoquée avec soit un objet
périphérique, soit une description de l'erreur survenue.
• Paramètre
1.1.4.14. openDeviceAsync (int, chaîne)
• Signature
Méthode public void openDeviceAsync (int deviceIndex, String
uniformityMaskPath) lance IBScanException
• Description
Voir aussi openDeviceAsync(int).
• Paramètre
uniformityMaskPath chemin du masque d'uniformité
1.1.4.15. requestPermission() (Android uniquement)
• Signature
Méthode public void requestPermission (int deviceId)
page 15
• Description
Demandez l’autorisation d’accéder à l’appareil. Le succès ou l'échec sera renvoyé à l'utilisateur via le rappel
scanDevicePermissionGranted() d'IBScanListener enregistré. Si l'autorisation n'a pas encore été accordée
au périphérique, une boîte de dialogue peut s'afficher à l'utilisateur.
• Paramètre
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil, obtenu via la méthode

UsbDevice getDeviceId().
1.1.4.16. setContext() (Android uniquement)
• Signature
Méthode public void setContext (contexte contextuel )
• Description
Définissez le contexte de cet IBScan. Cette fonction doit être appelée par une activité pour que les
périphériques scanner soient reconnus et accessibles. Lorsqu'une activité transfère le contrôle des scanners
IB à une autre, cette fonction doit être appelée avec un argument nul pour libérer la référence au contexte et
la désenregistrer en tant que récepteur USB.
• Paramètre
le contexte pour le récepteur et les accès USB. S'il est nul, le contexte
contexte existant ne sera toujours pas enregistré en tant que récepteur et le
la référence à celuici sera effacée.
1.1.4.17. setScanListener()
• Signature
Méthode public void setScanListener (écouteur IBScanListener)
• Description
Définir un écouteur pour les événements d'analyse.
• Paramètre
auditeur écouteur pour les événements d'analyse
1.1.4.18. déchargerBibliothèque()
• Signature
page 16
Méthode public void unloadLibrary()
• Description
Libérez manuellement la bibliothèque de l'espace d'adressage.
1.1.4.19. updateUsbPermission()(Android uniquement)
• Signature
Méthode public void updateUsbPermission()
• Description
Mettez à jour l'autorisation pour autoriser l'approche du bus USB connecté par la bibliothèque libusb. Il
est nécessaire de rooter l'appareil Android.
1.1.4.20. getRequiredSDKVersion()
• Signature
Méthode chaîne publique getRequiredSDKVersion (int deviceIndex)
• Description
Obtenez la version minimale du SDK requise pour l'exécution.
1.1.4.21. setClientClient()
• Signature
Méthode public void SetCustomerKey (final int deviceIndex, final HashType
hashtype, chaîne finale CustomerKey) lève IBScanException
• Description
Définissez la clé client pour exécuter l’appareil verrouillé.

Ceci doit être effectué sur l'appareil verrouillé avant d'ouvrir l'appareil
• Paramètre
Type de hachage Type de hachage
clé client customerKey correspondant aux informations de verrouillage écrites dans l'appareil verrouillé
page 17
1.1.4.22. getErrorString()
• Signature
Méthode public String getErrorString (final int errorCode) lance
IBScanException
• Description
Renvoie une description sous forme de chaîne du code d'erreur.
• Paramètre
code d'erreur Code d'erreur
• Retour
Description du code d'erreur sous forme de chaîne
page 18
1.1.5. Classe IBScanDevice
1.1.5.1. Résumé
Classe principale pour l'interface avec des scanners IB particuliers.
1.1.5.2. commencerCaptureImage()
• Signature
Méthode public void startCaptureImage (IBScanDevice.ImageType
imageType, IBScanDevice.ImageResolution imageResolution, int
captureOptions) lance IBScanException
• Description
Démarrez l’acquisition d’images pour l’appareil. Cette fonction sera renvoyée immédiatement, mais
IBScanDeviceListener de cet appareil informera l'application de la progression de l'analyse avec les
méthodes deviceFingerCountChanged(), deviceFingerQualityChanged, devicePlatenStateChanged()
et deviceImagePreviewAvailable(). Lorsqu'une analyse de qualité avec le nombre correct de doigts
est disponible ou que captureImageManually() abandonne prématurément l'analyse, la méthode
deviceImageResultAvailable() de l'auditeur fournira une analyse finale à l'application.
• Paramètre
type d'image le type d'image de l'image à acquérir
imageResolution la résolution de l'image à acquérir
une valeur bitmap indiquant les options de capture, composée de zéro

ou plusieurs options OU combinées
• Capture automatique OPTION_AUTO_CAPTURE

Options de capture
• Contraste automatique OPTION_AUTO_CONTRAST
• OPTION_IGNORE_FINGER_COUNT ignorer le doigt

compter
1.1.5.3. calculerNfiqScore()
• Signature
Méthode public int calculateNfiqScore ( image ImageData ) lance
IBScanException
• Description
Calculez le score NFIQ pour l’image. Le calcul est potentiellement long et
page 19
peut être effectué sur un thread d'arrièreplan.
• Paramètre
image l'image pour laquelle le score NFIQ sera calculé
• Retour
Le score NFIQ, compris entre 1 (le meilleur) et 5 (le pire), inclus.
1.1.5.4. annulerCaptureImage()
• Signature
Méthode public void CancelCaptureImage() lance IBScanException
• Description
Abandonnez l’acquisition d’images sur l’appareil. Après l'appel de beginCaptureImage(), la capture

d'image peut être interrompue prématurément avec cette fonction.
1.1.5.5. captureImage()
• Signature
Méthode public Object[] captureImage() lance IBScanException
• Description
Capturez une image à partir du scanner.
• Retour
un tableau contenant des informations sur l'image capturée. Le contenu du tableau renvoyé, dans
l'ordre, est
• Image ImageData : données d'image de l'image d'aperçu ou de l'image de résultat.
• ImageType imageType type d'image
• ImageData[] splitImageArray tableau de doigts séparé de l'image résultante
• FingerCountState fingerCountState état du nombre de doigts
• FingerQualityState[] qualityArray : états de qualité des doigts
1.1.5.6. captureImageExtended()
• Signature
Méthode public Object[] captureImageExtended() lance IBScanException
• Description
Capturez une image à partir du scanner, renvoyant des informations étendues.
• Retour
page 20
un tableau contenant des informations sur l'image capturée. Le contenu du tableau renvoyé, dans l'ordre,
est
• Statut de l'image IBScanException : statut de l'acquisition de l'image résultante
• Image ImageData : données d'image de l'image d'aperçu ou de l'image de résultat.
• ImageType imageType type d'image
• Entier détectéFIngerCount : nombre de doigts détectés
• ImageData[] segmentImageArray tableau de doigts séparé de l'image résultante
• SegmentPosition[] segmentPositionArray – données de position pour les doigts individuels

séparé de l'image de résultat
• FingerCountState fingerCountState état du nombre de doigts
• FingerQualityState[] qualityArray : états de qualité des doigts
1.1.5.7. captureImageManuellement()
• Signature
Méthode public void captureImageManually() lance IBScanException
• Description
Capturez l’image actuelle du scanner comme image de résultat. Après l'appel de beginCaptureImage(),
l'analyse se poursuit généralement jusqu'à ce qu'une analyse de qualité avec le nombre correct de doigts
soit disponible ou qu'une erreur se produise. Cette fonction mettra fin prématurément au processus et
renverra l'image actuelle du scanner à l'application avec la méthode deviceImageResultAvailable()
d'IBScanDeviceListener.
1.1.5.8. fermer()
• Signature
Méthode public void close() lance IBScanException
• Description
Libérez un appareil.
1.1.5.9. activerEvent()
• Signature
Méthode public void activateEvent ( événement EventType, activation booléenne) lance
IBScanException
• Description
Activez ou désactivez un événement de bas niveau pour cet appareil. Lorsqu'un appareil est ouvert, tous
les événements sont activés. La désactivation d'un événement désactivera effectivement la méthode
associée dans l'IBScanDeviceListener configuré.
• Paramètre
page 21
événement Événement à activer ou à désactiver
activer true pour activer l'événement ; false pour désactiver l'événement
1.1.5.10. getContraste()
• Signature
Méthode public int getContrast() lance IBScanException
• Description
Obtenez la valeur de contraste de l'appareil.
• Retour
valeur de contraste entre MIN_CONTRAST_VALUE et MAX_CONTRAST_VALUE, inclus
1.1.5.11. obtenir des LED()
• Signature
Méthode public long getLEDs() lance IBScanException
• Description
Obtenez les LED d'état actives de l'appareil.
• Retour
l'état bitmap des LED ; les bits définis indiquent les LED "on"
1.1.5.12. getLEOperationMode()
• Signature
Méthode public IBScanDevice.LEOperationMode getLEOperationMode()
• Description
Obtenez le mode de fonctionnement du film électroluminescent (LE) (Activé, Désactivé ou Auto) pour l'appareil.
• Retour
mode de fonctionnement du film électroluminescent
1.1.5.13. getOperableLEDs()
• Signature
Méthode public IBScanDevice.LedState getOperableLEDs() lance
IBScanException
page 22
• Description
Obtenez une description des voyants d'état opérationnels de l'appareil.
• Retour
une description des LED d'état
1.1.5.14. getPlatenStateAtCapture()
• Signature
Méthode public IBScanDevice.PlatenState getPlatenStateAtCapture()
• Description
Obtenez des informations sur l’état de la platine au démarrage de la capture.
• Retour
informations sur l'état de la platine
1.1.5.15. getProperty()
• Signature
Méthode chaîne publique getProperty (IBScanDevice.PropertyId propertyId)
• Description
Récupère une valeur de propriété du périphérique.
• Paramètre
ID de propriété l'identifiant de la propriété à obtenir
• Retour
la valeur de la propriété, sous forme de chaîne
1.1.5.16. getResultImageExt()
• Signature
Méthode objet public[] getResultImageExt(IBCommon.FingerPosition
fingerPosition) lance IBScanException
• Description
Obtenez des informations étendues sur l’image des résultats.
• Paramètre
page 23
fingerPosition position du ou des doigts capturés
• Retour
un tableau contenant des informations sur l'image capturée. Le contenu du tableau renvoyé, dans
l'ordre, est
• Image IBCommon.ImageDataExt : données d'image de l'image d'aperçu ou de l'image de

résultat.
• IBCommon.ImageDataExt[] splitImageArray tableau de doigts séparé de l'image résultante
1.1.5.17. getRollingInfo()
• Signature
Méthode public IBScanDevice.RollingData getRollingInfo() lance
IBScanException
• Description
Obtenez des informations sur l’état du roulement.
• Retour
informations sur l'état de roulement
1.1.5.18. estCaptureActive()
• Signature
Méthode public boolean isCaptureActive() lance IBScanException
• Description
Vérifiez si la capture est active sur l'appareil.
• Retour
true si la capture est active ; faux sinon
1.1.5.19. estCaptureAvailable()
• Signature
Méthode public booléen isCaptureAvailable (IBScanDevice.ImageType
imageType, IBScanDevice.ImageResolution imageResolution)
• Description
Vérifiez si le mode de capture demandé est pris en charge par l'appareil.
page 24
• Paramètre
type d'image le type d'image du mode à vérifier
imageResolution la résolution d'image du mode à vérifier
• Retour
true si le mode est pris en charge ; faux sinon
1.1.5.20. estFingerTouching()
• Signature
Méthode public boolean isFingerTouching() lance IBScanException
• Description
Détermine si un ou plusieurs doigts touchent actuellement le détecteur.
• Retour
vrai si un doigt est sur le détecteur ; faux sinon
1.1.5.21. est ouvert()
• Signature
Méthode public booléen isOpened()
• Description
Vérifiez si un périphérique particulier est ouvert/initialisé.
• Retour
true si le périphérique est ouvert ; faux sinon
1.1.5.22. setContraste()
• Signature
Méthode public void setContrast (int contrastValue) lance

IBScanException
• Description
Définissez la valeur de contraste de l'appareil.
• Paramètre
valeur de contraste entre MIN_CONTRAST_VALUE et

valeur de contraste
MAX_CONTRAST_VALUE, inclus, à définir
page 25
1.1.5.23. setLED()
• Signature
Méthode public void setLEDs (long activeLEDs) lance IBScanException
• Description
Définissez l'état actif des LED de l'appareil.
• Paramètre
l'état bitmap des LED ; Les bits définis indiquent que les LED doivent s'allumer,
LED actives
les bits clairs indiquent que les LED doivent s'éteindre.
1.1.5.24. setLEOperationMode()
• Signature
Méthode vide public
setLEOperationMode(IBScanDevice.LEOperationMode
leOperationMode) lance IBScanException
• Description
Réglez le mode de fonctionnement du film électroluminescent (LE) (On, Off ou Auto) sur l'appareil.
• Paramètre
leOperationMode mode de fonctionnement du film électroluminescent à définir
1.1.5.25. setProperty()
• Signature
Méthode public void setProperty (IBScanDevice.PropertyId propertyId,
String propertyValue) lance IBScanException
• Description
Définissez une valeur de propriété du périphérique.
• Paramètre
ID de propriété l'ID de la propriété à définir
propertyValue la valeur à définir pour la propriété, sous forme de chaîne
page 26
1.1.5.26. setPropertyReserved()
• Signature
Méthode public void setPropertyReserved (String réservéKey,
IBScanDevice.PropertyId propertyId, String propertyValue) lance IBScanException
• Description
Définissez une valeur de propriété réservée du périphérique. Il doit obtenir une clé réservée de
Integrated Biometrics pour utiliser cette méthode.
• Paramètre
réservéKey La clé réservée à définir pour la propriété, sous forme de chaîne
ID de propriété l'ID de la propriété à définir
propertyValue la valeur à définir pour la propriété, sous forme de chaîne
1.1.5.27. setScanDeviceListener()
• Signature
Méthode public void setScanDeviceListener (écouteur IBScanDeviceListener)
• Description
Enregistrez l'écouteur pour les événements de périphérique d'analyse.
• Paramètre
auditeur auditeur pour les événements
1.1.5.28. générerZoomOutImageEx()
• Signature
Méthode public int generateZoomOutImageEx (byte[] image, int inWidth, int
inHeight, octet[]outImage, int outWidth, int outHeight, octet bkColor)
• Description
Générez une version à l'échelle de l'image.
page 27
• Paramètre
image Données d'image originales
en largeur Largeur de l'image d'entrée
En hauteur Hauteur de l'image d'entrée
Pointeur vers le tampon qui recevra l’image de sortie. Ce tampon doit contenir au
Image de sortie
moins 'outWidth' x 'outHeight' octets
largeurextérieure Largeur de l'image de sortie
hauteurextérieure Hauteur de l'image de sortie
bkCouleur Couleur d’arrièreplan de l’image de sortie
1.1.5.29. wsqEncodeToFile()
• Signature
Méthode public int wsqEncodeToFile (String nom de fichier, octet[] image, int
largeur, hauteur int, pas int, int bitPerPixel, int pixelPerInch, double
bitrate, String commentText) lance IBScanException
• Description
Enregistrer WSQ compresse l'image d'empreinte digitale en niveaux de gris dans un chemin de fichier spécifique.
• Paramètre
Chemin du fichier pour enregistrer l'image compressée à partir de l'image originale par
nom de fichier
compression WSQ
largeur Largeur de l'image originale
hauteur Hauteur de l'image originale
Pas de ligne d'image (en octets). Une valeur positive indique un ordre de ligne
pas
descendant ; une valeur négative indique un ordre de ligne ascendant
bit par pixel Bits par pixel de l'image originale
pixelPerInch Pixel par pouce de l'image originale
Détermine le niveau de compression avec perte.
Paramètres suggérés :
Débit
bitRate = 2,25 donne une compression d'environ 5:1
bitRate = 0,75 donne une compression d'environ 15:1
page 28
commentText Commentaire pour écrire des données compressées
1.1.5.30. EnregistrerPngImage()
• Signature
Méthode public int SavePngImage (String filename, byte[] image, int width, int height, int
pitch, double resX, double resY) lance
IBScanException
• Description
Enregistrez l'image png dans un chemin de fichier spécifique.
• Paramètre
nom de fichier Chemin du fichier pour enregistrer l'image png
pas
resX Résolution d'image horizontale (en pixels/pouce)
résY Résolution verticale de l'image (en pixels/pouce)
1.1.5.31. EnregistrerJP2Image()
• Signature
Méthode public int SaveJP2Image (String filename, byte[] image, int width, int height, int
pitch, double resX, double resY, int fQuality) lance
IBScanException
• Description
Enregistrez l'image JPEG2000 dans un chemin de fichier spécifique.
• Paramètre
nom de fichier Chemin du fichier pour enregistrer l'image jpeg2000
page 29
pas
fQualité Niveau de qualité pour JPEG2000, la plage valide est comprise entre 0 et 100
1.1.5.32. EnregistrerBitmapImage ()
• Signature
Méthode public int SaveBitmapImage (String nom de fichier, octet[] image, int
largeur, hauteur int, pas int, double resX, double resY) lancers
IBScanException
• Description
Enregistrez l'image Bitmap dans un chemin de fichier spécifique.
• Paramètre
nom de fichier Chemin du fichier pour enregistrer l'image Bitmap
pas
1.1.5.33. getEnhancedImageReserved()
• Signature
Méthode public void getEnhancedImageReserved (String réservéKey, image
IBScanDevice.ImageData) lance IBScanException
• Description
Générez une image améliorée à partir de l'aperçu, renvoyant des informations étendues.
page 30
• Paramètre
réservéKey La clé réservée à définir pour la propriété, sous forme de chaîne
imageData Données d'image d'entrée renvoyées par le rappel d'aperçu
• Retour
un tableau contenant des informations sur l'image améliorée. Le contenu du tableau renvoyé, dans l'ordre,
est
• IBScanDevice.ImageData EnhancedImage – données d'image améliorées
• Entier détectéFingerCount – nombre de doigts détectés
• IBScanDevice.ImageData[] segmentImageArray – tableau de doigts séparé des données d'image

améliorées
• IBScanDevice.SegmentPosition[] segmentPositionArray – données de position pour les doigts

individuels séparées des données d'image améliorées
1.1.5.34. Valeurs de champ constantes
Champ Description
Valeur de contraste maximale. Voir getContrast(),

MAX_CONTRAST_VALUE
setContrast().
Valeur de contraste minimale. Voir getContrast(),

MIN_CONTRAST_VALUE
setContrast().
Option de capture constante pour la capture automatique.

OPTION_AUTO_CAPTURE
Voir BeginCaptureImage().
Option de capture constante pour le contraste automatique.

OPTION_AUTO_CONTRAST
Voir BeginCaptureImage().
OPTION_IGNORE_FINGER_ Constante d’option de capture pour ignorer le nombre de doigts.

COMPTER Voir BeginCaptureImage().
1.1.5.35. getCombineImage ()
• Signature
Méthode public void getCombineImage (IBScanDevice.ImageData
inImage1, IBScanDevice.ImageData inImage2,int whichHand)
• Description
Combinez deux images (2 doigts plats) en une seule image (mains gauche/droite)
page 31
• Paramètre
dansImage1 Pointeur vers IBScanDevice.ImageData (index et majeur)
dansImage2 Pointeur vers IBScanDevice.ImageData (anneau et petit doigt)
whichHand Informations de la main gauche ou droite
• Retour
Pointeur vers IBScanDevice.ImageData (image de taille fixe 1600 x 1500)
1.1.5.36. getOpérableBeeper()
• Signature
Méthode IBScanDevice public. BeeperType getOperableBeeper() lance IBScanException
• Description
Obtenez les caractéristiques du Beeper utilisable sur un appareil.
• Retour
informations sur le type de bipeur
1.1.5.37. setBeeper()
• Signature
Méthode public void setBeeper(BeepPattern bPattern, final long
soundTone, finale longue durée, finale longue réservée_1, finale longue
réservé_2)
• Description
Définissez la valeur du Beeper sur un appareil.
• Paramètre
bModèle Saisissez les données sonores renvoyées par le rappel des boutonsclés
La fréquence du son, en valeur spécifique. Le paramètre doit être compris

tonalité sonore
entre 0 et 2
durée La durée du son, en 25 millisecondes. Le paramètre doit être compris entre 1

et 200 à
page 32
ENUM_IBSU_BEEP_PATTERN_GENERIC, dans la plage 1 à 7 à

ENUM_IBSU_BEEP_PATTERN_REPEAT.
Réservé, si vous définissez beepPattern sur

ENUM_IBSU_BEEP_PATTERN_REPEAT réservé_1 peut utiliser le temps de
réservé_1
sommeil après la durée du son, en 25 millisecondes. Le paramètre doit être
compris entre 1 et 8.
Réservé, si vous définissez beepPattern sur

réservé_2 ENUM_IBSU_BEEP_PATTERN_REPEAT réservé_1 peut utiliser l'opération
(démarrage/arrêt de la répétition du motif), 1 pour démarrer ; 0 pour arrêter
1.1.5.38. getCombineImageEx()
• Signature
Méthode public void getCombineImageEx (IBScanDevice.ImageData
inImage1, IBScanDevice.ImageData inImage2,int whichHand)
• Description
Combinez deux images (2 doigts plats) en une seule image (mains gauche/droite)
• Paramètre
dansImage1 Pointeur vers IBScanDevice.ImageData (index et majeur)
dansImage2 Pointeur vers IBScanDevice.ImageData (anneau et petit doigt)
whichHand Informations de la main gauche ou droite
• Retour
un tableau contenant des informations sur l'image du résultat. Le contenu du tableau renvoyé, dans
l'ordre, est
• IBScanDevice.ImageData resultImage – données d'image de résultat
• IBScanDevice.ImageData[] segmentImageArray – tableau de doigts séparé des données d'image

résultantes
• IBScanDevice.SegmentPosition[] segmentPositionArray – données de position pour les doigts

individuels séparées des données d'image de résultat
• Integer SegmentImageArrayCount : nombre de segments détectés
1.1.5.39. générerDisplayImage()
• Signature
page 33
Méthode public int generateDisplayImage (byte[] image, int inWidth, int
inHeight, octet[]outImage, int outWidth, int outHeight, octet bkColor,
int outFormat, int outQualityLevel, Boolean outVerticalFlip) lance
IBScanException
• Description
Générez une image mise à l'échelle dans différents formats pour un affichage rapide de l'image sur la toile. Vous
pouvez utiliser à la place de generateZoomOutImageEx()
• Paramètre
image Données d'image originales en niveaux de gris
en largeur Largeur de l'image d'entrée
En hauteur Hauteur de l'image d'entrée
Pointeur vers le tampon qui recevra l’image de sortie. Ce tampon doit contenir au
Image de sortie
moins 'outWidth' x 'outHeight' octets
largeurextérieure Largeur de l'image de sortie
hauteurextérieure Hauteur de l'image de sortie
bkCouleur Couleur d’arrièreplan de l’image de sortie
horsFormat Format d'image de l'image de sortie
niveau de qualité de sortie Qualité d'image de l'image de sortie, le paramètre doit être compris entre 0 et 2
je
outVerticalFlip Activer/désactiver le retournement vertical de l'image de sortie
1.1.5.40. supprimerFingerImage()
• Signature
Méthode public int removeFingerImage (long fIndex) lance
IBScanException
• Description
Supprimer une image de doigt
• Paramètre
Modèle binaire de l’index du doigt de l’image d’entrée.

fIndex
ex) IBSU_FINGER_LEFT_LITTLE | IBSU_FINGER_LEFT_RING
page 34
1.1.5.41. ajouterFingerImage()
• Signature
Méthode public int addFingerImage (image IBScanDevice.ImageData, longue
fIndex, IBScanDevice.ImageType imageType, booléen flagForce)
• Description
Ajoutez une image de doigt pour la vérification des doublons d'empreintes digitales et faites rouler pour comparer les
gifles. Il ne peut y avoir que dix tirages
• Paramètre
image Données d'image d'entrée

fIndex
imageType Type d'image de l'image d'entrée
Indique si l'image d'entrée doit être enregistrée même si une autre image est
drapeauForce déjà stockée ou non. TRUE pour être stocké en force ; FAUX pour ne pas être
stocké de force
1.1.5.42. estFingerDuplicate()
• Signature
Méthode public long isFingerDuplicate (image IBScanDevice.ImageData,
long fIndex, IBScanDevice.ImageType imageType, int
securityLevel) lance IBScanException
• Description
Vérifie la duplication de l'empreinte digitale à partir des empreintes stockées par addFingerImage()
• Paramètre

fIndex
page 35
securityLevel niveau de sécurité pour les contrôles en double
• Retour
Variable d'index correspondant au modèle de bits qui recevra le résultat de la duplication
1.1.5.43. isValidFingerGeometry()
• Signature
Méthode public long isValidFingerGeometry (IBScanDevice.ImageData
image, long fIndex, IBScanDevice.ImageType imageType) lance
IBScanException
• Description
Vérifiez la géométrie de la main et des doigts si elle est correcte ou non
• Paramètre

fIndex
• Retour
Variable qui recevra si elle est valide ou non. Vrai à valide ; faux à invalide.
1.1.5.44. SetEncryptionKey()
• Signature
Méthode public int SetEncryptionKey (octet [] encyrptionKey, EncyptionMode
encMode) lance IBScanException
• Description
Définir la clé et le mode de cryptage
• Paramètre
Données d'entrée encyrptionKey pour la clé de chiffrement (doit faire 32 octets)
encMode données d’entrée pour le mode de cryptage. (aléatoire, personnalisé)
page 36
1.1.5.45. IsSpoofFingerDetected()
• Signature
Méthode public booléen IsSpoofFingerDetected ( image ImageData) lance
IBScanException
• Description
Détecter l'empreinte digitale est Live of Fake.
• Paramètre
• Retour
Résultat de détection d'usurpation d'identité. VRAI est une usurpation, FAUX est en direct
1.1.5.46. ConvertImageToISOANSI()
• Signature
Méthode Objet public ConvertImageToISOANSI (ImageDataExt[] image,
int imageCount, IBCommon.ImageFormat
imageFormat,StandardFormat STDformat) lance
IBScanException
• Description
Convertissez les données d'image au format standard pour le fichier d'écriture de modèle ISO.
Avant d'utiliser cette méthode, vous devez d'abord appeler la méthode « getResultImageExt() ».
• Paramètre
imageCount Nombre d'images
imageFormat Format de compression d'image des données de sortie
STDformat Format ISO des données de sortie
• Retour
Les données de résultat peuvent être obtenues en tant que type d'objet. Pour analyser les données, vous devez convertir
la conversion en type StandardFormatData.
page 37
1.1.6. Interface IBScanListener
1.1.6.1. Résumé
Écouteur pour les événements de gestion des appareils sur un IBScan. Cet écouteur doit être
enregistré par une application avec la méthode setScanListener().
Des fonctions spéciales sont fournies pour l'attachement et le détachement de l'appareil et l'état
d'autorisation sur Android, où l'application peut être explicitement responsable de la sollicitation de
l'autorisation.
1.1.6.2. scanDeviceAttached() (Android uniquement)
• Signature
Méthode void scanDeviceAttached (int appareilId)
• Description
Notification de périphérique connecté.
• Paramètre
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil,

obtenu via la méthode UsbDevice getDeviceId()
1.1.6.3. scanDeviceDetached() (Android uniquement)
• Signature
Méthode void scanDeviceDetached (int deviceId)
• Description
Notification de périphérique détaché.
• Paramètre
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil,

obtenu via la méthode UsbDevice getDeviceId()
1.1.6.4. scanDevicePermissionGranted() (Android)
• Signature
Méthode void scanDevicePermissionGranted (int deviceId, booléen
accordé)
• Description
Notification d’accès à l’appareil accordé ou refusé. Cette notification intervient après
page 38
requestPermission() a été appelée. Seuls les appareils d'analyse pour lesquels une autorisation a été
accordée peuvent être ouverts ou décrits avec getDeviceDescription().
• Paramètre
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil, obtenu

via la méthode UsbDevice getDeviceId()
accordé true si l'autorisation a été accordée ; faux si l'autorisation a été refusée
1.1.6.5. scanDeviceCountChanged ()
• Signature
Méthode void scanDeviceCountChanged (int deviceCount)
• Description
Notification de changement du nombre d’appareils.
• Paramètre
deviceCount nouveau nombre d'appareils
1.1.6.6. scanDeviceInitProgress()
• Signature
Méthode void scanDeviceInitProgress (int deviceIndex, int progressValue)
• Description
Notification de progression de l’initialisation de l’appareil. Cette notification se produit pendant l'exécution

de openDevice() ; ou après que openDeviceAsync() ait été appelé avant la fin de l'initialisation ou avant
qu'une erreur ne se produise.
• Paramètre
progression de l'initialisation entre 0 et 100. Une valeur de 100 indique

valeur de progression
que cette initialisation est terminée
1.1.6.7. scanDeviceOpenComplete ()
• Signature
Méthode void scanDeviceOpenComplete (int deviceIndex, IBScanDevice
périphérique, exception IBScanException)
page 39
• Description
Notification complète d'ouverture de l'appareil. Cette notification se produit après l'appel de

openDeviceAsync() lorsque l'initialisation est terminée ou qu'une erreur se produit.
• Paramètre
appareil appareil ouvert, en cas de succès ; sinon, nul
exception, le cas échéant, rencontrée lors de l'ouverture du périphérique ; sinon,

exception
nul
1.1.7. Interface IBScanDeviceListener
1.1.7.1. Résumé
Écouteur pour les événements d'analyse sur un IBScanDevice. Cet écouteur doit être enregistré par une
application à l'aide de la méthode setScanDeviceListener(IBScanDeviceListener).
La plupart de ces événements se produisent après l'appel debeginCaptureImage(). Si les doigts touchent
la platine au début de la capture, deviceImagePreviewAvailable() sera appelé immédiatement et à nouveau
une fois qu'aucun doigt ne se touche. Périodiquement, jusqu'à ce qu'une image finale soit obtenue,
deviceImagePreviewAvailable() renverra l'image actuelle du scanner. Les modifications de la quantité et de
la qualité des pressions des doigts entraîneront des appels à deviceFingerCountChanged() ou
deviceFingerQualityChanged(). Si le type de scan sélectionné est un scan de doigt roulé, alors
deviceAcquisitionBegun() sera appelé lorsqu'un scan de doigt plat aura été acquis et l'utilisateur devra
commencer à faire rouler son doigt vers la gauche ; lorsque le roulement à gauche est terminé,
deviceAcquisitionCompleted() sera appelé et l'utilisateur devra commencer à reculer vers la droite.
Lorsqu'une numérisation de qualité avec le nombre correct de doigts (et un rouleau de doigt complet, le
cas échéant) est disponible ou que captureImageManually() est appelée, deviceImageResultAvailable()
deviceImageResultExtendedAvailable()
est fournira une image numérisée finale à l'application. ou
1.1.7.2. périphériqueCommunicationBroken()
• Signature
Méthode void deviceCommunicationBroken ( périphérique IBScanDevice)
• Description
Notification de rupture de communication. Cette méthode est appelée lors de la communication avec
l'appareil est cassé alors qu'une capture est en cours.
• Paramètre
page 40
appareil appareil avec lequel la communication a été interrompue
1.1.7.3. périphériqueImagePreviewAvailable()
• Signature
Méthode void deviceImagePreviewAvailable ( périphérique IBScanDevice,
IBScanDevice.ImageData)
• Description
Notification d’aperçu d’image disponible.
• Paramètre
appareil appareil pour lequel une image d'aperçu est disponible
image Aperçu de l'image
1.1.7.4. appareilFingerCountChanged()
• Signature
Méthode void deviceFingerCountChanged( périphérique IBScanDevice,
IBScanDevice.FingerCountState (fingerState)
• Description
Notification de changement du nombre de doigts.
• Paramètre
appareil appareil pour lequel le nombre de doigts a changé
État du doigt état du décompte des doigts
1.1.7.5. appareilFingerQualityChanged()
• Signature
Méthode void deviceFingerQualityChanged ( périphérique IBScanDevice,
IBScanDevice.FingerQualityState[]fingerQualities)
• Description
Notification de changement de qualité des doigts.
• Paramètre
page 41
appareil appareil pour lequel la qualité du doigt a changé
Qualités des doigts éventail de qualités pour les doigts
1.1.7.6. périphériqueAcquisitionBegun()
• Signature
Méthode void deviceAcquisitionBegun ( périphérique IBScanDevice,
IBScanDevice.ImageTypeimageType)
• Description
Notification de début d’acquisition du rouleau de périphérique. Si un type d'image de

ROLL_SINGLE_FINGER est en cours de capture, cette méthode sera appelée lorsqu'un scan d'un doigt
plat aura été acquis et l'utilisateur devra commencer à faire rouler son doigt vers la gauche.
• Paramètre
appareil appareil pour lequel l'acquisition a commencé
type d'image type d'image
1.1.7.7. périphériqueAcquisitionCompleted()
• Signature
Méthode void deviceAcquisitionCompleted ( périphérique IBScanDevice,
IBScanDevice.ImageTypeimageType)
• Description
Notification complète d’acquisition du rouleau de périphérique. Si un type d'image de ROLL_SINGLE_FINGER

est en cours de capture, cette méthode sera appelée lorsque le roulement vers la gauche sera terminé et
l'utilisateur devra commencer à faire rouler son doigt vers la gauche pour capturer le côté droit du doigt.
• Paramètre
appareil appareil pour lequel l'acquisition est terminée
1.1.7.8. appareilImageResultAvailable()
• Signature
Méthode void deviceImageResultAvailable ( périphérique IBScanDevice,
page 42
Image IBScanDevice.ImageData, IBScanDevice.ImageType
imageType, IBScanDevice.ImageData[] splitImageArray)
• Description
Notification d’image de résultat disponible.
• Paramètre
appareil appareil pour lequel l'image du résultat est disponible
image données d'image de résultat
tableau splitImageArray de données d'image de résultat fractionné
1.1.7.9. deviceImageResultExtendedAvailable()
• Signature
Méthode void deviceImageResultExtendedAvailable ( périphérique IBScanDevice,
IBScanException imageStatus, IBScanDevice.ImageData
image, IBScanDevice.ImageType imageType, int
détectéFingerCount, IBScanDevice.ImageData[]
segmentImageArray, SegmentPosition[] segmentPositionArray)
• Description
Résultat de la notification d'image étendue disponible.
• Paramètre
appareil appareil pour lequel l'image du résultat est disponible
État de l'image état de l'acquisition de l'image résultante
image données d'image de résultat
détectéFingerCount Nombre de doigts détectés
segmentImageArray tableau de données d'image de résultat de segment
segmentPositionArray tableau de données de position de segment
1.1.7.10. périphériquePlatenStateChanged()
• Signature
page 43
Méthode void devicePlatenStateChanged(IBScanDevice
périphérique, IBScanDevice.PlatenState (platenState)
• Description
Notification de changement d’état de la platine. Si les doigts touchent le plateau lorsqu'une capture
commence, cette méthode sera appelée immédiatement et à nouveau lorsqu'aucun doigt ne se touche.
Les changements d'état ultérieurs dus aux touches ne seront pas notifiés.
• Paramètre
appareil dispositif pour lequel l'état de la platine a changé
état de la platine nouvel état de la platine
1.1.7.11. appareilWarningReceived()
• Signature
Méthode void devicePlatenStateChanged (périphérique
IBScanDevice,IBScanDevice.PlatenState platenState)
• Description
Notification des messages d'avertissement.
• Paramètre
appareil appareil pour lequel un avertissement a été reçu
avertissement avertissement reçu de l'appareil
1.1.7.12. périphériquePressedKeyButtons()
• Signature
Méthode void devicePressedKeyButtons (périphérique IBScanDevice, int
boutonsclés enfoncés)
• Description
Notification par bouton clé.
• Paramètre
appareil appareil pour lequel le bouton clé a été enfoncé
PressedKeyButtons L'index du bouton clé sur lequel vous appuyez.
page 44
1.1.8. Classes imbriquées
1.1.8.1. Classe IBScan.DeviceDesc
• Description
Structure de base de la description de l'appareil.
• Les usages
Méthode IBScan getDeviceDesciption()
• Des champs
Champ Description
ID de l'appareil. Il s'agit de l'ID qu'Android attribue à l'appareil, obtenu via la

int identifiant de périphérique méthode UsbDevice getDeviceId().
String devRevision Révision du périphérique
Chaîne fwVersion Version du micrologiciel de l'appareil
String interfaceType Type d'interface de périphérique (USB, Firewire)
boolean isOpened Indique si le périphérique est ouvert
Chaîne productName Nom du produit de l'appareil
Chaîne SerialNumber Numéro de série de l'appareil
parodie d'entier Vérifiez si l'appareil prend en charge l'usurpation d'identité
1.1.8.2. Classe IBScan.SdkVersion
• Description
Conteneur pour contenir les informations de version.
• Les usages
Méthode IBScan getSdkVersion()
• Des champs
Champ Description
Fichier de chaîne Chaîne de version du fichier
Produit à cordes Chaîne de version du produit
1.1.8.3. Énumération IBScan. Type de hachage
• Description
Énumération du type de hachage.
page 45
• Les usages
Méthode IBScan setCustomerKey()
• Des champs
Champ Description
SHA256 Utiliser le type de hachage SHA256
Réservé Utiliser le type de hachage réservé
1.1.8.4. Énumération IBScanDevice.EventType
• Description
Types d'événements.
• Les usages
Méthode IBScanDevice activateEvent()
• Valeurs
Valeur Description
COMMUNICATION_BROKEN La communication avec un appareil est interrompue.
PREVIEW_IMAGE_AVAILABLE Une nouvelle image d'aperçu est disponible à partir d'un appareil.
ACQUISITION_BEGUN L'acquisition de l'impression laminée au moment du laminage devrait commencer.
ACQUISITION_COMPLETED Acquisition de l'impression laminée une fois le laminage terminé.
RESULT_IMAGE_AVAILABLE L'image du résultat est disponible pour une capture.
FINGER_QUALITY_CHANGED La qualité d'un doigt change.
FINGER_COUNT_CHANGED Le nombre de doigts change.
La platine n'était pas claire au début de la capture ou est devenue

PLATEN_STATE_CHANGED
claire depuis.
AVERTISSEMENT_RECEIVED Un message d'avertissement est généré.
RESULT_IMAGE_EXTENDED L'image du résultat est disponible pour une capture (avec

_DISPONIBLE des informations étendues).
1.1.8.5. Énumération IBScanDevice.FingerCountState
• Description
Définitions de l’état du nombre de doigts.
• Les usages
Méthode IBScanDeviceListener deviceFingerCountChanged()
page 46
• Valeurs
Valeur Description
FINGER_COUNT_OK Nombre attendu de doigts sur le plateau
TOO_MANY_FINGERS Trop de doigts sur le plateau
TOO_FEW_FINGERS Trop peu de doigts sur la platine
NON_FINGER Pas de doigts sur le plateau
1.1.8.6. Énumération IBScanDevice.FingerQualityState
• Description
Définitions de l’état de la qualité des doigts.
• Les usages
Méthode IBScanDeviceListener deviceFingerQualityChanged()
• Valeurs
Valeur Description
ÉQUITABLE
Qualité équitable
FINGER_NOT_PRESENT Aucun doigt sur la platine
BIEN Bonne qualité
PAUVRE Mauvaise qualité
INVALID_AREA_TOP La position des doigts n'est pas valide sur la face supérieure.
INVALID_AREA_LEFT La position des doigts n'est pas valide sur le côté gauche.
INVALID_AREA_RIGHT La position des doigts n'est pas valide sur le côté droit.
1.1.8.7. Classe IBScanDevice.ImageData
• Description
Conteneur pour contenir les données d'image avec des métainformations.
• Les usages
IBScanDeviceListener méthodes deviceImagePreviewAvailable() et
deviceImageResultAvailable(); Méthode IBScanDevice captureImage()
• Des champs
Champ Description
bits courts par pixel Nombre de bits par pixel
tampon d'octet[] Tableau d'octets contenant des données d'image
Format IBScanDevice.ImageFormat Format de couleur de l'image
page 47
Temps d'acquisition de l'image (en secondes). La valeur

double frameTime contient le temps nécessaire à l'acquisition depuis l'appareil
(hors temps de traitement).
hauteur entière Taille verticale de l'image
Marque l’image comme finalement traitée. Une valeur false

disqualifie l'image du traitement ultérieur, par exemple
booléen estFinal
intermédiaire ou prétraité.
images de résultat
Pas de ligne d'image (en octets). Les valeurs positives

pas international indiquent un ordre de ligne descendant, les valeurs négatives
indiquent un ordre de ligne ascendant.
Résolution d'image horizontale (en pixels par pouce)

double résolutionX
double résolutionY Résolution verticale de l'image (en pixels par pouce)
largeur entière Taille horizontale de l'image)
Processus intThres Seuil de traitement d'image
• Méthodes
Description
Bitmap public versBitmap()
Créez une image à partir de données d'image.
Bitmap public toBitmapScaled (int dstWidth, int dstHeight)
Créez une image mise à l'échelle à partir des données d'image.
public Bitmap toBitmapScaled(int dstWidth, int dstHeight,

IBScanDevice.RollingState RollingState, int RollingLineX)
Créez une image mise à l'échelle à partir des données d'image avec une ligne roulante.
public boolean saveToFile (sortie java.io.File, java.lang.String fileFormat) lève java.io.IOException
Enregistrez l'image dans un fichier.
1.1.8.8. Énumération IBScanDevice.ImageFormat
• Description
Constantes de format d’image.
• Les usages
Classe imbriquée IBScanDevice.ImageData
• Valeurs
page 48
Valeur Description
GRIS Image en échelle de gris
RVB24 Image couleur RVB 24 bits
RVB32 Image RVB en vraies couleurs
INCONNU Format inconnu ou défini
1.1.8.9. Énumération IBScanDevice.ImageResolution
• Description
Types de résolution d’image.
• Les usages
Méthodes IBScanDevice isCaptureModeAvailable(),beginCaptureImage().
• Valeurs
Valeur Description
RESOLUTION_1 000 1 000 pixels par pouce
RESOLUTION_500 500 pixels par pouce
1.1.8.10. Énumération IBScanDevice.ImageType
• Description
Types d'images pris en charge. Il s'agit d'une énumération des types d'images pris en charge par le SDK,
et certains modèles de scanner peuvent ne pas prendre en charge tous les types.
• Les usages
Méthodes IBScanDevice isCaptureModeAvailable(),beginCaptureImage().
• Valeurs
Valeur Description
FLAT_FOUR_FINGERS Quatre doigts plats
FLAT_SINGLE_FINGER Doigt unique plat
FLAT_TWO_FINGERS Deux doigts plats
ROLL_SINGLE_FINGER Image d'empreinte digitale roulée
TYPE_NONE Pas encore pris en charge
1.1.8.11. Classe IBScanDevice.LedState
• Description
Conteneur pour contenir les informations LED.
page 49
• Les usages
Méthode IBScanDevice getOperableLEDs().
• Des champs
Champ Description
int ledCount Nombre de LED
IBScanDevice.LedType ledType Type de LED
LED longues utilisables Schéma binaire des LED utilisables
1.1.8.12. Énumération IBScanDevice.LEOperationMode
• Description
Définitions des modes de fonctionnement des films électroluminescents.
• Les usages
Méthodes IBScanDevice getLEOperationMode(), setLEOperationMode().
• Valeurs
Valeur Description
AUTO
DÉSACTIVÉ
SUR
1.1.8.13. Énumération IBScanDevice.PlatenState
• Description
Définitions de l’état du plateau.
• Les usages
Méthode IBScanDevice getPlatenStateAtCapture(); Méthode IBScanDeviceListener devicePlatenStateChanged().
• Valeurs
Valeur Description
EFFACER
HAS_FINGERS
1.1.8.14. Énumération IBScanDevice.PropertyId
• Description
Définitions générales des propriétés. Les valeurs de propriété d'un IBScanDevice sont définies avec
page 50
setProperty() et obtenu avec getProperty().
• Les usages
Méthodes IBScanDevice getProperty() et setProperty().
• Valeurs
Valeur Description
ID_PRODUCT (get) Chaîne du nom du produit (par exemple "Watson")
NUMÉRO DE SÉRIE (get) Chaîne de numéro de série
FOURNISSEUR ID (get) Identifiant du fabricant de l'appareil
IBIA_VENDOR_ID (obtenir) ID du fournisseur IBIA
IBIA_VERSION (obtenir) Informations sur la version IBIA
IBIA_DEVICE_ID (obtenir) l'ID de l'appareil IBIA.
MICROLOGICIEL (get) Chaîne de version du micrologiciel
RÉVISION (get) Chaîne de révision du périphérique
DATE DE PRODUCTION (get) Chaîne de date de production
ID_PRODUCT (get) Chaîne du nom du produit (par exemple, « Watson »).
DATE DE PRODUCTION (get) Chaîne de date de production
SERVICE_DATE (get) Chaîne de date du dernier service
LARGEUR DE L'IMAGE (obtenir) Valeur de largeur de l'image
HAUTEUR DE L'IMAGE (obtenir) Valeur de hauteur de l'image
(get/set) Le temps en millisecondes pour acquérir l'empreinte

digitale en mode de capture automatique, quel que soit le nombre de
doigts. L'option de capture OPTION_AUT_CAPTURE doit

IGNORE_FINGER_TIME être donnée au début de la capture (avec beginCaptureImage()).
La valeur par défaut est de 4 000 ms et la valeur peut être comprise
entre 2 000 et 10 000 ms.
RECOMMENDED_LEVEL (obtenir/définir) Valeur du niveau de contraste automatique
POLLINGTIME_TO_BGETIMA (get) Temps d'interrogation pour bloquer la capture d'image (avec

GE captureImage()).
(get/set) Mode d'économie d'énergie. Spécifiez la valeur « TRUE »

ENABLE_POWER_SAVE_MO
pour activer ou « FALSE » pour désactiver. Par défaut, le mode
DE
d'économie d'énergie est désactivé.
(get/set) Le nombre de tentatives pour les échecs de

RETRY_WRONG_COMMUNI
communication. La valeur par défaut est 6 et la valeur peut être
CATION
comprise entre 1 et 120.
CAPTURE_TIMEOUT (get/set) Le temps d'attente maximum pour l'image
page 51
capturer, en quelques secondes. Si 1, le délai d'attente est infini.
Sinon, la plage valide est comprise entre 10 et 3 600 secondes

inclusivement. La valeur par défaut est 1.
(get/set) Distance minimale de l'empreinte digitale roulée, en

ROLL_MIN_WIDTH millimètres. La plage valide est comprise entre 10 et 30 mm inclus.
La valeur par défaut est de 15 mm.
(obtenir/définir) mode rouleau. La plage valide est comprise entre 0 et

1. La valeur par défaut est 1.
ROLL_MODE
0 : pas d'utilisation du frottis
1 : avis d'utilisation
(obtenir/définir) le niveau de roulis. La plage valide est comprise entre 0

et 2. La valeur par défaut est 1.
ROLL_LEVEL 0 : niveau bas

1 : niveau moyen
2 : haut niveau
(get/set) Le seuil de zone pour la capture d'image pour les doigts

CAPTURE_AREA_THRESHO plats. Le seuil de zone pour le début du doigt roulé. La plage valide est
LD comprise entre 0 et 12 inclus, la valeur par défaut étant 6.
(get/set) Activer le mode de décimation (TRUE pour activer

ENABLE_DECIMATION ou FALSE pour désactiver). Certains appareils (ou versions du
firmware) ne prennent pas en charge cette fonctionnalité.
(get/set) Activer la capture à la sortie (TRUE pour activer ou

FALSE pour désactiver). Le défaut est faux.
ENABLE_CAPTURE_ON_REL
TRUE : le rappel du résultat sera appelé lorsque
FACILITÉ
l'utilisateur relâche le doigt du capteur.
FALSE : le rappel du résultat sera appelé lorsque le
la qualité du doigt devient bonne
DEVICE_INDEX (obtenir) L'index de l'appareil
(obtenir) L'ID de l'appareil qui contient les mêmes informations que

REFERENCE DE L'APPAREIL
la classe UsbDevice d'Android
(get/set) Certains appareils (ou version du micrologiciel) ne

prennent pas en charge cette fonctionnalité. Le défaut est
SUPER_DRY_MODE faux.
VRAI : Activer le mode séchage.

FAUX : Désactiver le mode séchage
(get/set) Il s'agit d'un temps de capture minimum lorsque le mode

sec est activé avec la propriété
MIN_CAPTURE_TIME_IN_SU
ENUM_IBSU_PROPERTY_SUPER_DRY_MODE.
PER_DRY_MODE
Certains appareils (ou versions du firmware) ne prennent pas en
charge cette fonctionnalité. La plage valide est comprise entre
page 52
600 et 3 000 ms inclus, avec la valeur par défaut de 2 000 ms.
ROLLED_IMAGE_WIDTH (get) Valeur de largeur de l'image roulée
ROLLED_IMAGE_HEIGHT (get) Valeur de hauteur de l'image roulée
NO_PREVIEW_IMAGE (get/set) Activer le dessin pour l'image d'aperçu
ROLL_IMAGE_OVERRIDE (get/set) Activer le remplacement de l'image en rouleau
AVERTISSEMENT_MESSAGE_INVAL (get/set) Activer le message d'avertissement pour la zone non

ID_AREA valide pour l'image de résultat
ENABLE_WET_FINGER_DET
(get/set) Activer la fonction de détection d'humidité
ECT
(get/set) Modifier le niveau de détection d'humidité. La plage valide

est comprise entre 1 et 5. La valeur par défaut est 3.
WET_FINGER_DETECT_LEV 1 : Niveau le plus bas pour détecter le doigt mouillé :

EL moins sensible
5 : Niveau le plus élevé pour détecter la détection humide :

plus sensible
(get/set) Modifier le seuil pour chaque niveau de détection

humide. La plage valide est comprise entre 10 et 1 000.
WET_FINGER_DETECT_LEV La valeur par défaut est "50 100 150 200 250 »
EL_SEUIL 50 : Seuil du niveau le plus bas pour détecter le doigt mouillé

250 : Seuil du niveau le plus élevé pour détecter le doigt
mouillé
(get/set) Contrôlez la zone de roulement verticalement. La plage

START_POSITION_OF_ROLLI valide est comprise entre 0 et 9. La valeur par défaut est
NG_AREA 0. 0 : position minimale
9 : position maximale
START_ROLL_WITHOUT_LO (get/set) Activer le roulement sans verrouillage.

CK Le défaut est faux.
(get/set) Active la fonction TOF.

ENABLE_TOF
La valeur par défaut est définie en fonction des appareils.
(get/set) Activer le cryptage pour capturer des images

ENABLE_ENCRYPTION
Le défaut est faux
(get) Vérifiez si l'appareil prend en charge la fonction d'usurpation d'identité

IS_SPOOF_SUPPORTED
ou non
(get/set) Activer la fonction d'usurpation d'identité

ENABLE_SPOOF
Le défaut est faux.
(get/set) Changer le niveau d'usurpation d'identité.
SPOOF_LEVEL La plage valide est comprise entre 0 et 10. La valeur par défaut
est 5. [Obtenir et définir.]
page 53
0 : Niveau le plus bas pour le doigt frauduleux : moins sensible
10 : Niveau le plus élevé pour le doigt frauduleux : plus sensible
VIEW_ENCRYPTION_IMAGE (get/set) Afficher l'image chiffrée

_MODE Le défaut est faux.
FINGERPRINT_SEGMENTATI (get/set) Sélectionnez le mode de segmentation des empreintes digitales
ON_MODE La valeur par défaut est 0.
(get/set) Méthode de roulis améliorée

ROLL_METHOD
Les valeurs par défaut sont 0.
(get/set) Sélectionnez un niveau de valeur d'image opposée

pendant le rouleau
RENEWAL_OPPOSITE_IMGA 0 : Pas d'utilité
NIVEAU E
1 : renouvellement si l'image du rouleau est déplacée de 1,2 mm.
(get/set) Activer l'image d'aperçu de haute qualité pour Kojak

PREVIEW_IMAGE_QUALITY_
FOR_KOJAK
(obtenir) Activer la capture adaptative

ADAPTIVE_CAPTURE_MODE
Les valeurs par défaut sont VRAI.
ENABLE_KOJAK_BEHAVIOR (get/set) Activer le comportement de Kojak 2.6
_2_6 Les valeurs par défaut sont FALSE.
DISABLE_SEGMENT_ROTATI (get/set) Désactiver la rotation des rectangles de segment
SUR Les valeurs par défaut sont FALSE.
RÉSERVÉ_1 (200)
Réservé aux chaînes constructeur. [Besoin d'un code de
RÉSERVÉ_2 (201)
réserve]
RÉSERVÉ_100 (202)
(get/set) Le seuil de traitement de l'image précédente.

[Besoin d'un partenaire ou réserver un code]
La plage valide est comprise entre 0 et 2 inclus, avec la valeur par
défaut de 0 sur le processeur intégré (ARM, Android et Windows
RESERVED_IMAGE_PROCE
Mobile) et avec la valeur par défaut de 2 sur PC.
SS_SEUIL
0 : IMAGE_PROCESS_LOW
1 : IMAGE_PROCESS_MEDIUM
2 : IMAGE_PROCESS_HIGH
RESERVED_ENABLE_TOF_F (get/set) Activer TOF pour la capture de rouleau
page 54
OR_ROLL Le défaut est faux
RESERVED_CAPTURE_BRIG (get/set) Modifier le seuil de luminosité pour la capture

HTNESS_THRESHOLD_FOR plate. Les valeurs par défaut dépendent du
_PLAT scanner.
RESERVED_CAPTURE_BRIG (get/set) Modifier le seuil de luminosité pour la capture

HTNESS_THRESHOLD_FOR de rouleau. Les valeurs par défaut dépendent du
_ROULER scanner.
RESERVED_ENHANCED_RE (get/set) Modifier l'image du résultat à améliorer

SULT_IMAGE Les valeurs par défaut sont FALSE.
1.1.8.15. Classe IBScanDevice.RollingData
• Description
Données d’état glissant.
• Les usages
Méthode IBScanDevice getRollingState().
• Des champs
Champ Description
Position horizontale de la ligne de laminage

int RollingLineX
verticale.
IBScanDevice.RollingState L'état roulant
1.1.8.16. Énumération IBScanDevice.RollingState
• Description
Définitions d’état glissant.
• Les usages
Classe imbriquée IBScanDevice.RollingData
• Valeurs
Valeur Description
COMPLETE_ACQUISITION L'acquisition du scan pour le rouleau est terminée
PAS PRÉSENT L'acquisition n'a pas commencé
RESULT_IMAGE Une image du résultat est déjà disponible
TAKE_ACQUISITION L'acquisition du scan pour le rouleau est en cours
1.1.8.17. Classe IBScanDevice.SegmentPosition
• Description
page 55
Positionnement des segments.
• Les usages
Méthode IBScanDevice captureImageExtended() et méthode IBScanDeviceListener

deviceImageResultExtendedAvailable().
• Des champs
Champ Description
entier x1 coordonnée x du premier sommet
entier y1 coordonnée y du premier sommet
entier x2 coordonnée x du deuxième sommet
entier y2 coordonnée y du deuxième sommet
entier x3 coordonnée x du troisième sommet
entier y3 coordonnée y du troisième sommet
entier x4 coordonnée x du quatrième sommet
entier y4 coordonnée y du quatrième sommet
1.1.8.18. Énumération IBScanDevice.CombineImageWhichHand
• Description
Énumération des mains à utiliser pour combiner deux images en une seule.
• Les usages
Méthode IBScanDevice getCombineImage()
• Des champs
Champ Description
COMBINE_IMAGE_LEFT_HAND Image de gauche.
COMBINE_IMAGE_RIGHT_HAND Image de droite.
1.1.8.19. Énumération IBScanDevice.EncyptionMode
• Description
Énumération du mode de cryptage.
• Les usages
Méthode IBScanDevice SetEncryptionKey()
• Des champs
Champ Description
ENCRYPTION_KEY_RANDOM Clé aléatoire générée par sa propre bibliothèque.
page 56
ENCRYPTION_KEY_CUSTOM Clé personnalisée fournie par l'utilisateur.
1.1.9. Classes imbriquées communes
1.1.9.1. Classe IBCommon.ImageDataExt
• Description
Conteneur pour contenir les données d'image avec des métadonnées étendues.
• Les usages
Méthode IBScanDevice getResultImageExt()
• Des champs
Champ Description
Format d'imageFormat d'image
ImpressionTypeimpressionType
Position du doigtPosition du doigt
CaptureDeviceTechId captureDeviceTechId
capture courteDeviceVendorId
captureDeviceTypeId courte
analyse courteSamplingX
analyse courteSamplingY
court ImageSamplingX
image courteÉchantillonnageY
image courteTailleX
image courteTailleY
échelle d'octetsUnit
octet bitProfondeur
Int imageDataLength;
octet[] imageData
1.1.9.2. Énumération IBCommon.ImageFormat
• Description
Formats d'images.
• Les usages
page 57
ImageFormat, membre IBCommon.ImageDataExt
• Valeurs
Valeur Description
NO_BIT_PACKING
BIT_PACKED
WSQ
JPEG_LOSSY
JPEG2000_LOSSY
JPEG2000_LOSSLESS
PNG
1.1.9.3. Énumération IBCommon.ImpressionType
• Description
Type d'impression.
• Les usages
Membre IBCommon.ImageDataExt impressionType
• Valeurs
Valeur Description
LIVE_SCAN_PLAIN
LIVE_SCAN_ROLLED
NONLIVE_SCAN_PLAIN
NONLIVE_SCAN_ROLLED
LATENT_IMPRESSION
LATENT_TRACING
LATENT_PHOTO
LATENT_LIFT
LIVE_SCAN_SWIPE
LIVE_SCAN_VERTICAL_ROLL
LIVE_SCAN_PALM
NONLIVE_SCAN_PALM
LATENT_PALM_IMPRESSION
LATENT_PALM_TRACING
page 58
LATENT_PALM_PHOTO
LATENT_PALM_LIFT
LIVE_SCAN_OPTICAL_CONTRCTLESS_
PLAINE
AUTRE
INCONNU
1.1.9.4. Énumération IBCommon.FingerPosition
• Description
Positions des doigts.
• Les usages
Membre IBCommon.ImageDataExt fingerPosition ; Fonction IBScanDevice getResultImageExt()
• Valeurs
Valeur Description
INCONNU
RIGHT_THUMB
RIGHT_INDEX_FINGER
RIGHT_MIDDLE_FINGER
RIGHT_RING_FINGER
RIGHT_LITTLE_FINGER
POUCE GAUCHE
LEFT_INDEX_FINGER
LEFT_MIDDLE_FINGER
LEFT_RING_FINGER
LEFT_LITTLE_FINGER
PLAIN_RIGHT_FOUR_FINGERS
PLAIN_LEFT_FOUR_FINGERS
PLAIN_THUMBS
UNKNOWN_PALM
page 59
RIGHT_FULL_PALM
RIGHT_WRITERS_PALM
LEFT_FULL_PALM
LEFT_WRITERS_PALM
RIGHT_LOWER_PALM
RIGHT_UPPER_PALM
RIGHT_OTHER
LEFT_OTHER
RIGHT_INTERDIGITAL
RIGHT_THENAR
RIGHT_HYPOTHENAR
LEFT_INTERDIGITAL
GAUCHE_THENAR
LEFT_HYPOTHENAR
RIGHT_INDEX_AND_MIDDLE
RIGHT_MIDDLE_AND_RING
RIGHT_RING_AND_LITTLE
LEFT_INDEX_AND_MIDDLE
LEFT_MIDDLE_AND_RING
LEFT_RING_AND_LITTLE
RIGHT_INDEX_AND_LEFT_INDEX
RIGHT_INDEX_AND_MIDDLE_AND_RING
RIGHT_MIDDLE_AND_RING_AND_LITTLE
LEFT_INDEX_AND_MIDDLE_AND_RING
LEFT_MIDDLE_AND_RING_AND_LITTLE
1.1.9.5. Énumération IBCommon.CaptureDeviceTechId
• Description
Capturez l’ID technologique de l’appareil.
• Les usages
Membre IBCommon.ImageDataExt captureDeviceTechId
• Valeurs
page 60
Valeur Description
UNKNOWN_OR_UNSPECIFIED
WHITE_LIGHT_OPTICAL_TIR
WHITE_LIGHT_OPTICAL_DIRECT_VIEW_
SUR_PLAQUE
WHITE_LIGHT_OPTICAL_TOUCHLESS
MONOCHROMATIC_VISIBLE_OPTICAL_TIR
MONOCHROMATIC_VISIBLE_OPTICAL_
DIRECT_VEIW_ON_PLATEN
MONOCHROMATIC_VISIBLE_OPTICAL_
SANS CONTACT
MULTISPECTRAL_OPTICAL_TIR
MULTISPECTRAL_OPTICAL_DIRECT_VIEW_
SUR_PLAQUE
MULTISPECTRAL_OPTICAL_TOUCHLESS
ÉLECTRO_LUMINESCENT
SEMICONDUCTEUR_CAPACITIVE
SEMICONDUCTEUR_RF
SEMICONDUCTEUR_THEMAL
SENSIBLE À LA PRESSION
ULTRASON
MÉCANIQUE
FIBRES DE VERRE
1.1.9.6. Classe IBCommon.StandardFormatData
• Description
Conteneur destiné à contenir les données d'image StandardFormatData (IBSM_StandardFormatData)
• Les usages
Méthode IBScanDevice ConvertImageToISOANSI()
• Des champs
Champ Description
octet[] Données
Longueur de données longue
page 61
Format de format standard
1.1.9.7. Énumération IBCommon.StandardFormat
• Description
Énumération StandardFormat (IBSM_StandardFormat)
• Les usages
Méthode IBScanDevice ConvertImageToISOANSI()
• Valeurs
Valeur Description
STANDARD_FORMAT_ISO_19794_2_2005
STANDARD_FORMAT_ANSI_INCITS_378_2004
STANDARD_FORMAT_ANSI_INCITS_381_2004
page 62
Coordonnées de l'assistance :
www.integratedbiometrics.com
Biométrie intégrée, LLC
page 63

IBScanUltimate API Manual For Java (And Android)

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

IBScanUltimate API Manual For Java (And Android)

Transféré par

Droits d'auteur :

Formats disponibles

Machine Translated by Google

Manuel IBScanUltimateAPI pour Java (et Android)

Copyright @2011­2022, Integrated Biometrics LLC. Tous droits réservés

Manuel API pour Java (et Android)

Table des matières

HISTORIQUE DES RÉVISIONS ................................................ ....................................... 5

1. DESCRIPTION DES API.......................................................... ...................................... 7

1.1. Résumé de l'API Java................................................. .................................................................. ........................7

1.1.1. Résumé de la classe principale et des méthodes d'interface.................................................. ............................7

1.1.2. Résumé des classes imbriquées ............................................ .................................................................. .....9

1.1.3. Résumé des cours communs................................................................ .................................................................. dix

1.1.4. Classe IBScan............................................................ .................................................................. ...................... 11

1.1.4.1. Résumé................................................. .................................................................. ...................... 11

1.1.4.2. activerTraceLog()................................................................ .................................................................. ...........11

1.1.4.3. getDeviceCount()................................................. .................................................................. ...........11

1.1.4.4. getDeviceDescription().................................................. .................................................................. ..11

1.1.4.5. getInitProgress() .................................................. .................................................................. ............12

1.1.4.6. getInstance() .............................................. .................................................................. ..................12

1.1.4.7. getInstance(Context) (Android uniquement).......................................... ......................................12

1.1.4.8. getSdkVersion() .................................................. .................................................................. ............13

1.1.4.9. hasPermission() (Android uniquement)............................................. ......................................13

1.1.4.10. isScanDevice() (Android uniquement)............................................. ........................................13

1.1.4.11. openDevice(int) .................................................. .................................................................. ............14

1.1.4.12. openDevice(int, String)............................................ .................................................................. .....14

1.1.4.13. openDeviceAsync(int).......................................... .................................................................. ....15

1.1.4.14. openDeviceAsync(int, String) ............................................ ........................................15

1.1.4.15. requestPermission() (Android uniquement) ............................................ ......................................15

1.1.4.16. setContext() (Android uniquement) ............................................ ......................................................16

1.1.4.17. setScanListener() .................................................. .................................................................. ...........16

1.1.4.18. déchargerBibliothèque()................................................ .................................................................. ..............16

1.1.4.19. updateUsbPermission()(Android uniquement)........................................... ................................17

1.1.4.20. getRequiredSDKVersion().................................................. ..................................................17

1.1.4.21. setClientClient()................................................. .................................................................. ..........17

1.1.4.22. getErrorString() .................................................. .................................................................. ............18

1.1.5. Classe IBScanDevice .................................................. .................................................................. ............19

1.1.5.1. Résumé................................................. .................................................................. ......................19

1.1.5.2. commencerCaptureImage()................................................................ .................................................................. .....19

1.1.5.3. calculerNfiqScore().................................................. .................................................................. ......19

1.1.5.4. annulerCaptureImage()................................................................ .................................................................. ....20

1.1.5.5. captureImage()............................................................ .................................................................. ............20

Manuel API pour Java (et Android)

1.1.5.6. captureImageExtended().................................................. .................................................................. 20

1.1.5.7. captureImageManuellement()................................................ .................................................................. 21

1.1.5.8. fermer() ............................................... .................................................................. ......................21

1.1.5.9. activerEvent().................................................. .................................................................. ............21

1.1.5.10. getContraste()................................................. .................................................................. ..................22

1.1.5.11. getLEDs() ............................................... .................................................................. ......................22

1.1.5.12. getLEOperationMode().................................................. .................................................................. ..22

1.1.5.13. getOperableLEDs().................................................. .................................................................. ........22

1.1.5.14. getPlatenStateAtCapture().................................................. ..................................................23

1.1.5.15. getProperty()............................................................ .................................................................. ..................23

1.1.5.16. getResultImageExt().................................................. .................................................................. ......23

1.1.5.17. getRollingInfo()................................................................ .................................................................. ............24

1.1.5.18. estCaptureActive()................................................................ .................................................................. ...........24

1.1.5.19. isCaptureAvailable().................................................. .................................................................. ......24

1.1.5.20. estFingerTouching() .................................................. .................................................................. ........25

1.1.5.21. est ouvert() ............................................... .................................................................. ......................25

1.1.5.22. setContraste()............................................................ .................................................................. ...................25

1.1.5.23. setLEDs().................................................. .................................................................. .......................26

1.1.5.24. setLEOperationMode().................................................. .................................................................. ..26

1.1.5.25. setProperty() ............................................................ .................................................................. ..................26

1.1.5.26. setPropertyReserved().................................................. .................................................................. ....27

1.1.5.27. setScanDeviceListener().................................................. .................................................................. 27

Copyright @20112022, Integrated Biometrics LLC. Tous droits réservés