com.microblink.blinkinput.entities.recognizers

Class RecognizerBundle

java.lang.Object

<any>

com.microblink.blinkinput.entities.recognizers.RecognizerBundle

public class RecognizerBundle
extends <any>

Represents a bundle of Recognizer objects that can travel via Intent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecognizerBundle.FrameQualityEstimationMode
static class	RecognizerBundle.RecognitionDebugMode

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR
static int	TIMEOUT_INFINITY Constant used as argument for RecognizerBundle.setNumMsBeforeTimeout(int) method when timeout should be set to infinity.

Constructor Summary

Constructors

Constructor and Description
RecognizerBundle(java.util.List recognizerList)
RecognizerBundle(Recognizer[] recognizers)

Method Summary

Modifier and Type	Method and Description
protected void	consumeContentFromLoadedObject(RecognizerBundle loadedBundle)
static RecognizerBundle	createFromIntent(android.content.Intent intent) Creates object of this class from Intent.
boolean	equals(java.lang.Object o)
protected <any>	getConcreteCreator()
RecognizerBundle.FrameQualityEstimationMode	getFrameQualityEstimationMode()
int	getNumMsBeforeTimeout() Returns the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.
RecognizerBundle.RecognitionDebugMode	getRecognitionDebugMode() Returns the current recognition mode.
Recognizer[]	getRecognizers() Returns the array of recognizers associated with this bundle.
protected java.lang.String	getUniqueIdIntentExtraKey()
protected void	readFromParcel(android.os.Parcel in)
void	saveToIntent(android.content.Intent intent) Saves this RecognizerBundle to Intent so it can be passed to another Activity.
void	setAllowMultipleScanResultsOnSingleImage(boolean multiScan) Sets whether or not outputting of multiple scan results from same image is allowed.
void	setFrameQualityEstimationMode(RecognizerBundle.FrameQualityEstimationMode mode) Sets the mode of the frame quality estimation.
void	setNumMsBeforeTimeout(int numMsBeforeTimeout) Set the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.
void	setRecognitionDebugMode(RecognizerBundle.RecognitionDebugMode recognitionMode) This method is for debugging and testing purposes only.
boolean	shouldAllowMultipleScanResultsOnSingleImage() Returns true if multiple scan results can be obtained from single image.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIMEOUT_INFINITY

public static final int TIMEOUT_INFINITY

Constant used as argument for RecognizerBundle.setNumMsBeforeTimeout(int) method when timeout should be set to infinity. Effectively, this means that recognition timeout will be disabled.

See Also:

RecognizerBundle.setNumMsBeforeTimeout(int), Constant Field Values

CREATOR

@NonNull
public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

RecognizerBundle

public RecognizerBundle(@NonNull
                        Recognizer[] recognizers)

RecognizerBundle

public RecognizerBundle(@NonNull
                        java.util.List recognizerList)

Method Detail

createFromIntent

@Nullable
public static final RecognizerBundle createFromIntent(@NonNull
                                                                android.content.Intent intent)

Creates object of this class from Intent.

Parameters:

intent - intent in which object is stored.

Returns:

created object or null if it does not exist in the given intent.

getRecognizers

@NonNull
public Recognizer[] getRecognizers()

Returns the array of recognizers associated with this bundle.

Returns:

the array of recognizers associated with this bundle.

getRecognitionDebugMode

@NonNull
public RecognizerBundle.RecognitionDebugMode getRecognitionDebugMode()

Returns the current recognition mode.

Returns:

the current recognition mode.

setRecognitionDebugMode

public void setRecognitionDebugMode(@NonNull
                                    RecognizerBundle.RecognitionDebugMode recognitionMode)

This method is for debugging and testing purposes only. Please do not use it because calling it with wrong parameter might cause scanning loop to never terminate.

Parameters:

recognitionMode - Requested mode of recognition.

shouldAllowMultipleScanResultsOnSingleImage

public boolean shouldAllowMultipleScanResultsOnSingleImage()

Returns true if multiple scan results can be obtained from single image. See RecognizerBundle.setAllowMultipleScanResultsOnSingleImage(boolean) for details.

Returns:

true if multiple scan results can be obtained from single image.

setAllowMultipleScanResultsOnSingleImage

public void setAllowMultipleScanResultsOnSingleImage(boolean multiScan)

Sets whether or not outputting of multiple scan results from same image is allowed. If that is true, it is possible to return multiple recognition results from same image. If this option is false, at most single recognizer inside this bundle will be updated with latest results. If this option is true, it is possible that multiple recognizers inside this bundle will be updated with latest results. The upside of setting that option to false is the speed - if you have lots of recognizers in this bundle, as soon as the first recognizer succeeds in scanning, recognition chain will be terminated and other recognizers will not get a chance to analyze the image. The downside is that you are then unable to obtain multiple results from single image.

setNumMsBeforeTimeout

public void setNumMsBeforeTimeout(int numMsBeforeTimeout)

Set the duration in milliseconds that needs to pass since scanning has begun in order to define timeout. Please be aware that time counting does not start from the moment when scanning starts. Instead it starts from the moment when at least one Recognizer.Result inside recognizers in this bundle changes its state Recognizer.Result.getResultState() to either Recognizer.Result.State.Uncertain or Recognizer.Result.State.Valid.

The reason for this is the better user experience in cases when for example timeout is set to 10 seconds and user starts scanning and leaves device lying on table for 9 seconds and then points the device towards the object it wants to scan: in such case it is better to let that user scan the object it wants instead of completing scan with empty scan result as soon as 10 seconds timeout ticks out.

Parameters:

numMsBeforeTimeout - duration in milliseconds

getNumMsBeforeTimeout

public int getNumMsBeforeTimeout()

Returns the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.

Returns:

the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.

See Also:

RecognizerBundle.setNumMsBeforeTimeout(int)

setFrameQualityEstimationMode

public void setFrameQualityEstimationMode(@NonNull
                                          RecognizerBundle.FrameQualityEstimationMode mode)

Sets the mode of the frame quality estimation. If automatic, it will be used if at least one enabled recognizer requires it or if device is fast enough to perform it always (default). If always on or always off, it will not depend on active recognizers nor device. Frame quality estimation helps choosing the best possible frame from camera stream for processing.

Parameters:

mode - Desired mode of frame quality estimation.

getFrameQualityEstimationMode

@NonNull
public RecognizerBundle.FrameQualityEstimationMode getFrameQualityEstimationMode()

getUniqueIdIntentExtraKey

@NonNull
protected java.lang.String getUniqueIdIntentExtraKey()

getConcreteCreator

@NonNull
protected <any> getConcreteCreator()

consumeContentFromLoadedObject

protected void consumeContentFromLoadedObject(@NonNull
                                              RecognizerBundle loadedBundle)

saveToIntent

public void saveToIntent(@NonNull
                         android.content.Intent intent)

Saves this RecognizerBundle to Intent so it can be passed to another Activity.

Parameters:

intent - Intent to which RecognizerBundle should be saved.

equals

public boolean equals(@Nullable
                      java.lang.Object o)

readFromParcel

protected void readFromParcel(@NonNull
                              android.os.Parcel in)

writeToParcel

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