io.scanbot.sdk.camera.autosnapping

Class BaseAutoSnappingController<T>

io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController<T>

All Implemented Interfaces:

IAutoSnappingController<T>

public class BaseAutoSnappingController<T>
implements IAutoSnappingController<T>

Base interface IAutoSnappingController implementation, that is, in theory, to suffice any scenario needs.

This class wraps all device- and camera's lifecycle-specific code, as well as two conditions validation - significant move timeout and capture interval timeout.

See Also:

interface IAutoSnappingController, detach

Field Detail

FORCE_AUTOFOCUS_BEFORE_SNAP_DEFAULT

public static boolean FORCE_AUTOFOCUS_BEFORE_SNAP_DEFAULT

See Also:

Constant Field Values

Companion

public static io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController.Companion Companion

Deprecated.

Constructor Detail

BaseAutoSnappingController

public BaseAutoSnappingController(@NotNull
                                  IScanbotCameraView cameraView)

Base interface IAutoSnappingController implementation, that is, in theory, to suffice any scenario needs.

This class wraps all device- and camera's lifecycle-specific code, as well as two conditions validation - significant move timeout and capture interval timeout.

See Also:

interface IAutoSnappingController, detach

Method Detail

getStateListener

@NotNull
public io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.AutoSnappingStateListener getStateListener()

setStateListener

public void setStateListener(@NotNull
                             io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.AutoSnappingStateListener value)

isResumed

@NotNull
protected java.util.concurrent.atomic.AtomicBoolean isResumed()

isEnabled

public boolean isEnabled()

Flag to disable autosnapping processing. In case of false frames will be skipped.

setEnabled

public void setEnabled(boolean p)

Flag to disable autosnapping processing. In case of false frames will be skipped.

setForceAutofocusBeforeSnap

public void setForceAutofocusBeforeSnap(boolean forceAutofocusBeforeSnap)

Parameters:

forceAutofocusBeforeSnap -

true to enable auto focus before snapping, false to snap whenever requested.

Default is false

setShakeDetectionEnabled

public void setShakeDetectionEnabled(boolean enabled)

Allows to enable or disable shake detection before autosnapping. It will wait for 2 seconds of stable values from accelerometer before taking a picture. Default is true

setSensitivity

public void setSensitivity(float sensitivity)

Changes sensitivity of auto-snapping. That is: the more sensitive it is the faster it shoots.

Sensitivity must be within [0..1] range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds.

The default value is CaptureIntervalAutoSnappingPredicate.DEFAULT_SENSITIVITY (~1 sec)

Parameters:

sensitivity - sensitivity within [0..1] range. If given value is outside of this rangeit is clamped

trySnap

public void trySnap(@NotNull
                    T parameter)

Start conditions evaluation and, maybe, take a snap, e.g. depending on current image status, snap interval etc.

runPredicates

@CallSuper
protected boolean runPredicates(@NotNull
                                           T param)

Run particular implementation's autosnapping conditions checks.

Note the ability to specify predicates order together with distinguishing logical operators that short-circuit ('&&' and '||') and those that validate both sides of comparison (inflix 'and', 'or')

Returns:

true if autosnapping conditions are met and image can be taken now.

setAutoSnappingCallback

public void setAutoSnappingCallback(@Nullable
                                    io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.Callback callback)

Set callback. Defaults to IAutoSnappingController.Callback.NULL

Parameters:

callback - to set or null to reset to default.

See Also:

IAutoSnappingController.Callback.NULL, interface IAutoSnappingController.Callback

detach

public void detach()

Allows to detach successor implementation class. To be called in place of usage when screen hierarchy is being destroyed.

resetPredicates

@CallSuper
protected void resetPredicates()

Resets all predicates that store state.

See Also:

io.scanbot.sdk.camera.autosnapping.ResettablePredicate.reset