io.scanbot.sdk.idcardscanner

Class DefaultIdCardScanner

io.scanbot.sdk.idcardscanner.DefaultIdCardScanner

All Implemented Interfaces:

IdCardScanner

public class DefaultIdCardScanner
implements IdCardScanner

Default implementation for interface IdCardScanner

See Also:

interface IdCardScanner

Constructor Detail

DefaultIdCardScanner

public DefaultIdCardScanner(@NotNull
                            io.scanbot.sdk.blob.BlobManager blobManager)

Default implementation for interface IdCardScanner

See Also:

interface IdCardScanner

Method Detail

getAcceptedSharpnessScore

public 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

public void setAcceptedSharpnessScore(float value)

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

@NotNull
public java.util.List<io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType> getAcceptedDocumentTypes()

Accepted document types. All other document types will be ignored.

By default - IdScanResult.DocumentType.DEFAULT_TYPES.

setAcceptedDocumentTypes

public void setAcceptedDocumentTypes(@NotNull
                                     java.util.List<? extends io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType> value)

Accepted document types. All other document types will be ignored.

By default - IdScanResult.DocumentType.DEFAULT_TYPES.

scanBitmap

@Nullable
public IdScanResult scanBitmap(@NotNull
                                         android.graphics.Bitmap bitmap,
                                         boolean shouldRecognize,
                                         int orientation)

Scan image to detect ID card and data on it

Parameters:

bitmap - image

shouldRecognize - whether to recognize field and their data on ID card. Defaults to true

orientation - image orientation. Default is 0

scanJpeg

@Nullable
public IdScanResult scanJpeg(@NotNull
                                       kotlin.Array[] jpeg,
                                       boolean shouldRecognize,
                                       int orientation)

Scan image to detect ID card and data on it

Parameters:

jpeg - image in form of jpeg-encoded byte array

shouldRecognize - whether to recognize field and their data on ID card. Defaults to true

orientation - image orientation. Default is 0

scanNv21

@Nullable
public IdScanResult scanNv21(@NotNull
                                       kotlin.Array[] nv21,
                                       int width,
                                       int height,
                                       int orientation,
                                       @Nullable
                                       android.graphics.Rect finderRect,
                                       boolean shouldRecognize)

Scan image to detect ID card and data on it

Parameters:

nv21 - image in form of nv21-encoded byte array

width - image width, pixels

height - image height, pixels

orientation - image orientation. Default is 0

finderRect - if non-null - perform scanning only in given area. Default is null

shouldRecognize - whether to recognize field and their data on ID card. Defaults to true