com.microblink.metadata

Class MetadataSettings

java.lang.Object

com.microblink.metadata.MetadataSettings

public class MetadataSettings
extends java.lang.Object

Class that defines which metadata will be available in MetadataListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataSettings.ImageMetadataSettings Settings specific to which image metadata will be available in MetadataListener

Constructor Summary

Constructors

Constructor and Description
MetadataSettings()

Method Summary

Modifier and Type	Method and Description
MetadataSettings.ImageMetadataSettings	getImageMetadataSettings() Returns the object containing settings defining which images (presented with ImageMetadata) should be available in MetadataListener.
boolean	isDebugMetadataAllowed() Returns true if debug metadata (presented as TextMetadata) will be available in MetadataListener.
boolean	isDetectionMetadataAllowed() Returns true if DetectionMetadata will be available in MetadataListener.
boolean	isGlareMetadataAllowed() Returns true if GlareMetadata will be available in MetadataListener.
boolean	isOcrMetadataAllowed() Returns true if OcrMetadata will be available in MetadataListener.
boolean	isPartialResultMetadataAllowed() Returns true if RecognitionResultMetadata will be available in MetadataListener.
void	setDebugMetadataAllowed(boolean debugMetadataAllowed) Sets whether debug metadata (presented as TextMetadata) should be available in MetadataListener.
void	setDetectionMetadataAllowed(boolean detectionMetadataAllowed) Sets whether DetectionMetadata should be available in MetadataListener.
void	setGlareMetadataAllowed(boolean glareMetadataAllowed) Sets whether GlareMetadata should be available in MetadataListener.
void	setImageMetadataSettings(MetadataSettings.ImageMetadataSettings imageMetadataSettings) Sets object containing settings defining which images should be available in MetadataListener.
void	setOcrMetadataAllowed(boolean ocrMetadataAllowed) Sets whether OcrMetadata should be available in MetadataListener.
void	setPartialResultMetadataAllowed(boolean partialResultMetadataAllowed) Sets whether RecognitionResultMetadata will be available in MetadataListener.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataSettings

public MetadataSettings()

Method Detail

isDetectionMetadataAllowed

public boolean isDetectionMetadataAllowed()

Returns true if DetectionMetadata will be available in MetadataListener. Detection metadatas are all metadata objects from com.microblink.metadata.detection package.

Returns:

true if DetectionMetadata will be available in MetadataListener.

setDetectionMetadataAllowed

public void setDetectionMetadataAllowed(boolean detectionMetadataAllowed)

Sets whether DetectionMetadata should be available in MetadataListener. Detection metadatas are all metadata objects from com.microblink.metadata.detection package.

Parameters:

detectionMetadataAllowed - whether DetectionMetadata should be available in MetadataListener.

isPartialResultMetadataAllowed

public boolean isPartialResultMetadataAllowed()

Returns true if RecognitionResultMetadata will be available in MetadataListener.

Returns:

true if RecognitionResultMetadata will be available in MetadataListener.

setPartialResultMetadataAllowed

public void setPartialResultMetadataAllowed(boolean partialResultMetadataAllowed)

Sets whether RecognitionResultMetadata will be available in MetadataListener.

Parameters:

partialResultMetadataAllowed - whether RecognitionResultMetadata will be available in MetadataListener.

isDebugMetadataAllowed

public boolean isDebugMetadataAllowed()

Returns true if debug metadata (presented as TextMetadata) will be available in MetadataListener.

Returns:

true if debug metadata will be available in MetadataListener.

setDebugMetadataAllowed

public void setDebugMetadataAllowed(boolean debugMetadataAllowed)

Sets whether debug metadata (presented as TextMetadata) should be available in MetadataListener.

Parameters:

debugMetadataAllowed - whether debug metadata should be available in MetadataListener.

isOcrMetadataAllowed

public boolean isOcrMetadataAllowed()

Returns true if OcrMetadata will be available in MetadataListener. Regardless of this, OcrMetadata can only be available if OCR-based recognizer is active.

Returns:

true if OcrMetadata will be available in MetadataListener.

setOcrMetadataAllowed

public void setOcrMetadataAllowed(boolean ocrMetadataAllowed)

Sets whether OcrMetadata should be available in MetadataListener. Regardless of this setting, OcrMetadata can only be available if OCR-based recognizer is active.

Parameters:

ocrMetadataAllowed - whether OcrMetadata should be available in MetadataListener.

isGlareMetadataAllowed

public boolean isGlareMetadataAllowed()

Returns true if GlareMetadata will be available in MetadataListener. GlareMetadata contains information about whether glare was detected in current video frame.

Returns:

true if GlareMetadata should be available in MetadataListener, false otherwise.

setGlareMetadataAllowed

public void setGlareMetadataAllowed(boolean glareMetadataAllowed)

Sets whether GlareMetadata should be available in MetadataListener. GlareMetadata contains information about whether glare was detected in current video frame.

Parameters:

glareMetadataAllowed - whether GlareMetadata should be available in MetadataListener.

getImageMetadataSettings

public MetadataSettings.ImageMetadataSettings getImageMetadataSettings()

Returns the object containing settings defining which images (presented with ImageMetadata) should be available in MetadataListener.

Returns:

the object containing settings defining which images (presented with ImageMetadata) should be available in MetadataListener.

setImageMetadataSettings

public void setImageMetadataSettings(MetadataSettings.ImageMetadataSettings imageMetadataSettings)

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

Parameters:

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