io.scanbot.sdk.contourdetector

Class ContourDetectorFrameHandler

io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler

public class ContourDetectorFrameHandler

Performs contour detection on camera preview frames. Outputs results via interface ContourDetectorFrameHandler.ResultHandler (.addResultHandler).

Preview frame considered intercepted if at least one interface ContourDetectorFrameHandler.ResultHandler returns true from ContourDetectorFrameHandler.ResultHandler.handle (FrameHandlerResult)}

See Also:

interface ContourDetectorFrameHandler.ResultHandler, .addResultHandler, interface ContourDetectorFrameHandler.ResultHandler

Field Detail

Companion

public static io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.Companion Companion

Constructor Detail

ContourDetectorFrameHandler

public ContourDetectorFrameHandler(@NotNull
                                   android.content.Context context,
                                   @NotNull
                                   io.scanbot.sdk.core.contourdetector.ContourDetector contourDetector)

Performs contour detection on camera preview frames. Outputs results via interface ContourDetectorFrameHandler.ResultHandler (.addResultHandler).

Preview frame considered intercepted if at least one interface ContourDetectorFrameHandler.ResultHandler returns true from ContourDetectorFrameHandler.ResultHandler.handle (FrameHandlerResult)}

See Also:

interface ContourDetectorFrameHandler.ResultHandler, .addResultHandler, interface ContourDetectorFrameHandler.ResultHandler

Method Detail

isEnabled

public boolean isEnabled()

Returns:

true if contour detection is enabled. false if contour detection is disabled, i.e. incoming frames are skipped.

setEnabled

public void setEnabled(boolean p)

handleFrame

@Synchronized
public boolean handleFrame(@NotNull
                                         io.scanbot.sdk.camera.FrameHandler.Frame previewFrame)

addResultHandler

public void addResultHandler(@NotNull
                             io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.ResultHandler handler)

Registers result handler which will be notified about contour detection results.

Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.

Parameters:

handler - handler to register. Must not be null. If handler was alreadyregistered, nothing happens.

removeResultHandler

public void removeResultHandler(@NotNull
                                io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.ResultHandler handler)

Unregisters handler.

Parameters:

handler - handler to unregister. If it was not registered before, nothing happens.

clearResultHandlers

public void clearResultHandlers()

Unregisters all handlers.

setAcceptedAngleScore

public void setAcceptedAngleScore(double acceptedAngleScore)

The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion.

Warning: Lower values result in more blurred document images.

Parameters:

acceptedAngleScore -

setAcceptedSizeScore

public void setAcceptedSizeScore(double acceptedSizeScore)

The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0.

Warning: Lower values result in low resolution document images.

Parameters:

acceptedSizeScore -

setRequiredAspectRatios

public void setRequiredAspectRatios(@Nullable
                                    java.util.List<io.scanbot.sdk.core.contourdetector.PageAspectRatio> requiredPageAspectRatios)

Set required PageAspectRatios.

Parameters:

requiredPageAspectRatios -

notifyHandlers

protected boolean notifyHandlers(@NotNull
                                 io.scanbot.sdk.camera.FrameHandlerResult<io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame,io.scanbot.sdk.SdkLicenseError> result)

<no name provided>

public void <no name provided>()

Continuously notified about contour detection results.

attach

@JvmStatic
 @NotNull
public static ContourDetectorFrameHandler attach(@NotNull
                                                                      io.scanbot.sdk.ui.camera.IScanbotCameraView cameraView,
                                                                      @NotNull
                                                                      io.scanbot.sdk.core.contourdetector.ContourDetector detector)

Convenience method for creating new class ContourDetectorFrameHandler and adding it as FrameHandler to given camera view.

Parameters:

cameraView - camera view to which new contour detector will be attached

detector - contour detector instance

Returns:

new class ContourDetectorFrameHandler

See Also:

class ContourDetectorFrameHandler