com.microblink.blinkinput.uisettings

Class DocumentCaptureUISettings

java.lang.Object

com.microblink.blinkinput.uisettings.UISettings

com.microblink.blinkinput.uisettings.DocumentCaptureUISettings

All Implemented Interfaces:

BeepSoundUIOptions, DebugImageListenerUIOptions, SplashScreenUIOptions, StringsUIOptions, StyleUIOptions

public final class DocumentCaptureUISettings
extends UISettings
implements DebugImageListenerUIOptions, SplashScreenUIOptions, BeepSoundUIOptions, StyleUIOptions, StringsUIOptions

Constructor Summary

Constructors

Constructor and Description
DocumentCaptureUISettings(DocumentCaptureRecognizerTransferable documentCaptureRecognizerTransferable)
DocumentCaptureUISettings(android.content.Intent intent)

Method Summary

Modifier and Type	Method and Description
DocumentCaptureOverlayController	createOverlayController(android.app.Activity activity, ScanResultListener scanResultListener) Creates overlay controller and configures it using set values.
DocumentCaptureRecognizerTransferable	getDocumentCaptureRecognizerTransferable()
java.lang.Class	getTargetActivity() Returns target activity.
void	saveToIntent(android.content.Intent intent) Saves this scan activity settings to Intent so it can be passed to the corresponding scan activity.
void	setBeepSoundResourceID(int beepSoundResourceID) Defines the resource ID of the sound to be played when recognition is successful.
void	setDebugImageListener(DebugImageListener debugImageListener) Sets implementation of DebugImageListener interface that will obtain images that are being processed.
void	setOverlayViewStyle(int styleResourceID) Provide your own style to replace default icons and colors.
void	setSplashScreenLayoutResourceID(int splashScreenLayoutResourceID) Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.
void	setStrings(DetectionOverlayStrings strings) Sets strings that will be used in the UI.

Methods inherited from class com.microblink.blinkinput.uisettings.UISettings

getActivityTheme, getFilterTouchesWhenObscured, getUsingFlagSecure, setActivityTheme, setCameraSettings, setFilterTouchesWhenObscured, setUsingFlagSecure

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCaptureUISettings

public DocumentCaptureUISettings(@NonNull
                                 DocumentCaptureRecognizerTransferable documentCaptureRecognizerTransferable)

DocumentCaptureUISettings

public DocumentCaptureUISettings(@NonNull
                                 android.content.Intent intent)

Method Detail

getDocumentCaptureRecognizerTransferable

@NonNull
public DocumentCaptureRecognizerTransferable getDocumentCaptureRecognizerTransferable()

getTargetActivity

@NonNull
public java.lang.Class getTargetActivity()

Description copied from class: UISettings

Returns target activity. Concrete settings can be used only with the corresponding activity. This method is public for convenience when you are not able to use ActivityRunner. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.

Specified by:

getTargetActivity in class UISettings

Returns:

target activity.

saveToIntent

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

Description copied from class: UISettings

Saves this scan activity settings to Intent so it can be passed to the corresponding scan activity. Intent target activity must be set before calling this method, and target activity must be compatible with this settings. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.

Overrides:

saveToIntent in class UISettings

Parameters:

intent - Intent to which this scan activity settings should be saved.

setOverlayViewStyle

public void setOverlayViewStyle(@StyleRes
                                int styleResourceID)

Provide your own style to replace default icons and colors. Supports attributes from R.styleable.DocumentCaptureDetectionOverlay

Specified by:

setOverlayViewStyle in interface StyleUIOptions

Parameters:

styleResourceID - your style

setStrings

public void setStrings(@NonNull
                       DetectionOverlayStrings strings)

Sets strings that will be used in the UI.

Specified by:

setStrings in interface StringsUIOptions

Parameters:

strings - strings that will be used

setBeepSoundResourceID

public final void setBeepSoundResourceID(int beepSoundResourceID)

Description copied from interface: BeepSoundUIOptions

Defines the resource ID of the sound to be played when recognition is successful.

Specified by:

setBeepSoundResourceID in interface BeepSoundUIOptions

Parameters:

beepSoundResourceID - resource ID of the sound to be played when recognition is successful.

setSplashScreenLayoutResourceID

public final void setSplashScreenLayoutResourceID(@LayoutRes
                                                  int splashScreenLayoutResourceID)

Description copied from interface: SplashScreenUIOptions

Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized. If not set, default splash screen will be used.

Specified by:

setSplashScreenLayoutResourceID in interface SplashScreenUIOptions

Parameters:

splashScreenLayoutResourceID - ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.

setDebugImageListener

public final void setDebugImageListener(@Nullable
                                        DebugImageListener debugImageListener)

Description copied from interface: DebugImageListenerUIOptions

Sets implementation of DebugImageListener interface that will obtain images that are being processed. DebugImageListener will receive all possible debug images that become available during recognition process.

Specified by:

setDebugImageListener in interface DebugImageListenerUIOptions

Parameters:

debugImageListener - Implementation of debug image listener or null to clear listener that has been set previously.

createOverlayController

@NonNull
public DocumentCaptureOverlayController createOverlayController(@NonNull
                                                                         android.app.Activity activity,
                                                                         @NonNull
                                                                         ScanResultListener scanResultListener)

Description copied from class: UISettings

Creates overlay controller and configures it using set values.

Specified by:

createOverlayController in class UISettings