com.scantrust.mobile.android_sdk.camera

Class ScanTrustCameraManager

Object

com.scantrust.mobile.android_sdk.camera.ScanTrustCameraManager

public abstract class ScanTrustCameraManager
extends Object

The entry point of the ScanTrust Processing, this abstract class is used to obtain the manager that will best fit with the phone's camera.

This class can be directly used to manage the camera, but for consumer facing apps, it is recommended to use the controller classes that wrap this one and manage a smooth scanning experience. It should be instantiated in the creation phase of your screen.

Handling:
It is up to the user to determine when to start and stop the camera or the processing. But in general the camera is started in Activity.onResume() and released in Activity.onPause().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanTrustCameraManager.Builder Builder class for the camera manager
static interface	ScanTrustCameraManager.ManagerCallback Callback interface for the camera events.

Constructor Summary

Constructors

Constructor and Description
ScanTrustCameraManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkCodePositioning(QRCodeData data) Checks if the code is centered in the image
abstract void	doAutoFocus(float motionX, float motionY, int viewWidth, int viewHeight) Triggers the camera's auto-focus on the provided touch location.
abstract void	doZoomIn(Handler zoomHandler) Performs the automatic zooming-in if the camera is not already zoomed-in.
static CameraApiVersion	getPreferredCameraApi(Activity activity) Provides the version of the camera api that will be used for the current phone.
abstract <T extends View> T	getPreviewView() Returns the View that was created by the manager and on which the camera preview is drawn.
abstract boolean	isZoomedOut() Is the camera zoomed-out
abstract void	pauseProcessing() Pauses the ScanTrust frame processing.
abstract void	releaseCamera() Stops the ScanTrust frame processing, stops the preview and releases the underlying camera object.
abstract void	resetAuthParams() Reset the authentication parameters.
abstract void	resetZoom() Resets the "zoom-in" flow (i.e.
abstract void	restartProcessing() Restarts the ScanTrust frame processing.
abstract void	setAuthParams(int blurThresholdBias) Pass the custom settings to the underlying processor
abstract void	setAuthScanning(boolean scanForAuthentication) Triggers the processing for the authentication, as opposed to the processing for the content of the codes.
abstract void	setCameraTorchModeOnOff(boolean turnOn) Turns the torch on or off depending on the value of turnOn.
abstract void	setScalingFactor(int physicalSize) Sets the scaling factor for the QR detection according to the given code physical size.
abstract void	startCamera() Starts the underlying camera object, its preview and starts the ScanTrust frame processing once the setup is done.

Methods inherited from class Object

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

Constructor Detail

ScanTrustCameraManager

public ScanTrustCameraManager()

Method Detail

doZoomIn

public abstract void doZoomIn(Handler zoomHandler)

Performs the automatic zooming-in if the camera is not already zoomed-in.

Parameters:

zoomHandler - A handler to be notified when the zoom-in is finished.

checkCodePositioning

public abstract boolean checkCodePositioning(QRCodeData data)

Checks if the code is centered in the image

Parameters:

data - The code's data

Returns:

True if the code is "sufficiently" centered, False otherwise

setScalingFactor

public abstract void setScalingFactor(int physicalSize)

Sets the scaling factor for the QR detection according to the given code physical size.

Parameters:

physicalSize - the code size in 10^-4 m

restartProcessing

public abstract 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 abstract 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 abstract void startCamera()

Starts the underlying camera object, its preview and starts the ScanTrust frame processing once the setup is done.

releaseCamera

public abstract void releaseCamera()

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

setCameraTorchModeOnOff

public abstract void setCameraTorchModeOnOff(boolean turnOn)

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

Parameters:

turnOn - true to turn the torch on

resetZoom

public abstract void resetZoom()

Resets the "zoom-in" flow (i.e. the camera is zoomed-out and the processing is adapted to the smaller code)

setAuthScanning

public abstract void setAuthScanning(boolean scanForAuthentication)

Triggers the processing for the authentication, as opposed to the processing for the content of the codes.

Parameters:

scanForAuthentication - True to start the authentication processing

isZoomedOut

public abstract boolean isZoomedOut()

Is the camera zoomed-out

Returns:

True if it is zoomed-out

doAutoFocus

public abstract 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 abstract <T extends View> T getPreviewView()

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

Type Parameters:

T - a subclass of View

Returns:

the camera View

setAuthParams

public abstract void setAuthParams(int blurThresholdBias)

Pass the custom settings to the underlying processor

Parameters:

blurThresholdBias - the blur threshold

resetAuthParams

public abstract void resetAuthParams()

Reset the authentication parameters. Typically used with the double ping flow when a different code is scanned than the one for which we have the params.

getPreferredCameraApi

public static CameraApiVersion getPreferredCameraApi(Activity activity)
                                              throws CameraAccessException

Provides the version of the camera api that will be used for the current phone.

Parameters:

activity - An activity to access the Context.CAMERA_SERVICE

Returns:

a CameraApiVersion.

Throws:

CameraAccessException - if something went wrong