Package com.microblink.documentverification.entities.recognizers.successframe

Class SuccessFrameGrabberRecognizer

java.lang.Object

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

com.microblink.documentverification.entities.recognizers.Recognizer<SuccessFrameGrabberRecognizer.Result>

com.microblink.documentverification.entities.recognizers.successframe.SuccessFrameGrabberRecognizer

All Implemented Interfaces:

android.os.Parcelable, JsonizableEntity

public final class SuccessFrameGrabberRecognizer
extends Recognizer<SuccessFrameGrabberRecognizer.Result>

A recognizer that holds the camera frame on which given recognizer's result has become valid. If given recognizer never becomes valid, SuccessFrameRecognizer's result will not contain the camera frame.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SuccessFrameGrabberRecognizer.Result

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

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

Field Summary

Fields

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

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
SuccessFrameGrabberRecognizer(Recognizer<?> recognizer)

Method Summary

Modifier and Type	Method	Description
SuccessFrameGrabberRecognizer	clone()	Create a copy of the entity.
void	consumeResultFrom(Entity other)	Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
Recognizer<?>	getSlaveRecognizer()
protected byte[]	serializeNativeSettings()
protected void	terminateNative(long nativeContext)
void	writeToParcel(android.os.Parcel dest, int i)

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

getName, isExcludedFromPing, requiresAutofocus, requiresLandscapeMode, signedJsonNativeGet, toSignedJson

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

describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

@NonNull
public static final android.os.Parcelable.Creator<SuccessFrameGrabberRecognizer> CREATOR

Constructor Detail

SuccessFrameGrabberRecognizer

public SuccessFrameGrabberRecognizer(@NonNull
                                     Recognizer<?> recognizer)

Parameters:

recognizer - Recognizer that SuccessFrameGrabberRecognizer will watch.

Method Detail

getSlaveRecognizer

@NonNull
public Recognizer<?> getSlaveRecognizer()

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class Entity<SuccessFrameGrabberRecognizer.Result>

serializeNativeSettings

@Nullable
protected byte[] serializeNativeSettings()

Specified by:

serializeNativeSettings in class Entity<SuccessFrameGrabberRecognizer.Result>

deserializeNativeSettings

protected void deserializeNativeSettings(@NonNull
                                         byte[] serializedSettings)

Specified by:

deserializeNativeSettings in class Entity<SuccessFrameGrabberRecognizer.Result>

clone

@NonNull
public SuccessFrameGrabberRecognizer 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<SuccessFrameGrabberRecognizer.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<SuccessFrameGrabberRecognizer.Result>

Parameters:

other - Entity from which result should be consumed.

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int i)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class Entity<SuccessFrameGrabberRecognizer.Result>