ch.icare.smartscan

Class SmartScanner

java.lang.Object

ch.icare.smartscan.SmartScanner

public class SmartScanner
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static int	DEFAULT_MINIMAL_SCORE
static int	ID_AUTO_FOCUS
static int	ID_DEBUG
static int	ID_DECODE
static int	ID_DECODE_FAILED
static int	ID_DECODE_SUCCEEDED
static int	ID_LAUNCH_PRODUCT_QUERY
static int	ID_PAUSE_DECODING
static int	ID_QUIT
static int	ID_RESUME_DECODING
static int	ID_TAKE_PICTURE
static int	ID_VIDEO_REC_START
static int	ID_VIDEO_REC_STOP
static int	LANDSCAPE_MODE
static int	LANDSCAPE_REVERSE_MODE
static int	LEVEL_3
static int	LEVEL_FULL
static int	LEVEL_LIMITED
static int	NO_CAMERA_ID
static int	PORTRAIT_MODE
static int	PORTRAIT_REVERSE_MODE

Constructor Summary

Constructors

Constructor and Description
SmartScanner(android.content.Context context) Instantiate the SmartScanner object.
SmartScanner(android.content.Context context, int cameraId, int minScoreCameraAPI2) Instantiate the SmartScanner object with camera id.

Method Summary

Modifier and Type	Method and Description
void	enableMultipleResultsConfirmation(int numberConfirmations) While using a behavior that is different from SmartScannerResultBehaviorContinuous.
ch.icare.smartscan.camera.controllers.CameraController	getCameraController() Gets CameraControllerLegacy used to interact with the device
int	getCameraFPS() Number of confirmations before validate a result of the decoder.
android.content.Context	getContext() Get the context.
int	getForcedOrientation() Gets the forced orientation choose by the user.
ch.icare.smartscan.camera.handlers.SmartScannerHandler	getHandler() Gets the smartscanner app thread Handler that binds with decoding thread
int	getNumberResultsConfirmation() Number of confirmations before validate a result of the decoder.
android.graphics.Rect	getRegionOfInterest() Get current region of interest.
java.lang.String	getTypeSmartscan() Get the description of the smartscan library used.
java.lang.String	getVersion() Displays smartscan java library information.
void	handleDecoderResult(DecodedResult decodedResult) A valid result has been found, so execute callback if given.
void	init() Initializes the SmartScanner library objects and processes.
boolean	isFlashAvailable() Checks if flashlight is available on device.
boolean	isForcedOrientationEnabled() Gets the information about the manual orientation (true/false)
boolean	isZoomSupported() Get the information about the availability of the zoom .
void	manualFocus(float x, float y, android.view.View view, boolean isFocusRectangleVisible) On double tap we switch to manual focus.
void	pauseDecoding() Pauses the decoding process.
void	release() This methods frees memory by releasing objects and processes used by SmartScanner.
void	restartDecoding() Restarts the decoding process.
void	setAutoFocusEnabled(boolean isAutoFocusEnabled) If not already activated we turn on the auto focus.
void	setBeepOn(int beepResId) Deprecated.
void	setCanvasDrawer(CanvasDrawerInterface canvasDrawer) Sets the CanvasDrawer, ie. the view that displays the target.
void	setContinuousDecoding(boolean isContinuousDecoding) Restarts decoding as soon as a result has been found, without manual call to restartDecoding.
void	setDecodingType(long decodingType, long decodingSubType) Sets the decoder to use.
void	setFlashEnabled(boolean isFlashEnabled) Enables/Disables the flashlight LED during the scanning process
void	setOnErrorListener(OnDecoderErrorListener listener)
void	setOnLoadedListener(OnDecoderLoadedListener listener)
void	setOnResultListener(OnDecoderResultFoundListener listener) Setting the listeners for the application.
void	setOrientationDecoding(boolean forceOrientationEnabled, int scanOrientation) Set the new orientation decoding on the device.
void	setRegionOfInterest(android.graphics.Rect rect) Allows to manually set the region of interest.
void	setTextureView(AutoFitTextureView textureView) Defines the AutoFitTextureView holding the camera preview, inside your layouts.
void	setVibrateOn(boolean enabled) Deprecated.
void	setZoomCamera(int zoom) Set the zoom of the camera.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

ID_AUTO_FOCUS

public static final int ID_AUTO_FOCUS

See Also:

Constant Field Values

ID_DECODE

public static final int ID_DECODE

See Also:

Constant Field Values

ID_DECODE_FAILED

public static final int ID_DECODE_FAILED

See Also:

Constant Field Values

ID_DECODE_SUCCEEDED

public static final int ID_DECODE_SUCCEEDED

See Also:

Constant Field Values

ID_LAUNCH_PRODUCT_QUERY

public static final int ID_LAUNCH_PRODUCT_QUERY

See Also:

Constant Field Values

ID_QUIT

public static final int ID_QUIT

See Also:

Constant Field Values

ID_RESUME_DECODING

public static final int ID_RESUME_DECODING

See Also:

Constant Field Values

ID_PAUSE_DECODING

public static final int ID_PAUSE_DECODING

See Also:

Constant Field Values

ID_DEBUG

public static final int ID_DEBUG

See Also:

Constant Field Values

ID_VIDEO_REC_START

public static final int ID_VIDEO_REC_START

See Also:

Constant Field Values

ID_VIDEO_REC_STOP

public static final int ID_VIDEO_REC_STOP

See Also:

Constant Field Values

ID_TAKE_PICTURE

public static final int ID_TAKE_PICTURE

See Also:

Constant Field Values

LEVEL_LIMITED

public static final int LEVEL_LIMITED

See Also:

Constant Field Values

LEVEL_FULL

public static final int LEVEL_FULL

See Also:

Constant Field Values

LEVEL_3

public static final int LEVEL_3

See Also:

Constant Field Values

NO_CAMERA_ID

public static final int NO_CAMERA_ID

See Also:

Constant Field Values

DEFAULT_MINIMAL_SCORE

public static final int DEFAULT_MINIMAL_SCORE

See Also:

Constant Field Values

LANDSCAPE_MODE

public static final int LANDSCAPE_MODE

See Also:

Constant Field Values

PORTRAIT_MODE

public static final int PORTRAIT_MODE

See Also:

Constant Field Values

LANDSCAPE_REVERSE_MODE

public static final int LANDSCAPE_REVERSE_MODE

See Also:

Constant Field Values

PORTRAIT_REVERSE_MODE

public static final int PORTRAIT_REVERSE_MODE

See Also:

Constant Field Values

Constructor Detail

SmartScanner

public SmartScanner(android.content.Context context)

Instantiate the SmartScanner object.

Parameters:

context - Context

SmartScanner

public SmartScanner(android.content.Context context,
                    int cameraId,
                    int minScoreCameraAPI2)

Instantiate the SmartScanner object with camera id.

Parameters:

context - Context

cameraId - int (put NO_CAMERA_ID to search all cameras)

minScoreCameraAPI2 - Choose the level where switch the new API for the camera The options are: LEVEL_LIMITED, LEVEL_FULL, LEVEL_3, DEFAULT_MINIMAL_SCORE. DEFAULT_MINIMAL_SCORE is by default set to LEVEL_LIMITED.

Method Detail

getTypeSmartscan

public java.lang.String getTypeSmartscan()

Get the description of the smartscan library used.

Returns:

String

setOnResultListener

public void setOnResultListener(OnDecoderResultFoundListener listener)

Setting the listeners for the application.

setOnLoadedListener

public void setOnLoadedListener(OnDecoderLoadedListener listener)

setOnErrorListener

public void setOnErrorListener(OnDecoderErrorListener listener)

getContext

public android.content.Context getContext()

Get the context.

Returns:

Context of the application.

setContinuousDecoding

public void setContinuousDecoding(boolean isContinuousDecoding)

Restarts decoding as soon as a result has been found, without manual call to restartDecoding. Default is false.

Parameters:

isContinuousDecoding - true if the decoder should decode continuously, false to pause after result

setBeepOn

@Deprecated
public void setBeepOn(int beepResId)

Deprecated.

Enables and set the beep sound when a scan is done.

Parameters:

beepResId - int resource id of the sound file.

setVibrateOn

@Deprecated
public void setVibrateOn(boolean enabled)

Deprecated.

Enables the vibration when a scan is done.

Parameters:

enabled - Sets the state of the vibration on the device.

setFlashEnabled

public void setFlashEnabled(boolean isFlashEnabled)

Enables/Disables the flashlight LED during the scanning process

Parameters:

isFlashEnabled - Sets the state of the flash on the device.

isFlashAvailable

public boolean isFlashAvailable()

Checks if flashlight is available on device. It's better to call this method after init because it needs to access the camera instance. For example, a safe place to call this method is in your implementation of {link OnDecoderLoadedListener.onDecoderLoaded() OnDecoderLoadedListener.onDecoderLoaded }. For a more straightforward but less reliable method, you can use getPackageManager().hasSystemFeature(PackageManager.FEATURE_CAMERA_FLASH) on your activity.

Returns:

true if flashlight is available, false otherwise. If camera is not initialized, returns false.

setDecodingType

public void setDecodingType(long decodingType,
                            long decodingSubType)

Sets the decoder to use. Also set the default region of interest for that code type. Use int as defined in SmartScannerApi2 Bitwise combinations can be used to specify multiple decoding types.
Note that you will only be able to read codes types authorized by the library. This will also set the preffered region of interest.

Parameters:

decodingType - Decoding type

decodingSubType - Decoding subtype

setRegionOfInterest

public void setRegionOfInterest(android.graphics.Rect rect)

Allows to manually set the region of interest.

Parameters:

rect - Rect representation of the region of interest

setTextureView

public void setTextureView(AutoFitTextureView textureView)

Defines the AutoFitTextureView holding the camera preview, inside your layouts.

Parameters:

textureView - AutoFitTextureView view instance

setCanvasDrawer

public void setCanvasDrawer(CanvasDrawerInterface canvasDrawer)

Sets the CanvasDrawer, ie. the view that displays the target. This View must implement CanvasDrawerInterface. It is set in the activity layouts. This canvas view is not mandatory.

Parameters:

canvasDrawer - view that implement CanvasDrawerInterface

getHandler

public ch.icare.smartscan.camera.handlers.SmartScannerHandler getHandler()

Gets the smartscanner app thread Handler that binds with decoding thread

Returns:

SmartScannerHandler

getCameraController

public ch.icare.smartscan.camera.controllers.CameraController getCameraController()

Gets CameraControllerLegacy used to interact with the device

Returns:

CameraController

getVersion

public java.lang.String getVersion()

Displays smartscan java library information.

Returns:

String

init

public void init()

Initializes the SmartScanner library objects and processes. Must be called in onResume() of the main activity, after the call to super(). When init is done, a call to OnDecoderLoadedListener.onDecoderLoaded(Rect) occurs.

release

public void release()

This methods frees memory by releasing objects and processes used by SmartScanner. Must be called in onPause() of the main activity, before the call to super();

handleDecoderResult

public void handleDecoderResult(DecodedResult decodedResult)

A valid result has been found, so execute callback if given. OnDecoderResultFoundListener.onResultFound(DecodedResult) Restarts decoding if continuous decoding is enabled. This method is called internally.

Parameters:

decodedResult - DecodedResult object

restartDecoding

public void restartDecoding()

Restarts the decoding process. Useful if a result has been found and setContinuousDecoding is false.

pauseDecoding

public void pauseDecoding()

Pauses the decoding process. Could be restarted with restartDecoding.

getRegionOfInterest

public android.graphics.Rect getRegionOfInterest()

Get current region of interest. Null if camera is not initialized.

Returns:

Rect object defining the region of interest

isZoomSupported

public boolean isZoomSupported()

Get the information about the availability of the zoom .

Returns:

boolean

setZoomCamera

public void setZoomCamera(int zoom)

Set the zoom of the camera.

Parameters:

zoom - Level of the zoom to set for the camera.

manualFocus

public void manualFocus(float x,
                        float y,
                        android.view.View view,
                        boolean isFocusRectangleVisible)

On double tap we switch to manual focus. We try focusing on the region were the double tap was done.

Parameters:

x - Position on x axis on the screen

y - Position on y axis on the screen

view - View where we will draw the focus rectangle

isFocusRectangleVisible - Option to draw the focus rectangle or not

setAutoFocusEnabled

public void setAutoFocusEnabled(boolean isAutoFocusEnabled)

If not already activated we turn on the auto focus.

Parameters:

isAutoFocusEnabled - Boolean to activate/deactivate the autofocus.

setOrientationDecoding

public void setOrientationDecoding(boolean forceOrientationEnabled,
                                   int scanOrientation)

Set the new orientation decoding on the device. By activating this mode you must manage the ROI manually.

Parameters:

forceOrientationEnabled - true if the decoder should decode in manual orientation

scanOrientation - the orientation for decoding. The options are: LANDSCAPE_MODE, LANDSCAPE_REVERSE_MODE, PORTRAIT_MODE, PORTRAIT_REVERSE_MODE

isForcedOrientationEnabled

public boolean isForcedOrientationEnabled()

Gets the information about the manual orientation (true/false)

Returns:

forceOrientationEnabled true if the decoder decodes in manual orientation

getForcedOrientation

public int getForcedOrientation()

Gets the forced orientation choose by the user.

Returns:

forcedOrientation, the orientation that user has set

enableMultipleResultsConfirmation

public void enableMultipleResultsConfirmation(int numberConfirmations)

While using a behavior that is different from SmartScannerResultBehaviorContinuous. It is possible to ask the decoder to force the decoder to have multiple same results before returning it. This could help with some code_type that don’t have checksums The default value, is 3.

Parameters:

numberConfirmations, - A value between 1 and 10

getNumberResultsConfirmation

public int getNumberResultsConfirmation()

Number of confirmations before validate a result of the decoder.

Returns:

numberConfirmations,

getCameraFPS

public int getCameraFPS()

Number of confirmations before validate a result of the decoder.

Returns:

numberConfirmations,