CodeScanner (code-scanner 2.1.0 API)

java.lang.Object
- com.budiyev.android.codescanner.CodeScanner

```
public final class CodeScanner
extends java.lang.Object
```
Code scanner. Supports portrait and landscape screen orientations, back and front facing cameras, auto focus and flash light control, touch focus, viewfinder customization.

See Also:

CodeScannerView, BarcodeFormat

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.List<BarcodeFormat>`	`ALL_FORMATS` All supported barcode formats
`static int`	`CAMERA_BACK` First back-facing camera
`static int`	`CAMERA_FRONT` First front-facing camera
`static java.util.List<BarcodeFormat>`	`ONE_DIMENSIONAL_FORMATS` One dimensional barcode formats
`static java.util.List<BarcodeFormat>`	`TWO_DIMENSIONAL_FORMATS` Two dimensional barcode formats

Constructor Summary

Constructors
Constructor and Description
`CodeScanner(android.content.Context context, CodeScannerView view)` CodeScanner, associated with the first back-facing camera on the device
`CodeScanner(android.content.Context context, CodeScannerView view, int cameraId)` CodeScanner, associated with particular hardware camera

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoFocusMode`	`getAutoFocusMode()` Get current auto focus mode
`int`	`getCamera()` Get current camera id, or `CAMERA_BACK` or `CAMERA_FRONT`
`DecodeCallback`	`getDecodeCallback()` Get current decode callback
`ErrorCallback`	`getErrorCallback()` Get current error callback
`java.util.List<BarcodeFormat>`	`getFormats()` Get current list of formats to decode
`ScanMode`	`getScanMode()` Get current scan mode
`int`	`getZoom()` Get current zoom value
`boolean`	`isAutoFocusEnabled()` Auto focus is currently enabled or not
`boolean`	`isFlashEnabled()` Flash light is currently enabled or not
`boolean`	`isPreviewActive()` Preview is active or not
`boolean`	`isTouchFocusEnabled()` Touch focus is currently enabled or not
`void`	`releaseResources()` Release resources, and stop preview if needed; call this method in `Activity.onPause()`
`void`	`setAutoFocusEnabled(boolean autoFocusEnabled)` Enable or disable auto focus if it's supported, `true` by default
`void`	`setAutoFocusInterval(long autoFocusInterval)` Auto focus interval in milliseconds for `AutoFocusMode.SAFE` mode, 2000 by default
`void`	`setAutoFocusMode(AutoFocusMode autoFocusMode)` Auto focus mode, `AutoFocusMode.SAFE` by default
`void`	`setCamera(int cameraId)` Camera to use
`void`	`setDecodeCallback(DecodeCallback decodeCallback)` Callback of decoding process
`void`	`setErrorCallback(ErrorCallback errorCallback)` Camera initialization error callback.
`void`	`setFlashEnabled(boolean flashEnabled)` Enable or disable flash light if it's supported, `false` by default
`void`	`setFormats(java.util.List<BarcodeFormat> formats)` Formats, decoder to react to (`ALL_FORMATS` by default)
`void`	`setScanMode(ScanMode scanMode)` Scan mode, `ScanMode.SINGLE` by default
`void`	`setTouchFocusEnabled(boolean touchFocusEnabled)` Enable or disable touch focus.
`void`	`setZoom(int zoom)` Set current zoom value (between `0` and `Camera.Parameters.getMaxZoom()`, if larger, max zoom value will be set
`void`	`startPreview()` Start camera preview Requires `Manifest.permission#CAMERA` permission
`void`	`stopPreview()` Stop camera preview

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALL_FORMATS
```
public static final java.util.List<BarcodeFormat> ALL_FORMATS
```
    All supported barcode formats
  - ONE_DIMENSIONAL_FORMATS
```
public static final java.util.List<BarcodeFormat> ONE_DIMENSIONAL_FORMATS
```
    One dimensional barcode formats
  - TWO_DIMENSIONAL_FORMATS
```
public static final java.util.List<BarcodeFormat> TWO_DIMENSIONAL_FORMATS
```
    Two dimensional barcode formats
  - CAMERA_BACK
```
public static final int CAMERA_BACK
```
    First back-facing camera
    
    See Also:
    
    Constant Field Values
  - CAMERA_FRONT
```
public static final int CAMERA_FRONT
```
    First front-facing camera
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CodeScanner
```
public CodeScanner(android.content.Context context,
                   CodeScannerView view)
```
    CodeScanner, associated with the first back-facing camera on the device
    
    Parameters:
    
    context - Context
    
    view - A view to display the preview
    
    See Also:
    
    CodeScannerView
  - CodeScanner
```
public CodeScanner(android.content.Context context,
                   CodeScannerView view,
                   int cameraId)
```
    CodeScanner, associated with particular hardware camera
    
    Parameters:
    
    context - Context
    
    view - A view to display the preview
    
    cameraId - Camera id (between 0 and Camera.getNumberOfCameras() - 1) or CAMERA_BACK or CAMERA_FRONT
    
    See Also:
    
    CodeScannerView
- Method Detail
  - getCamera
```
public int getCamera()
```
    Get current camera id, or CAMERA_BACK or CAMERA_FRONT
    
    See Also:
    
    setCamera(int)
  - setCamera
```
public void setCamera(int cameraId)
```
    Camera to use
    
    Parameters:
    
    cameraId - Camera id (between 0 and Camera.getNumberOfCameras() - 1) or CAMERA_BACK or CAMERA_FRONT
  - getFormats
```
public java.util.List<BarcodeFormat> getFormats()
```
    Get current list of formats to decode
    
    See Also:
    
    setFormats(List)
  - setFormats
```
public void setFormats(java.util.List<BarcodeFormat> formats)
```
    Formats, decoder to react to (ALL_FORMATS by default)
    
    Parameters:
    
    formats - Formats
    
    See Also:
    
    BarcodeFormat, ALL_FORMATS, ONE_DIMENSIONAL_FORMATS, TWO_DIMENSIONAL_FORMATS
  - getDecodeCallback
```
public DecodeCallback getDecodeCallback()
```
    Get current decode callback
    
    See Also:
    
    setDecodeCallback(com.budiyev.android.codescanner.DecodeCallback)
  - setDecodeCallback
```
public void setDecodeCallback(DecodeCallback decodeCallback)
```
    Callback of decoding process
    
    Parameters:
    
    decodeCallback - Callback
    
    See Also:
    
    DecodeCallback
  - getErrorCallback
```
public ErrorCallback getErrorCallback()
```
    Get current error callback
    
    See Also:
    
    setErrorCallback(com.budiyev.android.codescanner.ErrorCallback)
  - setErrorCallback
```
public void setErrorCallback(ErrorCallback errorCallback)
```
    Camera initialization error callback. If not set, an exception will be thrown when error will occur.
    
    Parameters:
    
    errorCallback - Callback
    
    See Also:
    
    ErrorCallback.SUPPRESS, ErrorCallback
  - getScanMode
```
public ScanMode getScanMode()
```
    Get current scan mode
    
    See Also:
    
    setScanMode(com.budiyev.android.codescanner.ScanMode)
  - setScanMode
```
public void setScanMode(ScanMode scanMode)
```
    Scan mode, ScanMode.SINGLE by default
    
    See Also:
    
    ScanMode
  - getZoom
```
public int getZoom()
```
    Get current zoom value
  - setZoom
```
public void setZoom(int zoom)
```
    Set current zoom value (between 0 and Camera.Parameters.getMaxZoom(), if larger, max zoom value will be set
  - isTouchFocusEnabled
```
public boolean isTouchFocusEnabled()
```
    Touch focus is currently enabled or not
  - setTouchFocusEnabled
```
public void setTouchFocusEnabled(boolean touchFocusEnabled)
```
    Enable or disable touch focus. If enabled, touches inside viewfinder frame will cause focusing into specified area, auto focus will be switched off.
  - isAutoFocusEnabled
```
public boolean isAutoFocusEnabled()
```
    Auto focus is currently enabled or not
    
    See Also:
    
    setAutoFocusEnabled(boolean)
  - setAutoFocusEnabled
```
public void setAutoFocusEnabled(boolean autoFocusEnabled)
```
    Enable or disable auto focus if it's supported, true by default
  - getAutoFocusMode
```
public AutoFocusMode getAutoFocusMode()
```
    Get current auto focus mode
    
    See Also:
    
    setAutoFocusMode(com.budiyev.android.codescanner.AutoFocusMode)
  - setAutoFocusMode
```
public void setAutoFocusMode(AutoFocusMode autoFocusMode)
```
    Auto focus mode, AutoFocusMode.SAFE by default
    
    See Also:
    
    AutoFocusMode
  - setAutoFocusInterval
```
public void setAutoFocusInterval(long autoFocusInterval)
```
    Auto focus interval in milliseconds for AutoFocusMode.SAFE mode, 2000 by default
    
    See Also:
    
    setAutoFocusMode(com.budiyev.android.codescanner.AutoFocusMode)
  - isFlashEnabled
```
public boolean isFlashEnabled()
```
    Flash light is currently enabled or not
  - setFlashEnabled
```
public void setFlashEnabled(boolean flashEnabled)
```
    Enable or disable flash light if it's supported, false by default
  - isPreviewActive
```
public boolean isPreviewActive()
```
    Preview is active or not
  - startPreview
```
public void startPreview()
```
    Start camera preview
    Requires Manifest.permission#CAMERA permission
  - stopPreview
```
public void stopPreview()
```
    Stop camera preview
  - releaseResources
```
public void releaseResources()
```
    Release resources, and stop preview if needed; call this method in Activity.onPause()

Class CodeScanner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL_FORMATS

ONE_DIMENSIONAL_FORMATS

TWO_DIMENSIONAL_FORMATS

CAMERA_BACK

CAMERA_FRONT

Constructor Detail

CodeScanner

CodeScanner

Method Detail

getCamera

setCamera

getFormats

setFormats

getDecodeCallback

setDecodeCallback

getErrorCallback

setErrorCallback

getScanMode

setScanMode

getZoom

setZoom

isTouchFocusEnabled

setTouchFocusEnabled

isAutoFocusEnabled

setAutoFocusEnabled

getAutoFocusMode

setAutoFocusMode

setAutoFocusInterval

isFlashEnabled

setFlashEnabled

isPreviewActive

startPreview

stopPreview

releaseResources