com.microblink.metadata

Class MetadataSettings.ImageMetadataSettings

java.lang.Object

com.microblink.metadata.MetadataSettings.ImageMetadataSettings

All Implemented Interfaces:

android.os.Parcelable

Enclosing class:

MetadataSettings

public static class MetadataSettings.ImageMetadataSettings
extends java.lang.Object
implements android.os.Parcelable

Settings specific to which image metadata will be available in MetadataListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataSettings.ImageMetadataSettings.DebugImageMetadataSettings

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

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

Field Summary

Fields

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

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImageMetadataSettings()
protected	ImageMetadataSettings(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
MetadataSettings.ImageMetadataSettings.DebugImageMetadataSettings	getDebugImageMetadataSettings() Returns the object containing settings defining which debug images should be available in MetadataListener.
boolean	isCurrentVideoFrameEnabled() Returns true if current video frame should be available in MetadataListener.
boolean	isDewarpedImageEnabled() Returns true if dewarped image should be available in MetadataListener.
boolean	isSuccessfulScanFrameEnabled() Returns true if image that was used to obtain valid scanning result will be available in MetadataListener.
void	setCurrentVideoFrameEnabled(boolean currentVideoFrameEnabled) Sets whether current video frame should be available in MetadataListener.
void	setDebugImageMetadataSettings(MetadataSettings.ImageMetadataSettings.DebugImageMetadataSettings debugImageMetadataSettings) Sets object containing settings defining which debug images should be available in MetadataListener.
void	setDewarpedImageEnabled(boolean dewarpedImageEnabled) Sets whether dewarped image should be available in MetadataListener.
void	setSuccessfulScanFrameEnabled(boolean successfulScanFrameEnabled) Sets whether image that was used to obtain valid scanning result will be available in MetadataListener.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<MetadataSettings.ImageMetadataSettings> CREATOR

Constructor Detail

ImageMetadataSettings

public ImageMetadataSettings()

ImageMetadataSettings

protected ImageMetadataSettings(android.os.Parcel in)

Method Detail

isCurrentVideoFrameEnabled

public boolean isCurrentVideoFrameEnabled()

Returns true if current video frame should be available in MetadataListener.

Returns:

true if current video frame should be available in MetadataListener.

setCurrentVideoFrameEnabled

public void setCurrentVideoFrameEnabled(boolean currentVideoFrameEnabled)

Sets whether current video frame should be available in MetadataListener.

Parameters:

currentVideoFrameEnabled - whether current video frame should be available in MetadataListener.

isDewarpedImageEnabled

public boolean isDewarpedImageEnabled()

Returns true if dewarped image should be available in MetadataListener.

Returns:

true if dewarped image should be available in MetadataListener.

setDewarpedImageEnabled

public void setDewarpedImageEnabled(boolean dewarpedImageEnabled)

Sets whether dewarped image should be available in MetadataListener.

Parameters:

dewarpedImageEnabled - whether dewarped image should be available in MetadataListener.

isSuccessfulScanFrameEnabled

public boolean isSuccessfulScanFrameEnabled()

Returns true if image that was used to obtain valid scanning result will be available in MetadataListener.

Returns:

true if image that was used to obtain valid scanning result will be available in MetadataListener.

setSuccessfulScanFrameEnabled

public void setSuccessfulScanFrameEnabled(boolean successfulScanFrameEnabled)

Sets whether image that was used to obtain valid scanning result will be available in MetadataListener.

Parameters:

successfulScanFrameEnabled - whether image that was used to obtain valid scanning result will be available in MetadataListener.

getDebugImageMetadataSettings

public MetadataSettings.ImageMetadataSettings.DebugImageMetadataSettings getDebugImageMetadataSettings()

Returns the object containing settings defining which debug images should be available in MetadataListener.

Returns:

the object containing settings defining which debug images should be available in MetadataListener.

setDebugImageMetadataSettings

public void setDebugImageMetadataSettings(MetadataSettings.ImageMetadataSettings.DebugImageMetadataSettings debugImageMetadataSettings)

Sets object containing settings defining which debug images should be available in MetadataListener.

Parameters:

debugImageMetadataSettings - object containing settings defining which debug images should be available in MetadataListener.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable