com.scantrust.mobile.android_sdk.camera

Class ScanTrustCameraManager.Builder

Object

com.scantrust.mobile.android_sdk.camera.ScanTrustCameraManager.Builder

Enclosing class:

ScanTrustCameraManager

public static class ScanTrustCameraManager.Builder
extends Object

Builder class for the camera manager

Field Summary

Fields

Modifier and Type	Field and Description
protected Activity	activity
protected CropType	cropType
protected float	desiredZoom
protected boolean	isQa
protected ScanTrustCameraManager.ManagerCallback	managerCallback
protected CameraApiVersion	requiredCameraApi
protected boolean	requireDetailedContent
protected boolean	startWithTorchOn
protected boolean	startZoomedOut

Constructor Summary

Constructors

Constructor and Description
Builder(Activity activity, ScanTrustCameraManager.ManagerCallback managerCallback)

Method Summary

Modifier and Type	Method and Description
ScanTrustCameraManager	build() Builds a manager which uses the best camera api for the phone.
ScanTrustCameraManager.Builder	cropType(CropType ct) Defines the type of crop to perform on the scan(fingerprint or QR code) The default is fingerprint.
ScanTrustCameraManager.Builder	detailedContent(boolean details) Deprecated.
ScanTrustCameraManager.Builder	imposeCameraApi(CameraApiVersion cameraApiVersion) Enforces the use of the given Camera Api.
ScanTrustCameraManager.Builder	isQa(boolean qa) Defines if the manager is used in a QA app or not.
ScanTrustCameraManager.Builder	setDesiredZoom(float desiredZoom) Don't use unless you know what you are doing. Defines the desire zoomed-in level.
ScanTrustCameraManager.Builder	startWithTorchOn(boolean torch) Defines if the camera starts with the torch on or not
ScanTrustCameraManager.Builder	startZoomedOut(boolean zoom) Defines if the camera starts zoomed out or not.

Methods inherited from class Object

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

Field Detail

activity

protected final Activity activity

managerCallback

protected final ScanTrustCameraManager.ManagerCallback managerCallback

cropType

protected CropType cropType

isQa

protected boolean isQa

startZoomedOut

protected boolean startZoomedOut

requireDetailedContent

protected boolean requireDetailedContent

desiredZoom

protected float desiredZoom

requiredCameraApi

protected CameraApiVersion requiredCameraApi

startWithTorchOn

protected boolean startWithTorchOn

Constructor Detail

Builder

public Builder(Activity activity,
               ScanTrustCameraManager.ManagerCallback managerCallback)

Method Detail

cropType

public ScanTrustCameraManager.Builder cropType(CropType ct)

Defines the type of crop to perform on the scan(fingerprint or QR code) The default is fingerprint.

Parameters:

ct - the crop type

Returns:

a ScanTrustCameraManager.Builder

isQa

public ScanTrustCameraManager.Builder isQa(boolean qa)

Defines if the manager is used in a QA app or not. Default: false

Parameters:

qa - true if the context of the scan is the printing quality assurance

Returns:

a ScanTrustCameraManager.Builder

startZoomedOut

public ScanTrustCameraManager.Builder startZoomedOut(boolean zoom)

Defines if the camera starts zoomed out or not.

Default: true --> zoomed out

Parameters:

zoom - true to start zoomed out

Returns:

a ScanTrustCameraManager.Builder

detailedContent

@Deprecated
public ScanTrustCameraManager.Builder detailedContent(boolean details)

Deprecated.

startWithTorchOn

public ScanTrustCameraManager.Builder startWithTorchOn(boolean torch)

Defines if the camera starts with the torch on or not

Default: false --> starts turned off

Parameters:

torch - true to start with the torch on

Returns:

a ScanTrustCameraManager.Builder

setDesiredZoom

public ScanTrustCameraManager.Builder setDesiredZoom(float desiredZoom)

Don't use unless you know what you are doing.
Defines the desire zoomed-in level. There are no guarantees that the result will match this value, it's an indicative value that should, in general, not be set and is only used in very special conditions.

Parameters:

desiredZoom - the desired zoomed-in level. Acceptable values: [1-4]

Returns:

a ScanTrustCameraManager.Builder

imposeCameraApi

public ScanTrustCameraManager.Builder imposeCameraApi(CameraApiVersion cameraApiVersion)

Enforces the use of the given Camera Api. WARNING, the use of this method should be limited to R&D purposes, enforcing a camera api could result in serious issues for unadapted phones.
Note: The default value is CameraApiVersion.NONE which will result in the manager being chosen automatically

Parameters:

cameraApiVersion - the required api version

Returns:

the builder instance

build

public ScanTrustCameraManager build()
                             throws CameraAccessException

Builds a manager which uses the best camera api for the phone. Unless a camera api version has already been specified.

Returns:

an instance of ScanTrustCameraManager

Throws:

CameraAccessException - if something went wrong with the camera setup.