CaptureHelper (lib API)

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

所有已实现的接口:: CaptureLifecycle, CaptureManager, CaptureTouchEvent

public class CaptureHelper
extends java.lang.Object
implements CaptureLifecycle, CaptureTouchEvent, CaptureManager

构造器概要

构造器
构造器和说明
`CaptureHelper(Activity activity, SurfaceView surfaceView, ViewfinderView viewfinderView)` 已过时。
`CaptureHelper(Activity activity, SurfaceView surfaceView, ViewfinderView viewfinderView, View ivTorch)`
`CaptureHelper(androidx.fragment.app.Fragment fragment, SurfaceView surfaceView, ViewfinderView viewfinderView)` 已过时。
`CaptureHelper(androidx.fragment.app.Fragment fragment, SurfaceView surfaceView, ViewfinderView viewfinderView, View ivTorch)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CaptureHelper`	`autoRestartPreviewAndDecode(boolean isAutoRestartPreviewAndDecode)` 设置是否自动重启扫码和解码器，当支持连扫时才起作用。
`CaptureHelper`	`brightEnoughLux(float brightEnoughLux)` 设置光线足够明亮时，自动隐藏手电筒按钮
`CaptureHelper`	`characterSet(java.lang.String characterSet)` 设置解码时编码字符集
`CaptureHelper`	`continuousScan(boolean isContinuousScan)` 设置是否连续扫码，如果想支持连续扫码，则将此方法返回`true`并重写`onResult(Result)`
`CaptureHelper`	`decodeFormats(java.util.Collection<com.google.zxing.BarcodeFormat> decodeFormats)` 设置支持的解码一/二维码格式，默认常规的码都支持
`CaptureHelper`	`decodeHint(com.google.zxing.DecodeHintType key, java.lang.Object value)` `DecodeHintType`
`CaptureHelper`	`decodeHints(java.util.Map<com.google.zxing.DecodeHintType,java.lang.Object> decodeHints)` `DecodeHintType`
`CaptureHelper`	`framingRectHorizontalOffset(int framingRectHorizontalOffset)` 设置识别区域水平方向偏移量，非全屏识别时才有效
`CaptureHelper`	`framingRectRatio(float framingRectRatio)` 设置识别区域比例，范围建议在0.625 ~ 1.0之间。
`CaptureHelper`	`framingRectVerticalOffset(int framingRectVerticalOffset)` 设置识别区域垂直方向偏移量，非全屏识别时才有效
`CaptureHelper`	`frontLightMode(FrontLightMode mode)` 设置闪光灯模式。
`CaptureHelper`	`fullScreenScan(boolean fullScreenScan)` 设置是否支持全屏扫码识别
`com.king.zxing.AmbientLightManager`	`getAmbientLightManager()` `AmbientLightManager`
`BeepManager`	`getBeepManager()` `BeepManager`
`CameraManager`	`getCameraManager()` `CameraManager`
`com.king.zxing.InactivityTimer`	`getInactivityTimer()` `InactivityTimer`
`void`	`onCreate()` `Activity#onCreate(Bundle)`
`void`	`onDestroy()` `Activity#onDestroy()`
`void`	`onPause()` `Activity#onPause()`
`void`	`onResult(com.google.zxing.Result result)` ';, mnb 接收扫码结果，想支持连扫时，可将`continuousScan(boolean)`设置为`true` 如果`isContinuousScan`支持连扫，则默认重启扫码和解码器；当连扫逻辑太复杂时，请将`autoRestartPreviewAndDecode(boolean)`设置为`false`，并手动调用`restartPreviewAndDecode()`
`void`	`onResult(com.google.zxing.Result result, Bitmap barcode, float scaleFactor)` 接收扫码结果
`void`	`onResume()` `Activity#onResume()`
`boolean`	`onTouchEvent(MotionEvent event)` 支持缩放时，须在`Activity#onTouchEvent(MotionEvent)`调用此方法
`CaptureHelper`	`playBeep(boolean playBeep)` 设置是否播放音效
`void`	`restartPreviewAndDecode()` 重新启动扫码和解码器
`CaptureHelper`	`returnBitmap(boolean returnBitmap)` 设置返回扫码原图
`CaptureHelper`	`setOnCaptureCallback(OnCaptureCallback callback)` 设置扫码回调
`CaptureHelper`	`supportAutoZoom(boolean supportAutoZoom)` 设置是否支持自动缩放
`CaptureHelper`	`supportLuminanceInvert(boolean supportLuminanceInvert)` 是否支持识别反色码，黑白颜色反转
`CaptureHelper`	`supportVerticalCode(boolean supportVerticalCode)` 设置是否支持扫垂直的条码
`CaptureHelper`	`supportZoom(boolean supportZoom)` 设置是否支持缩放
`void`	`surfaceChanged(SurfaceHolder holder, int format, int width, int height)`
`void`	`surfaceCreated(SurfaceHolder holder)`
`void`	`surfaceDestroyed(SurfaceHolder holder)`
`CaptureHelper`	`tooDarkLux(float tooDarkLux)` 设置光线太暗时，自动显示手电筒按钮
`CaptureHelper`	`vibrate(boolean vibrate)` 设置是否震动

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

- 构造器详细资料
  - CaptureHelper
```
@Deprecated
public CaptureHelper(androidx.fragment.app.Fragment fragment,
                                  SurfaceView surfaceView,
                                  ViewfinderView viewfinderView)
```
    已过时。
    
    use CaptureHelper(Fragment, SurfaceView, ViewfinderView, View)
    
    参数:
    
    fragment -
    
    surfaceView -
    
    viewfinderView -
  - CaptureHelper
```
public CaptureHelper(androidx.fragment.app.Fragment fragment,
                     SurfaceView surfaceView,
                     ViewfinderView viewfinderView,
                     View ivTorch)
```
  - CaptureHelper
```
@Deprecated
public CaptureHelper(Activity activity,
                                  SurfaceView surfaceView,
                                  ViewfinderView viewfinderView)
```
    已过时。
    
    use CaptureHelper(Activity, SurfaceView, ViewfinderView, View)
    
    参数:
    
    activity -
    
    surfaceView -
    
    viewfinderView -
  - CaptureHelper
```
public CaptureHelper(Activity activity,
                     SurfaceView surfaceView,
                     ViewfinderView viewfinderView,
                     View ivTorch)
```
    参数:
    
    activity -
    
    surfaceView -
    
    viewfinderView -
    
    ivTorch -
- 方法详细资料
  - onCreate
```
public void onCreate()
```
    从接口复制的说明: CaptureLifecycle
    
    Activity#onCreate(Bundle)
    
    指定者:
    
    onCreate 在接口中 CaptureLifecycle
  - onResume
```
public void onResume()
```
    从接口复制的说明: CaptureLifecycle
    
    Activity#onResume()
    
    指定者:
    
    onResume 在接口中 CaptureLifecycle
  - onPause
```
public void onPause()
```
    从接口复制的说明: CaptureLifecycle
    
    Activity#onPause()
    
    指定者:
    
    onPause 在接口中 CaptureLifecycle
  - onDestroy
```
public void onDestroy()
```
    从接口复制的说明: CaptureLifecycle
    
    Activity#onDestroy()
    
    指定者:
    
    onDestroy 在接口中 CaptureLifecycle
  - onTouchEvent
```
public boolean onTouchEvent(MotionEvent event)
```
    支持缩放时，须在Activity#onTouchEvent(MotionEvent)调用此方法
    
    指定者:
    
    onTouchEvent 在接口中 CaptureTouchEvent
    
    参数:
    
    event -
  - surfaceCreated
```
public void surfaceCreated(SurfaceHolder holder)
```
  - surfaceChanged
```
public void surfaceChanged(SurfaceHolder holder,
                           int format,
                           int width,
                           int height)
```
  - surfaceDestroyed
```
public void surfaceDestroyed(SurfaceHolder holder)
```
  - restartPreviewAndDecode
```
public void restartPreviewAndDecode()
```
    重新启动扫码和解码器
  - onResult
```
public void onResult(com.google.zxing.Result result,
                     Bitmap barcode,
                     float scaleFactor)
```
    接收扫码结果
    
    参数:
    
    result -
    
    barcode -
    
    scaleFactor -
  - onResult
```
public void onResult(com.google.zxing.Result result)
```
    ';, mnb 接收扫码结果，想支持连扫时，可将continuousScan(boolean)设置为true 如果isContinuousScan支持连扫，则默认重启扫码和解码器；当连扫逻辑太复杂时，请将autoRestartPreviewAndDecode(boolean)设置为false，并手动调用restartPreviewAndDecode()
    
    参数:
    
    result - 扫码结果
  - continuousScan
```
public CaptureHelper continuousScan(boolean isContinuousScan)
```
    设置是否连续扫码，如果想支持连续扫码，则将此方法返回true并重写onResult(Result)
  - autoRestartPreviewAndDecode
```
public CaptureHelper autoRestartPreviewAndDecode(boolean isAutoRestartPreviewAndDecode)
```
    设置是否自动重启扫码和解码器，当支持连扫时才起作用。
    
    返回:
    
    默认返回 true
  - playBeep
```
public CaptureHelper playBeep(boolean playBeep)
```
    设置是否播放音效
    
    返回:
  - vibrate
```
public CaptureHelper vibrate(boolean vibrate)
```
    设置是否震动
    
    返回:
  - supportZoom
```
public CaptureHelper supportZoom(boolean supportZoom)
```
    设置是否支持缩放
    
    参数:
    
    supportZoom -
    
    返回:
  - decodeFormats
```
public CaptureHelper decodeFormats(java.util.Collection<com.google.zxing.BarcodeFormat> decodeFormats)
```
    设置支持的解码一/二维码格式，默认常规的码都支持
    
    参数:
    
    decodeFormats - 可参见DecodeFormatManager
    
    返回:
  - decodeHints
```
public CaptureHelper decodeHints(java.util.Map<com.google.zxing.DecodeHintType,java.lang.Object> decodeHints)
```
    DecodeHintType
    
    参数:
    
    decodeHints -
    
    返回:
  - decodeHint
```
public CaptureHelper decodeHint(com.google.zxing.DecodeHintType key,
                                java.lang.Object value)
```
    DecodeHintType
    
    参数:
    
    key - DecodeHintType
    
    value -
    
    返回:
  - characterSet
```
public CaptureHelper characterSet(java.lang.String characterSet)
```
    设置解码时编码字符集
    
    参数:
    
    characterSet -
    
    返回:
  - supportVerticalCode
```
public CaptureHelper supportVerticalCode(boolean supportVerticalCode)
```
    设置是否支持扫垂直的条码
    
    参数:
    
    supportVerticalCode - 默认为false，想要增强扫条码识别度时可使用，相应的会增加性能消耗。
    
    返回:
  - frontLightMode
```
public CaptureHelper frontLightMode(FrontLightMode mode)
```
    设置闪光灯模式。当设置模式为：FrontLightMode.AUTO时，如果满意默认的照度值范围，可通过tooDarkLux(float)和brightEnoughLux(float)来自定义照度范围，控制自动触发开启和关闭闪光灯。当设置模式非FrontLightMode.AUTO时，传感器不会检测，则不使用手电筒
    
    参数:
    
    mode - 默认:FrontLightMode.AUTO
    
    返回:
  - tooDarkLux
```
public CaptureHelper tooDarkLux(float tooDarkLux)
```
    设置光线太暗时，自动显示手电筒按钮
    
    参数:
    
    tooDarkLux - 默认：AmbientLightManager.TOO_DARK_LUX
    
    返回:
  - brightEnoughLux
```
public CaptureHelper brightEnoughLux(float brightEnoughLux)
```
    设置光线足够明亮时，自动隐藏手电筒按钮
    
    参数:
    
    brightEnoughLux - 默认：AmbientLightManager.BRIGHT_ENOUGH_LUX
    
    返回:
  - returnBitmap
```
public CaptureHelper returnBitmap(boolean returnBitmap)
```
    设置返回扫码原图
    
    参数:
    
    returnBitmap - 默认为false，当返回true表示扫码就结果会返回扫码原图，相应的会增加性能消耗。
    
    返回:
  - supportAutoZoom
```
public CaptureHelper supportAutoZoom(boolean supportAutoZoom)
```
    设置是否支持自动缩放
    
    参数:
    
    supportAutoZoom -
    
    返回:
  - supportLuminanceInvert
```
public CaptureHelper supportLuminanceInvert(boolean supportLuminanceInvert)
```
    是否支持识别反色码，黑白颜色反转
    
    参数:
    
    supportLuminanceInvert - 默认为false，当返回true时表示支持，会增加识别率，但相应的也会增加性能消耗。
    
    返回:
  - fullScreenScan
```
public CaptureHelper fullScreenScan(boolean fullScreenScan)
```
    设置是否支持全屏扫码识别
    
    参数:
    
    fullScreenScan - 默认为false
    
    返回:
  - framingRectRatio
```
public CaptureHelper framingRectRatio(float framingRectRatio)
```
    设置识别区域比例，范围建议在0.625 ~ 1.0之间。非全屏识别时才有效 0.625 即与默认推荐显示区域一致，1.0表示与宽度一致
    
    参数:
    
    framingRectRatio - 默认0.9
    
    返回:
  - framingRectVerticalOffset
```
public CaptureHelper framingRectVerticalOffset(int framingRectVerticalOffset)
```
    设置识别区域垂直方向偏移量，非全屏识别时才有效
    
    参数:
    
    framingRectVerticalOffset - 默认0，表示不偏移
    
    返回:
  - framingRectHorizontalOffset
```
public CaptureHelper framingRectHorizontalOffset(int framingRectHorizontalOffset)
```
    设置识别区域水平方向偏移量，非全屏识别时才有效
    
    参数:
    
    framingRectHorizontalOffset - 默认0，表示不偏移
    
    返回:
  - setOnCaptureCallback
```
public CaptureHelper setOnCaptureCallback(OnCaptureCallback callback)
```
    设置扫码回调
    
    参数:
    
    callback -
    
    返回:
  - getCameraManager
```
public CameraManager getCameraManager()
```
    CameraManager
    
    指定者:
    
    getCameraManager 在接口中 CaptureManager
    
    返回:
    
    cameraManager
  - getBeepManager
```
public BeepManager getBeepManager()
```
    BeepManager
    
    指定者:
    
    getBeepManager 在接口中 CaptureManager
    
    返回:
    
    beepManager
  - getAmbientLightManager
```
public com.king.zxing.AmbientLightManager getAmbientLightManager()
```
    AmbientLightManager
    
    指定者:
    
    getAmbientLightManager 在接口中 CaptureManager
    
    返回:
    
    ambientLightManager
  - getInactivityTimer
```
public com.king.zxing.InactivityTimer getInactivityTimer()
```
    InactivityTimer
    
    指定者:
    
    getInactivityTimer 在接口中 CaptureManager
    
    返回:
    
    inactivityTimer

类 CaptureHelper

构造器概要

方法概要

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

构造器详细资料

CaptureHelper

CaptureHelper

CaptureHelper

CaptureHelper

方法详细资料

onCreate

onResume

onPause

onDestroy

onTouchEvent

surfaceCreated

surfaceChanged

surfaceDestroyed

restartPreviewAndDecode

onResult

onResult

continuousScan

autoRestartPreviewAndDecode

playBeep

vibrate

supportZoom

decodeFormats

decodeHints

decodeHint

characterSet

supportVerticalCode

frontLightMode

tooDarkLux

brightEnoughLux

returnBitmap

supportAutoZoom

supportLuminanceInvert

fullScreenScan

framingRectRatio

framingRectVerticalOffset

framingRectHorizontalOffset

setOnCaptureCallback

getCameraManager

getBeepManager

getAmbientLightManager

getInactivityTimer