com.scantrust.mobile.android_sdk.controllers

Class DoublePingFlowController

Object

com.scantrust.mobile.android_sdk.controllers.DoublePingFlowController

public class DoublePingFlowController
extends Object

Controller for the "double ping" flow.

• Based on the same flow as the "Three Steps" flow:
  The flow starts with the camera zoomed out and is in a state where it's waiting for a code to be scanned (step 1). If a code is read and is sufficiently centered (in a position that still makes it visible with the 4x zoom), then the zoom in is done and the controller will be waiting for a code that meets the size constraint (step 2). Otherwise, the user will be told that he needs to center the code. As soon as a code meets the size constraint in the Fit QR state, the torch is turned on and as soon as the white balance is stabilised, the regular authentication process kicks in (step 3).
• Requires extra code-dependent parameters
  If no parameters are available for the current code, then the app will be notified that the controller is expecting them. If the code has encoded parameters in its content, then the flow will continue as in the three steps flow, if not, then the flow will be paused. As soon as new parameters are provided, if the code is not already known, then they get propagated to the quality processing part and are applied to the next frames.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DoublePingFlowController.Builder Builder class for the double ping flow controller.
static interface	DoublePingFlowController.DoublePingCallback Callback interface for the flow events.

Method Summary

Modifier and Type	Method and Description
void	doAutoFocus(float motionX, float motionY, int viewWidth, int viewHeight) Triggers the camera's auto-focus on the provided touch location.
View	getPreviewView() Returns the View that was created by the manager and on which the camera preview is drawn.
void	pauseProcessing() Pauses the ScanTrust frame processing.
void	releaseCamera() Releases the underlying camera object, stops the preview and stops the ScanTrust frame processing.
void	resetFlow() Resets the state of the flow to only reading the content of the codes.
void	restartProcessing() Restarts the ScanTrust frame processing.
void	setCameraTorchModeOnOff(boolean turnOn) Turns the torch on or off depending on the value of turnOn.
void	setCodeParams(String message, int blurThreshBias, int activationStatus, int trainingStatus) Set the scanning parameters of the a code.
void	startCamera() Starts the underlying camera object, its preview and starts the ScanTrust frame processing.

Methods inherited from class Object

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

Method Detail

resetFlow

public void resetFlow()

Resets the state of the flow to only reading the content of the codes. If the flow starts out zoomed out, then the zoom will be reset.

restartProcessing

public void restartProcessing()

Restarts the ScanTrust frame processing. Should be used when the frame processing has been paused. Note: this will not have an impact on the camera or its preview, but will restart the response flow.

pauseProcessing

public void pauseProcessing()

Pauses the ScanTrust frame processing. The flow of responses will stop, but the camera and it preview will not be affected.

startCamera

public void startCamera()

Starts the underlying camera object, its preview and starts the ScanTrust frame processing.

releaseCamera

public void releaseCamera()

Releases the underlying camera object, stops the preview and stops the ScanTrust frame processing.

setCameraTorchModeOnOff

public void setCameraTorchModeOnOff(boolean turnOn)

Turns the torch on or off depending on the value of turnOn.

Parameters:

turnOn - true to turn the torch on

doAutoFocus

public void doAutoFocus(float motionX,
                        float motionY,
                        int viewWidth,
                        int viewHeight)

Triggers the camera's auto-focus on the provided touch location. The x and y values should typically come from a View.OnTouchListener#onTouch(View, MotionEvent) The view's dimensions are required to map the touch to the sensor's space.

Parameters:

motionX - The x touch location

motionY - The y touch location

viewWidth - The view's width

viewHeight - The views' height

getPreviewView

public View getPreviewView()

Returns the View that was created by the manager and on which the camera preview is drawn.

Returns:

the camera View

setCodeParams

public void setCodeParams(String message,
                          int blurThreshBias,
                          int activationStatus,
                          int trainingStatus)

Set the scanning parameters of the a code.

Parameters:

message - The code content

blurThreshBias - The bias to be applied to the blur threshold.

activationStatus - The activation state of the code

trainingStatus - The training status of the code