Class Recognizer<T extends Recognizer.Result>
java.lang.Object
com.microblink.blinkid.entities.Entity<T>
com.microblink.blinkid.entities.recognizers.Recognizer<T>
- All Implemented Interfaces:
android.os.Parcelable
,JsonizableEntity
- Direct Known Subclasses:
BlinkIdMultiSideRecognizer
,BlinkIdSingleSideRecognizer
,DocumentFaceRecognizer
,FrameGrabberRecognizer
,IdBarcodeRecognizer
,MrtdCombinedRecognizer
,PassportRecognizer
,SuccessFrameGrabberRecognizer
,TemplatingRecognizer
,UsdlCombinedRecognizer
,UsdlRecognizer
,VisaRecognizer
public abstract class Recognizer<T extends Recognizer.Result>
extends Entity<T>
implements JsonizableEntity
Base recognizer that is used to perform recognition of images.
-
Nested Class Summary
-
Field Summary
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
Constructor Summary
ModifierConstructorDescriptionprotected
Recognizer
(long nativeRecognizer, T concreteResult) protected
Recognizer
(long nativeRecognizer, T concreteResult, android.os.Parcel in) -
Method Summary
Modifier and TypeMethodDescriptionabstract Recognizer
clone()
Create a copy of the entity.getName()
Returns unique name of this recognizer type.boolean
Returns true if this recognizer should be excluded from reporting its scan success to ping server.boolean
Returns true if this recognizer requires camera with autofocus.boolean
Returns true if this recognizer works only in landscape mode.protected static SignedPayload
signedJsonNativeGet
(long nativePtr) Returns the signed JSON representation of this entity's current state as aSignedPayload
.Methods inherited from class com.microblink.blinkid.entities.Entity
consumeResultFrom, describeContents, deserializeNativeSettings, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, serializeNativeSettings, terminateNative, writeToParcel
-
Constructor Details
-
Recognizer
-
Recognizer
-
-
Method Details
-
requiresAutofocus
public boolean requiresAutofocus()Returns true if this recognizer requires camera with autofocus.- Returns:
- true if this recognizer requires camera with autofocus.
-
toSignedJson
Description copied from interface:JsonizableEntity
Returns the signed JSON representation of this entity's current state as aSignedPayload
.- Specified by:
toSignedJson
in interfaceJsonizableEntity
- Returns:
- signed JSON representation of this entity's current state.
-
signedJsonNativeGet
-
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 theRecognizerRunnerView
orRecognizerRunner
with the updated entity hierarchy.- Specified by:
clone
in classEntity<T extends Recognizer.Result>
- Returns:
- a copy of the entity
-
requiresLandscapeMode
public boolean requiresLandscapeMode()Returns true if this recognizer works only in landscape mode.- Returns:
- true if this recognizer works only in landscape mode.
-
isExcludedFromPing
public boolean isExcludedFromPing()Returns true if this recognizer should be excluded from reporting its scan success to ping server.- Returns:
- true if this recognizer should be excluded from reporting its scan success to ping server.
-
getName
Returns unique name of this recognizer type.- Returns:
- unique name of this recognizer type.
-