Package com.microblink.blinkinput.entities.recognizers.blinkinput.documentcapture

Class DocumentCaptureRecognizer

java.lang.Object

com.microblink.blinkinput.entities.Entity<T>

com.microblink.blinkinput.entities.recognizers.Recognizer<DocumentCaptureRecognizer.Result>

com.microblink.blinkinput.entities.recognizers.blinkinput.documentcapture.DocumentCaptureRecognizer

All Implemented Interfaces:

android.os.Parcelable, EncodeFullDocumentImagesOptions, FullDocumentImageExtensionOptions, FullDocumentImageOptions

public final class DocumentCaptureRecognizer
extends Recognizer<DocumentCaptureRecognizer.Result>
implements FullDocumentImageOptions, FullDocumentImageExtensionOptions, EncodeFullDocumentImagesOptions

A generic document capture recognizer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DocumentCaptureRecognizer.Result

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<DocumentCaptureRecognizer>	CREATOR

Fields inherited from interface com.microblink.blinkinput.entities.recognizers.blinkid.imageoptions.encode.EncodeFullDocumentImagesOptions

CLASS_NAME

Fields inherited from interface com.microblink.blinkinput.entities.recognizers.blinkid.imageoptions.FullDocumentImageOptions

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
DocumentCaptureRecognizer()

Method Summary

Modifier and Type	Method	Description
DocumentCaptureRecognizer	clone()	Create a copy of the entity.
void	consumeResultFrom(Entity other)	Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
ImageExtensionFactors	getFullDocumentImageExtensionFactors()	Returns the extension factors for full document image.
float	getMinDocumentScale()	Defines minimum document scale calculated as ratio of minimal document dimension and minimal dimension of the input image.
int	getNumStableDetectionsThreshold()	Minimum number of stable detections required for detection to be successful.
protected byte[]	serializeNativeSettings()
void	setEncodeFullDocumentImage(boolean encodeFullDocumentImage)	Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result.
void	setFullDocumentImageExtensionFactors(ImageExtensionFactors fullDocumentImageExtensionFactors)	Sets extension factors for full document image.
void	setMinDocumentScale(float minDocumentScale)	Defines minimum document scale calculated as ratio of minimal document dimension and minimal dimension of the input image.
void	setNumStableDetectionsThreshold(int numStableDetectionsThreshold)	Minimum number of stable detections required for detection to be successful.
void	setReturnFullDocumentImage(boolean returnFullDocumentImage)	Sets whether full document image should be available in FullDocumentImageResult.
boolean	shouldEncodeFullDocumentImage()	Returns whether encoding of full document images and writing them into the recognition result is enabled.
boolean	shouldReturnFullDocumentImage()	Returns whether full document image will be available in FullDocumentImageResult.
protected void	terminateNative(long nativeContext)

Methods inherited from class com.microblink.blinkinput.entities.recognizers.Recognizer

getName, isExcludedFromPing, requiresAutofocus, requiresLandscapeMode

Methods inherited from class com.microblink.blinkinput.entities.Entity

describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, writeToParcel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CREATOR

public static final android.os.Parcelable.Creator<DocumentCaptureRecognizer> CREATOR

Constructor Details

DocumentCaptureRecognizer

public DocumentCaptureRecognizer()

Method Details

setReturnFullDocumentImage

public void setReturnFullDocumentImage(boolean returnFullDocumentImage)

Description copied from interface: FullDocumentImageOptions

Sets whether full document image should be available in FullDocumentImageResult. If enabled, get image using FullDocumentImageResult.getFullDocumentImage() By default, this is set to 'false'. IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkinput.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED By default, this is set to 'false'

Specified by:

setReturnFullDocumentImage in interface FullDocumentImageOptions

Parameters:

returnFullDocumentImage - whether full document image will be available in FullDocumentImageResult.

shouldReturnFullDocumentImage

public boolean shouldReturnFullDocumentImage()

Description copied from interface: FullDocumentImageOptions

Returns whether full document image will be available in FullDocumentImageResult. By default, this is set to 'false'. By default, this is set to 'false'

Specified by:

shouldReturnFullDocumentImage in interface FullDocumentImageOptions

Returns:

whether full document image will be available in FullDocumentImageResult.

setEncodeFullDocumentImage

public void setEncodeFullDocumentImage(boolean encodeFullDocumentImage)

Description copied from interface: EncodeFullDocumentImagesOptions

Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result. By default, this is set to 'false'.
IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkinput.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED

Specified by:

setEncodeFullDocumentImage in interface EncodeFullDocumentImagesOptions

Parameters:

encodeFullDocumentImage - whether full document images should be encoded in JPEG format and written into the corresponding recognition result.

shouldEncodeFullDocumentImage

public boolean shouldEncodeFullDocumentImage()

Description copied from interface: EncodeFullDocumentImagesOptions

Returns whether encoding of full document images and writing them into the recognition result is enabled. By default, this is set to 'false'.

Specified by:

shouldEncodeFullDocumentImage in interface EncodeFullDocumentImagesOptions

Returns:

whether encoding of full document images and writing them into the recognition result is enabled.

setNumStableDetectionsThreshold

public void setNumStableDetectionsThreshold(@IntRange(from=1L,to=255L)
 int numStableDetectionsThreshold)

Minimum number of stable detections required for detection to be successful. By default, this is set to '2'.

getNumStableDetectionsThreshold

@IntRange(from=1L,
          to=255L)
public int getNumStableDetectionsThreshold()

Minimum number of stable detections required for detection to be successful. By default, this is set to '2'.

setMinDocumentScale

public void setMinDocumentScale(@FloatRange(from=0.0,to=1.0)
 float minDocumentScale)

Defines minimum document scale calculated as ratio of minimal document dimension and minimal dimension of the input image. By default, this is set to '0.5'.

getMinDocumentScale

@FloatRange(from=0.0,
            to=1.0)
public float getMinDocumentScale()

Defines minimum document scale calculated as ratio of minimal document dimension and minimal dimension of the input image. By default, this is set to '0.5'.

setFullDocumentImageExtensionFactors

public void setFullDocumentImageExtensionFactors(@NonNull
 ImageExtensionFactors fullDocumentImageExtensionFactors)

Sets extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.

Specified by:

setFullDocumentImageExtensionFactors in interface FullDocumentImageExtensionOptions

Parameters:

fullDocumentImageExtensionFactors - extension factors for full document image.

getFullDocumentImageExtensionFactors

@NonNull
public ImageExtensionFactors getFullDocumentImageExtensionFactors()

Returns the extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.

Specified by:

getFullDocumentImageExtensionFactors in interface FullDocumentImageExtensionOptions

Returns:

extension factors for full document image.

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class Entity<DocumentCaptureRecognizer.Result>

serializeNativeSettings

@Nullable
protected byte[] serializeNativeSettings()

Specified by:

serializeNativeSettings in class Entity<DocumentCaptureRecognizer.Result>

deserializeNativeSettings

protected void deserializeNativeSettings(@NonNull
 byte[] serializedSettings)

Specified by:

deserializeNativeSettings in class Entity<DocumentCaptureRecognizer.Result>

clone

public DocumentCaptureRecognizer clone()

Description copied from class: Entity

Create a copy of the entity. This is required if properties of the entity must be modified while background thread performs processing. In order to avoid race conditions, changing properties is not allowed while entity is used in background processing. However, you are able to make a copy of the entity, change properties of it and then update the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.

Specified by:

clone in class Recognizer<DocumentCaptureRecognizer.Result>

Returns:

a copy of the entity

consumeResultFrom

public void consumeResultFrom(@NonNull
 Entity other)

Description copied from class: Entity

Consume result from other entity. The result from other will be put instead current result of this entity. This method is used inside BaseIntentTransferable.loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent

Specified by:

consumeResultFrom in class Entity<DocumentCaptureRecognizer.Result>

Parameters:

other - Entity from which result should be consumed.