camera-scan/com.king.camera.scan/BaseCameraScan

BaseCameraScan

open class BaseCameraScan<T> : CameraScan<T>

相机扫描基类；BaseCameraScan 为 CameraScan 的默认实现

快速实现扫描识别主要有以下几种方式：

1、通过继承 BaseCameraScanActivity或者BaseCameraScanFragment或其子类，可快速实现扫描识别。（适用于大多数场景，自定义布局时需覆写getLayoutId方法）

2、在你项目的Activity或者Fragment中实例化一个BaseCameraScan。（适用于想在扫描界面写交互逻辑，又因为项目架构或其它原因，无法直接或间接继承BaseCameraScanActivity或BaseCameraScanFragment时使用）

3、继承CameraScan自己实现一个，可参照默认实现类BaseCameraScan，其他步骤同方式2。（高级用法，谨慎使用）

Author

Constructors

constructor(@NonNull activity: ComponentActivity, @NonNull previewView: PreviewView)

constructor(@NonNull fragment: Fragment, @NonNull previewView: PreviewView)

constructor(@NonNull context: Context, @NonNull lifecycleOwner: LifecycleOwner, @NonNull previewView: PreviewView)

Properties

ASPECT_RATIO_16_9

val ASPECT_RATIO_16_9: Float = 1.7777778f

纵横比：16:9

ASPECT_RATIO_4_3

val ASPECT_RATIO_4_3: Float = 1.3333334f

纵横比：4:3

isNeedTouchZoom

protected open var isNeedTouchZoom: Boolean

是否需要支持触摸缩放

LENS_FACING_BACK

open var LENS_FACING_BACK: Int

A camera on the device facing the opposite direction as the device's screen.

LENS_FACING_FRONT

open var LENS_FACING_FRONT: Int

A camera on the device facing the same direction as the device's screen.

open var SCAN_RESULT: String

扫描返回结果的key；解析方式可参见：parseScanResult

Functions

bindFlashlightView

open fun bindFlashlightView(@Nullable flashlightView: View): CameraScan<T>

绑定手电筒，绑定后可根据光照传感器，动态显示或隐藏手电筒。

open fun enableTorch(torch: Boolean)

设置闪光灯（手电筒）是否开启

open fun getCamera(): Camera

获取 Camera

open fun getExtras(): Bundle

获取扩展参数：当CameraScan的默认实现不满足你的需求时，你可以通过自定义实现一个CameraScan；然后通过此方法获取扩展参数，进行扩展参数的传递；需使用时直接在实现类中获取 mExtras即可。

open fun hasFlashUnit(): Boolean

是否支持闪光灯

open fun isTorchEnabled(): Boolean

闪光灯（手电筒）是否开启

open fun lineZoomIn()

线性放大

open fun lineZoomOut()

线性缩小

open fun lineZoomTo(@FloatRange(from = 0.0, to = 1.0) linearZoom: Float)

线性缩放到指定比例

parseScanResult

open fun parseScanResult(data: Intent): String

解析扫描结果

open fun release()

释放

setAnalyzeImage

open fun setAnalyzeImage(analyze: Boolean): CameraScan<T>

设置是否分析图像，默认为：true；通过此方法可以动态控制是否分析图像；在连续扫描识别时，可能会用到。如：当分析图像成功一次之后，如需继续连扫，可以在结果回调函数中等处理了自己的业务后，继续调用此方法并设置为true，就可以继续扫描分析图像了。

open fun setAnalyzer(analyzer: Analyzer<T>): CameraScan<T>

设置分析器，如果内置的一些分析器不满足您的需求，你也可以自定义Analyzer，自定义时，切记需在startCamera之前调用才有效。

setAutoStopAnalyze

open fun setAutoStopAnalyze(autoStopAnalyze: Boolean): CameraScan<T>

设置是否自动停止分析图像；默认为：true；大多数情况下，单次扫描的场景应用较多；很容易忘记主动调用 setAnalyzeImage 来停止分析。如果设置为：true；即：启用了自动停止分析图像：当分析图像成功一次之后；那么设置的分析图像会自动停止；如果此时需要继续分析图像，可以在结果回调里面调用 setAnalyzeImage 来控制是否继续分析图像。如果设置为：false；即：禁用了自动停止分析图像：当分析图像成功一次之后；不会有任何变化；会继续分析图像。

setBrightLightLux

open fun setBrightLightLux(lightLux: Float): CameraScan<T>

设置光照强度足够明亮的阈值（单位：lux），需要通过bindFlashlightView绑定手电筒才有效

setCameraConfig

open fun setCameraConfig(cameraConfig: CameraConfig): CameraScan<T>

设置相机配置，请在startCamera之前调用

setDarkLightLux

open fun setDarkLightLux(lightLux: Float): CameraScan<T>

设置光照强度足够暗的阈值（单位：lux），需要通过bindFlashlightView绑定手电筒才有效

setOnScanResultCallback

open fun setOnScanResultCallback(callback: CameraScan.OnScanResultCallback<T>): CameraScan<T>

设置扫描结果回调

open fun setPlayBeep(playBeep: Boolean): CameraScan<T>

设置是否播放提示音

open fun setVibrate(vibrate: Boolean): CameraScan<T>

设置是否振动

open fun startCamera()

启动相机预览

open fun stopCamera()

停止相机预览

open fun zoomIn()

放大

open fun zoomOut()

缩小

open fun zoomTo(ratio: Float)

缩放到指定比例