ch.icare.smartscan.api2

Class SmartScannerApi2

java.lang.Object

ch.icare.smartscan.SmartScanner

ch.icare.smartscan.api2.SmartScannerApi2

public class SmartScannerApi2
extends SmartScanner

This class is used to interact with the SmartScan library. Changelog v1.1 : - added a new listener callback called when the library and camera have been sucessfully loaded. v2.0 : - switch to Android Studio, lot of optimizations and improvements - code definition constants moved to SmartScannerApi2 class instead of decoding lib v2.0.1 : - remove of deprecated/useless methods (adjustRegionOfInterest) - improved method to determine preferred ROI

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG

Fields inherited from class ch.icare.smartscan.SmartScanner

DEFAULT_MINIMAL_SCORE, ID_AUTO_FOCUS, ID_DEBUG, ID_DECODE, ID_DECODE_FAILED, ID_DECODE_SUCCEEDED, ID_LAUNCH_PRODUCT_QUERY, ID_PAUSE_DECODING, ID_QUIT, ID_RESUME_DECODING, LEVEL_3, LEVEL_FULL, LEVEL_LIMITED, NO_CAMERA_ID

Constructor Summary

Constructors

Constructor and Description
SmartScannerApi2(android.content.Context context) Instantiate the SmartScannerApi2 object.

Method Summary

Modifier and Type	Method and Description
CameraControllerApi2	getCameraController() Gets CameraControllerLegacy used to interact with the device
android.content.Context	getContext() Get the context.
SmartScannerHandlerApi2	getHandler() Gets the smartscanner app thread Handler that binds with decoding thread
java.lang.String	getIcareDecodersSDKDescription() Prints the native SDK build description.
android.graphics.Rect	getRegionOfInterest() Get current region of interest.
java.lang.String	getTypeSmartscan() Return the smartscan library activated.
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 SmartScannerApi2 library objects and processes.
boolean	isFlashAvailable() Checks if flashlight is available on device.
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 SmartScannerApi2.
void	restartDecoding() Restarts the decoding process.
void	setAutoFocusEnabled(boolean isAutoFocusEnabled) If not already activated we turn on the auto focus.
void	setBeepOn(int beepResId) Enables and set the beep sound when a scan is done.
void	setCameraId(int cameraId) Sets the camera to use.
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	setDebugView(android.view.SurfaceView view) Defines the SurfaceView holding the debug preview, inside your layout.
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	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 layout.
void	setVibrateOn(boolean enabled) Enables the vibration when a scan is done.
void	setVisualDebug(boolean visualDebug) Activate the visualdebug.
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

Constructor Detail

SmartScannerApi2

public SmartScannerApi2(android.content.Context context)

Instantiate the SmartScannerApi2 object.

Parameters:

context - Context

Method Detail

getTypeSmartscan

public java.lang.String getTypeSmartscan()

Return the smartscan library activated.

Overrides:

getTypeSmartscan in class SmartScanner

Returns:

String

setOnResultListener

public void setOnResultListener(OnDecoderResultFoundListener listener)

Setting the listeners for the application.

Overrides:

setOnResultListener in class SmartScanner

setOnLoadedListener

public void setOnLoadedListener(OnDecoderLoadedListener listener)

Overrides:

setOnLoadedListener in class SmartScanner

setOnErrorListener

public void setOnErrorListener(OnDecoderErrorListener listener)

Overrides:

setOnErrorListener in class SmartScanner

getContext

public android.content.Context getContext()

Get the context.

Overrides:

getContext in class SmartScanner

Returns:

Context

setVisualDebug

public void setVisualDebug(boolean visualDebug)

Activate the visualdebug.

Overrides:

setVisualDebug in class SmartScanner

Parameters:

visualDebug - Boolean to activate visual debug on the smartscan library.

getIcareDecodersSDKDescription

public java.lang.String getIcareDecodersSDKDescription()

Prints the native SDK build description. A safe place to call this method is in your implementation of {link OnDecoderLoadedListener.onDecoderLoaded() OnDecoderLoadedListener.onDecoderLoaded }.

Overrides:

getIcareDecodersSDKDescription in class SmartScanner

Returns:

String

setContinuousDecoding

public void setContinuousDecoding(boolean isContinuousDecoding)

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

Overrides:

setContinuousDecoding in class SmartScanner

Parameters:

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

setBeepOn

public void setBeepOn(int beepResId)

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

Overrides:

setBeepOn in class SmartScanner

Parameters:

beepResId - int resource id of the sound file.

setVibrateOn

public void setVibrateOn(boolean enabled)

Enables the vibration when a scan is done.

Overrides:

setVibrateOn in class SmartScanner

Parameters:

enabled - Boolean to set the vibration mode on the device (on or off)

setFlashEnabled

public void setFlashEnabled(boolean isFlashEnabled)

Enables/Disables the flashlight LED during the scanning process

Overrides:

setFlashEnabled in class SmartScanner

Parameters:

isFlashEnabled - Boolean to set the flash mode on the device (on or off)

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.

Overrides:

isFlashAvailable in class SmartScanner

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.

Overrides:

setDecodingType in class SmartScanner

Parameters:

decodingType - Decoding type

decodingSubType - Decoding subtype

setRegionOfInterest

public void setRegionOfInterest(android.graphics.Rect rect)

Allows to manually set the region of interest.

Overrides:

setRegionOfInterest in class SmartScanner

Parameters:

rect - Rect representation of the region of interest

setTextureView

public void setTextureView(AutoFitTextureView textureView)

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

Overrides:

setTextureView in class SmartScanner

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 layout.
This canvas view is not mandatory.

Overrides:

setCanvasDrawer in class SmartScanner

Parameters:

canvasDrawer - view that implement CanvasDrawerInterface

setDebugView

public void setDebugView(android.view.SurfaceView view)

Defines the SurfaceView holding the debug preview, inside your layout.

Overrides:

setDebugView in class SmartScanner

Parameters:

view - SurfaceView view instance

getHandler

public SmartScannerHandlerApi2 getHandler()

Gets the smartscanner app thread Handler that binds with decoding thread

Overrides:

getHandler in class SmartScanner

Returns:

SmartScannerHandlerApi2

getCameraController

public CameraControllerApi2 getCameraController()

Gets CameraControllerLegacy used to interact with the device

Overrides:

getCameraController in class SmartScanner

Returns:

CameraControllerApi2

getVersion

public java.lang.String getVersion()

Displays smartscan java library information.

Overrides:

getVersion in class SmartScanner

Returns:

String

setCameraId

public void setCameraId(int cameraId)

Sets the camera to use. If not set, will use the first back facing camera. On old devices (API 8, 2.2), this setting won't do anything.

Parameters:

cameraId - int camera id. On most devices 0 is the first back facing camera.

init

public void init()

Initializes the SmartScannerApi2 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), OnDecoderLoadedListener.onDecoderLoaded occurs.

Overrides:

init in class SmartScanner

release

public void release()

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

Overrides:

release in class SmartScanner

handleDecoderResult

public void handleDecoderResult(DecodedResult decodedResult)

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

Overrides:

handleDecoderResult in class SmartScanner

Parameters:

decodedResult - DecodedResult object

restartDecoding

public void restartDecoding()

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

Overrides:

restartDecoding in class SmartScanner

pauseDecoding

public void pauseDecoding()

Pauses the decoding process. Could be restarted with restartDecoding.

Overrides:

pauseDecoding in class SmartScanner

getRegionOfInterest

public android.graphics.Rect getRegionOfInterest()

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

Overrides:

getRegionOfInterest in class SmartScanner

Returns:

Rect object defining the region of interest

isZoomSupported

public boolean isZoomSupported()

Get the information about the availability of the zoom .

Overrides:

isZoomSupported in class SmartScanner

Returns:

boolean

setZoomCamera

public void setZoomCamera(int zoom)

Set the zoom of the camera.

Overrides:

setZoomCamera in class SmartScanner

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.

Overrides:

manualFocus in class SmartScanner

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.

Overrides:

setAutoFocusEnabled in class SmartScanner

Parameters:

isAutoFocusEnabled - Boolean to activate/deactivate the autofocus.