io.scanbot.sdk.genericdocument

Class DefaultGenericDocumentRecognizer

io.scanbot.sdk.genericdocument.DefaultGenericDocumentRecognizer

All Implemented Interfaces:

GenericDocumentRecognizer

public class DefaultGenericDocumentRecognizer
implements GenericDocumentRecognizer

Default implementation for interface GenericDocumentRecognizer

See Also:

interface GenericDocumentRecognizer

Constructor Detail

DefaultGenericDocumentRecognizer

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

Default implementation for interface GenericDocumentRecognizer

See Also:

interface GenericDocumentRecognizer

Method Detail

getAcceptedSharpnessScore

public float getAcceptedSharpnessScore()

Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.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 GenericDocumentRecognitionResult.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.genericdocument.entity.RootDocumentType> getAcceptedDocumentTypes()

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

By default - RootDocumentType.ALL_TYPES

setAcceptedDocumentTypes

public void setAcceptedDocumentTypes(@NotNull
                                     java.util.List<? extends io.scanbot.genericdocument.entity.RootDocumentType> value)

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

By default - RootDocumentType.ALL_TYPES

scanBitmap

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

Scan the image to detect document and recognize data on it

Parameters:

bitmap - image

shouldRecognize - whether to recognize field and their data. Otherwise the component will only detect document on the image. Defaults to true

orientation - image orientation. Default is 0

scanJpeg

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

Scan the image to detect document and recognize data on it

Parameters:

jpeg - image in form of jpeg-encoded byte array

shouldRecognize - whether to recognize field and their data. Otherwise the component will only detect document on the image. Defaults to true

orientation - image orientation. Default is 0

scanNv21

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

Scan the image to detect document and recognize 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. Otherwise the component will only detect document on the image. Defaults to true

clear

public void clear()

Clears the result accumulation cache (for live detection)