-
@Deprecated(message = Use GenericDocumentRecognizer instead, replaceWith = @ReplaceWith(imports = {io.scanbot.sdk.genericdocument}, expression = GenericDocumentRecognizer)) public interface IdCardScanner
Component to scan image, detect ID card of known types, perform image optimization, cropping and (optionally) fields detection and fields' data recognition
-
-
Method Summary
Modifier and Type Method Description abstract IdScanResultscanBitmap(Bitmap bitmap, Boolean shouldRecognize, Integer orientation)Scan image to detect ID card and data on it abstract IdScanResultscanJpeg(ByteArray jpeg, Boolean shouldRecognize, Integer orientation)Scan image to detect ID card and data on it abstract IdScanResultscanNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, Rect finderRect, Boolean shouldRecognize)Scan image to detect ID card and data on it abstract FloatgetAcceptedSharpnessScore()Accepted minimal sharpness score. abstract UnitsetAcceptedSharpnessScore(Float acceptedSharpnessScore)Accepted minimal sharpness score. abstract List<IdScanResult.DocumentType>getAcceptedDocumentTypes()Accepted document types. abstract UnitsetAcceptedDocumentTypes(List<IdScanResult.DocumentType> acceptedDocumentTypes)Accepted document types. -
-
Method Detail
-
scanBitmap
abstract IdScanResult scanBitmap(Bitmap bitmap, Boolean shouldRecognize, Integer orientation)
Scan image to detect ID card and data on it
- Parameters:
bitmap- imageshouldRecognize- whether to recognize field and their data on ID card.orientation- image orientation.
-
scanJpeg
abstract IdScanResult scanJpeg(ByteArray jpeg, Boolean shouldRecognize, Integer orientation)
Scan image to detect ID card and data on it
- Parameters:
jpeg- image in form of jpeg-encoded byte arrayshouldRecognize- whether to recognize field and their data on ID card.orientation- image orientation.
-
scanNv21
abstract IdScanResult scanNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, Rect finderRect, Boolean shouldRecognize)
Scan image to detect ID card and data on it
- Parameters:
nv21- image in form of nv21-encoded byte arraywidth- image width, pixelsheight- image height, pixelsorientation- image orientation.finderRect- if non-null - perform scanning only in given area.shouldRecognize- whether to recognize field and their data on ID card.
-
getAcceptedSharpnessScore
abstract Float getAcceptedSharpnessScore()
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
Default is 0
0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.
-
setAcceptedSharpnessScore
abstract Unit setAcceptedSharpnessScore(Float acceptedSharpnessScore)
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
Default is 0
0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.
-
getAcceptedDocumentTypes
abstract List<IdScanResult.DocumentType> getAcceptedDocumentTypes()
Accepted document types. All other document types will be ignored.
By default -
IdScanResult.DocumentType.DEFAULT_TYPES.
-
setAcceptedDocumentTypes
abstract Unit setAcceptedDocumentTypes(List<IdScanResult.DocumentType> acceptedDocumentTypes)
Accepted document types. All other document types will be ignored.
By default -
IdScanResult.DocumentType.DEFAULT_TYPES.
-
-
-
-