DecodeConfig (zxing-lite 2.1.0 API)

java.lang.Object
- com.king.zxing.DecodeConfig

```
public class DecodeConfig
extends Object
```
解码配置：主要用于在扫码识别时，提供一些配置，便于扩展。通过配置可决定内置分析器的能力，从而间接的控制并简化扫码识别的流程
设置解码 setHints(Map)内置的一些解码可参见如下：

另请参阅:

DecodeFormatManager#DEFAULT_HINTS}, DecodeFormatManager#ALL_HINTS}, DecodeFormatManager#CODE_128_HINTS}, DecodeFormatManager#QR_CODE_HINTS}, DecodeFormatManager#ONE_DIMENSIONAL_HINTS}, DecodeFormatManager#TWO_DIMENSIONAL_HINTS}, DecodeFormatManager#DEFAULT_HINTS} 如果不满足您也可以通过{@link DecodeFormatManager#createDecodeHints(BarcodeFormat...)}自己配置支持的格式识别区域可设置的方式有如下几种： {@link #setFullAreaScan(boolean)} 设置是否支持全区域扫码识别，优先级比识别区域高 {@link #setAnalyzeAreaRect(Rect)} 设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效 {@link #setAreaRectRatio(float)} 设置识别区域比例，默认{@link #DEFAULT_AREA_RECT_RATIO}，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低因为{@link androidx.camera.view.PreviewView}的预览区域是经过裁剪的，所以这里的区域并不是用户所能预览到的区域，而是指Camera预览的真实区域，您还可以通过{@link CameraScan#setCameraConfig(CameraConfig)}去自定义配置{@link CameraConfig}的配置信息控制预览相关配置信息即判定区域分析的优先级顺序为:{@link #setFullAreaScan(boolean)} -> {@link #setAnalyzeAreaRect(Rect)} -> {@link #setAreaRectRatio(float)}

字段概要

字段
限定符和类型字段和说明

static float DEFAULT_AREA_RECT_RATIO

字段
限定符和类型	字段和说明
`static float`	`DEFAULT_AREA_RECT_RATIO`

构造器概要

构造器
构造器和说明

DecodeConfig()

构造器
构造器和说明
`DecodeConfig()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`android.graphics.Rect`	`getAnalyzeAreaRect()` 需要分析识别区域
`int`	`getAreaRectHorizontalOffset()` 识别区域水平方向偏移量，支持负数，大于0时，居中心向右偏移，小于0时，居中心向左偏移
`float`	`getAreaRectRatio()` 识别区域比例，默认`DEFAULT_AREA_RECT_RATIO`，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别
`int`	`getAreaRectVerticalOffset()` 识别区域垂直方向偏移量，支持负数，大于0时，居中心向下偏移，小于0时，居中心向上偏移
`Map<com.google.zxing.DecodeHintType,Object>`	`getHints()`
`boolean`	`isFullAreaScan()` 是否支持全区域扫码识别
`boolean`	`isMultiDecode()` 是否支持使用多解码
`boolean`	`isSupportLuminanceInvert()` 是否支持识别反色码，黑白颜色反转
`boolean`	`isSupportLuminanceInvertMultiDecode()` 是否支持识别反色码（条码黑白颜色反转的码）使用多解码
`boolean`	`isSupportVerticalCode()` 是否支持扫垂直的条码
`boolean`	`isSupportVerticalCodeMultiDecode()` 是否支持垂直的条码，使用多解码
`DecodeConfig`	`setAnalyzeAreaRect(android.graphics.Rect analyzeAreaRect)` 设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效
`DecodeConfig`	`setAreaRectHorizontalOffset(int areaRectHorizontalOffset)` 设置识别区域水平方向偏移量，支持负数，大于0时，居中心向右偏移，小于0时，居中心向左偏移
`DecodeConfig`	`setAreaRectRatio(float areaRectRatio)` 设置识别区域比例，默认`DEFAULT_AREA_RECT_RATIO`，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低
`DecodeConfig`	`setAreaRectVerticalOffset(int areaRectVerticalOffset)` 设置识别区域垂直方向偏移量，支持负数，大于0时，居中心向下偏移，小于0时，居中心向上偏移
`DecodeConfig`	`setFullAreaScan(boolean fullAreaScan)` 设置是否支持全区域扫码识别，优先级比识别区域高
`DecodeConfig`	`setHints(Map<com.google.zxing.DecodeHintType,Object> hints)` 设置解码
`DecodeConfig`	`setMultiDecode(boolean multiDecode)` 是否支持使用多解码
`DecodeConfig`	`setSupportLuminanceInvert(boolean supportLuminanceInvert)` 设置是否支持识别反色码，黑白颜色反转
`DecodeConfig`	`setSupportLuminanceInvertMultiDecode(boolean supportLuminanceInvertMultiDecode)` 设置是否支持识别反色码（条码黑白颜色反转的码）使用多解码
`DecodeConfig`	`setSupportVerticalCode(boolean supportVerticalCode)` 设置是否支持扫垂直的条码
`DecodeConfig`	`setSupportVerticalCodeMultiDecode(boolean supportVerticalCodeMultiDecode)` 设置是否支持垂直的条码，使用多解码
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT_AREA_RECT_RATIO
```
public static final float DEFAULT_AREA_RECT_RATIO
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - DecodeConfig
```
public DecodeConfig()
```
- 方法详细资料
  - getHints
```
public Map<com.google.zxing.DecodeHintType,Object> getHints()
```
  - setHints
```
public DecodeConfig setHints(Map<com.google.zxing.DecodeHintType,Object> hints)
```
    设置解码
    
    参数:
    
    hints - DecodeFormatManager 内置的一些解码可参见如下：
    
    返回:
    
    另请参阅:
    
    DecodeFormatManager#DEFAULT_HINTS}, DecodeFormatManager#ALL_HINTS}, DecodeFormatManager#CODE_128_HINTS}, DecodeFormatManager#QR_CODE_HINTS}, DecodeFormatManager#ONE_DIMENSIONAL_HINTS}, DecodeFormatManager#TWO_DIMENSIONAL_HINTS}, DecodeFormatManager#DEFAULT_HINTS} 如果不满足您也可以通过{@link DecodeFormatManager#createDecodeHints(BarcodeFormat...)}自己配置支持的格式
  - isSupportLuminanceInvert
```
public boolean isSupportLuminanceInvert()
```
    是否支持识别反色码，黑白颜色反转
    
    返回:
  - setSupportLuminanceInvert
```
public DecodeConfig setSupportLuminanceInvert(boolean supportLuminanceInvert)
```
    设置是否支持识别反色码，黑白颜色反转
    
    参数:
    
    supportLuminanceInvert - 默认为false，想要增强支持扫码识别反色码时可使用，相应的也会增加性能消耗。
    
    返回:
  - isSupportVerticalCode
```
public boolean isSupportVerticalCode()
```
    是否支持扫垂直的条码
    
    返回:
  - setSupportVerticalCode
```
public DecodeConfig setSupportVerticalCode(boolean supportVerticalCode)
```
    设置是否支持扫垂直的条码
    
    参数:
    
    supportVerticalCode - 默认为false，想要增强支持扫码识别垂直的条码时可使用，相应的也会增加性能消耗。
    
    返回:
  - isMultiDecode
```
public boolean isMultiDecode()
```
    是否支持使用多解码
    
    返回:
  - setMultiDecode
```
public DecodeConfig setMultiDecode(boolean multiDecode)
```
    是否支持使用多解码
    
    参数:
    
    multiDecode - 默认为true
    
    返回:
    
    另请参阅:
    
    HybridBinarizer} , {@link GlobalHistogramBinarizer}
  - isSupportLuminanceInvertMultiDecode
```
public boolean isSupportLuminanceInvertMultiDecode()
```
    是否支持识别反色码（条码黑白颜色反转的码）使用多解码
    
    返回:
  - setSupportLuminanceInvertMultiDecode
```
public DecodeConfig setSupportLuminanceInvertMultiDecode(boolean supportLuminanceInvertMultiDecode)
```
    设置是否支持识别反色码（条码黑白颜色反转的码）使用多解码
    
    参数:
    
    supportLuminanceInvertMultiDecode - 默认为false，想要增强支持扫码识别反色码时可使用，相应的也会增加性能消耗。
    
    返回:
    
    另请参阅:
    
    HybridBinarizer} , {@link GlobalHistogramBinarizer}
  - isSupportVerticalCodeMultiDecode
```
public boolean isSupportVerticalCodeMultiDecode()
```
    是否支持垂直的条码，使用多解码
    
    返回:
  - setSupportVerticalCodeMultiDecode
```
public DecodeConfig setSupportVerticalCodeMultiDecode(boolean supportVerticalCodeMultiDecode)
```
    设置是否支持垂直的条码，使用多解码
    
    参数:
    
    supportVerticalCodeMultiDecode - 默认为false，想要增强支持扫码识别垂直的条码时可使用，相应的也会增加性能消耗。
    
    返回:
    
    另请参阅:
    
    HybridBinarizer} , {@link GlobalHistogramBinarizer}
  - getAnalyzeAreaRect
```
public android.graphics.Rect getAnalyzeAreaRect()
```
    需要分析识别区域
    
    返回:
  - setAnalyzeAreaRect
```
public DecodeConfig setAnalyzeAreaRect(android.graphics.Rect analyzeAreaRect)
```
    设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效
    
    参数:
    
    analyzeAreaRect - 识别区域可设置的方式有如下几种： setFullAreaScan(boolean) 设置是否支持全区域扫码识别，优先级比识别区域高 setAnalyzeAreaRect(Rect) 设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效 setAreaRectRatio(float) 设置识别区域比例，默认DEFAULT_AREA_RECT_RATIO，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低因为PreviewView的预览区域是经过裁剪的，所以这里的区域并不是用户所能预览到的区域，而是指Camera预览的真实区域，您还可以通过CameraScan.setCameraConfig(CameraConfig)去自定义配置CameraConfig的配置信息控制预览相关配置信息即判定区域分析的优先级顺序为:setFullAreaScan(boolean) -> setAnalyzeAreaRect(Rect) -> setAreaRectRatio(float)
    
    返回:
  - isFullAreaScan
```
public boolean isFullAreaScan()
```
    是否支持全区域扫码识别
    
    返回:
  - setFullAreaScan
```
public DecodeConfig setFullAreaScan(boolean fullAreaScan)
```
    设置是否支持全区域扫码识别，优先级比识别区域高
    
    参数:
    
    fullAreaScan - 默认为true 识别区域可设置的方式有如下几种： setFullAreaScan(boolean) 设置是否支持全区域扫码识别，优先级比识别区域高 setAnalyzeAreaRect(Rect) 设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效 setAreaRectRatio(float) 设置识别区域比例，默认DEFAULT_AREA_RECT_RATIO，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低因为PreviewView的预览区域是经过裁剪的，所以这里的区域并不是用户所能预览到的区域，而是指Camera预览的真实区域，您还可以通过CameraScan.setCameraConfig(CameraConfig)去自定义配置CameraConfig的配置信息控制预览相关配置信息即判定区域分析的优先级顺序为:setFullAreaScan(boolean) -> setAnalyzeAreaRect(Rect) -> setAreaRectRatio(float)
    
    返回:
  - getAreaRectRatio
```
public float getAreaRectRatio()
```
    识别区域比例，默认DEFAULT_AREA_RECT_RATIO，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别
    
    返回:
  - setAreaRectRatio
```
public DecodeConfig setAreaRectRatio(@FloatRange(from=0.5,to=1.0)
                                     float areaRectRatio)
```
    设置识别区域比例，默认DEFAULT_AREA_RECT_RATIO，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低
    
    参数:
    
    areaRectRatio - 识别区域可设置的方式有如下几种： setFullAreaScan(boolean) 设置是否支持全区域扫码识别，优先级比识别区域高 setAnalyzeAreaRect(Rect) 设置需要分析识别区域，优先级比识别区域比例高，当设置了指定的分析区域时，识别区域比例和识别区域偏移量相关参数都将无效 setAreaRectRatio(float) 设置识别区域比例，默认DEFAULT_AREA_RECT_RATIO，设置的比例最终会在预览区域裁剪基于此比例的一个矩形进行扫码识别，优先级最低因为PreviewView的预览区域是经过裁剪的，所以这里的区域并不是用户所能预览到的区域，而是指Camera预览的真实区域，您还可以通过CameraScan.setCameraConfig(CameraConfig)去自定义配置CameraConfig的配置信息控制预览相关配置信息即判定区域分析的优先级顺序为:setFullAreaScan(boolean) -> setAnalyzeAreaRect(Rect) -> setAreaRectRatio(float)
    
    返回:
  - getAreaRectVerticalOffset
```
public int getAreaRectVerticalOffset()
```
    识别区域垂直方向偏移量，支持负数，大于0时，居中心向下偏移，小于0时，居中心向上偏移
    
    返回:
  - setAreaRectVerticalOffset
```
public DecodeConfig setAreaRectVerticalOffset(int areaRectVerticalOffset)
```
    设置识别区域垂直方向偏移量，支持负数，大于0时，居中心向下偏移，小于0时，居中心向上偏移
    
    参数:
    
    areaRectVerticalOffset -
    
    返回:
  - getAreaRectHorizontalOffset
```
public int getAreaRectHorizontalOffset()
```
    识别区域水平方向偏移量，支持负数，大于0时，居中心向右偏移，小于0时，居中心向左偏移
    
    返回:
  - setAreaRectHorizontalOffset
```
public DecodeConfig setAreaRectHorizontalOffset(int areaRectHorizontalOffset)
```
    设置识别区域水平方向偏移量，支持负数，大于0时，居中心向右偏移，小于0时，居中心向左偏移
    
    参数:
    
    areaRectHorizontalOffset -
    
    返回:
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 DecodeConfig

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_AREA_RECT_RATIO

构造器详细资料

DecodeConfig

方法详细资料

getHints

setHints

isSupportLuminanceInvert

setSupportLuminanceInvert

isSupportVerticalCode

setSupportVerticalCode

isMultiDecode

setMultiDecode

isSupportLuminanceInvertMultiDecode

setSupportLuminanceInvertMultiDecode

isSupportVerticalCodeMultiDecode

setSupportVerticalCodeMultiDecode

getAnalyzeAreaRect

setAnalyzeAreaRect

isFullAreaScan

setFullAreaScan

getAreaRectRatio

setAreaRectRatio

getAreaRectVerticalOffset

setAreaRectVerticalOffset

getAreaRectHorizontalOffset

setAreaRectHorizontalOffset

toString