key |
type |
des |
true |
false |
isSingle |
bool |
是否仅识别单一结果,默认 true |
单一结果 |
多个结果 |
isSquare |
bool |
是否展示正方形边框,默认 true |
展示 |
不展示 |
isSingleFocu |
bool |
是否开启单点聚焦,默认 false |
开启 |
关闭 |
isAutoFocus |
bool |
是否开启自动对焦,默认 true |
开启 |
关闭 |
isDoubleTap |
bool |
是否支持双击手势,默认 true |
支持 |
不支持 |
isZoom |
bool |
是否支持缩放手势,默认 true |
支持 |
不支持 |
isHasTorch |
bool |
是否支持光感检测,自动打开闪光灯,默认 true |
支持 |
不支持 |
isPromptBox |
bool |
二维码类型,识别成功时,是否展示框选提示,默认 true |
展示 |
不展示 |
isLimit |
bool |
是否自定义底部 UI,默认 false |
自定义 |
默认 UI |
isUnrestrained |
bool |
是否完全自定义 UI,默认 false |
自定义 |
默认 UI |
isDebugDes |
bool |
是否打印调试信息,默认 true |
打印 |
不打印 |
soundSource |
(String, String)? |
扫描提示音,默认 nil |
有效资源展示 |
默认不展示 |
animationImage |
UIImage? |
扫描动画样式图,默认 nil |
有效资源展示 |
默认不显示 |
brightnessMinValue |
Double |
自动开启闪光灯亮度对比值,默认 true |
小于此值开启 |
默认 -1 |
brightnessMaxValue |
Double |
自动关闭闪光灯亮度对比值,默认 true |
大于此值关闭 |
默认 6 |
preset |
AVCaptureSession.Preset |
扫描质量 |
inputPriority |
默认 |
key |
type |
des |
margin |
Int |
距离左右边界间距(默认 60) |
lineHeight |
Int |
正方形边框粗细(默认 0) |
lineColor |
UIColor |
正方形边框颜色(默认 clear) |
angleColor |
UIColor |
正方形边框四个角颜色(默认 orange) |
angleLength |
Int |
正方形边框四个角长度(默认 30) |
angleHeight |
Int |
正方形边框四个角高度(默认 4) |
angleStyle |
AngleStyle |
正方形边框边角样式(默认重合) |
animationStyle |
AnimationStyle |
扫码动画效果(默认无动画) |
autoFocuStyle |
AutoFocuStyle |
自动聚焦样式(提供默认样式) |
highlightStyle |
HighlightStyle |
二维码扫描成功时,框选提示样式(提供默认样式) |
animationImage |
UIImage |
扫码动画资源图片(可选值,若为空则无动画效果) |
unrecognizedArea |
UIColor |
非识别区域背景色(默认黑色,0.5 透明度) |
key |
type |
des |
value |
String |
扫描结果字符串 |
metadataType |
AVMetadataObject.ObjectType |
扫描结果类型 |
ScanHelperSDK
#import <ScanHelperSDK/ScanHelperSDK-Swift.h>
/// 让控制器持有scanHelper对象,不然会被提前释放
let scanHelper = ScanHelper()
override func viewDidLoad() {
super.viewDidLoad()
scanHelper.start(supView: view) { [weak self] (res) in
guard let self = self else { return }
print(res)
self.navigationController?.popViewController(animated: true)
}
}
/// 让控制器持有scanHelper对象,不然会被提前释放
let scanHelper = ScanHelper()
override func viewDidLoad() {
super.viewDidLoad()
var config = ScanConfig()
config.sound = Bundle.main.path(forResource: "scan_audio", ofType: "wav")
config.animationImage = UIImage(named: "scan_animation")
config.isAutoFocus = false
config.isHasTorch = false
config.isZoom = false
config.isSingle = false
config.scanStyle.lineColor = .purple
config.scanStyle.angleStyle = .OutLine
config.scanStyle.anmiationStyle = .LineCenter
config.scanStyle.autoFocuStyle.lineColor = .blue
// and so on ...
scanHelper.start(supView: view, scanConfig: config) { [weak self] (res) in
guard let self = self else { return }
print(res)
self.navigationController?.popViewController(animated: true)
}
}
class ScanHelperViewController: UIViewController, ScanHelperUIDelegate {
/// 让控制器持有scanHelper对象,不然会被提前释放
let scanHelper = ScanHelper()
override func viewDidLoad() {
super.viewDidLoad()
defaultBackgroundColor()
let config = ScanConfig()
config.isUnrestrained = true
// ⚠️⚠️⚠️scanHandler回调,仅获取单一扫描结果
// 通过代理方法,获取多个扫描结果
scanHelper.delegate = self
scanHelper.start(supView: view, scanConfig: config)
}
// MARK: - 自定义底部视图(获取一个自定义view,从扫描框底部开始计算到父视图底部边缘区域视图)
func scanLimit(_ bottomView: UIView) {
bottomView.backgroundColor = .orange
}
// MARK: - 完全自定义UI视图(获取一个自定义view,frame大小同父视图bounds)
func scanUnrestrained(_ fullView: UIView) {
let v = UIView()
v.frame = CGRect(x: 0, y: 0, width: 200, height: 200)
fullView.addSubview(v)
}
// MARK: - 获取一个亮度值
func scanCaptureOutput(_ brightnessValue: Double) {
print(brightnessValue)
}
// MARK: - 多结果返回集合,ScanResult(⚠️⚠️⚠️仅多个结果才会执行此代理方法)
func scanMetadataOutput(_ values: Array<ScanResult>) {
print(values)
}
// MARK: 反初始化器
deinit {
print("ScanHelperViewController deinit")
}
}
@available(iOS 11.0, *)
/// Start scan
/// - Parameters:
/// - supView: an incoming parent view.
/// - scanConfig: ScanConfig (Default: ScanConfig()).
/// - scanRegion: valid scanning area. The default size is the same as that of the parent view.
/// - scanType: the supported recognizable scanning types are the same as the system API by default.
/// - scanHandler: scan result callback
@objc func start(supView: UIView, scanConfig: ScanConfig, scanRegion: CGRect, scanType: [AVMetadataObject.ObjectType], scanHandler: ((ScanResult) -> Void)?)
@available(iOS 11.0, *)
/// Stop scan
@objc func stop()
@available(iOS 11.0, *)
/// Optional scanLimit
/// - Parameter bottomView: a view from the bottom of the scan box to the bottom area of the parent view
@objc optional func scanLimit(_ bottomView: UIView)
@available(iOS 11.0, *)
/// Optional scanUnrestrained
/// - Parameter fullView: a view that is the same size as the parent view
@objc optional func scanUnrestrained(_ fullView: UIView)
@available(iOS 11.0, *)
/// Optional scanCaptureOutput
/// - Parameter brightnessValue: a brightness value
@objc optional func scanCaptureOutput(_ brightnessValue: Double)
@available(iOS 11.0, *)
/// Optional scanMetadataOutput
/// - Parameter values: a array of scan results
@objc optional func scanMetadataOutput(_ values: Array<ScanResult>)
@available(iOS 11.0, *)
/// Flash switch
/// - Parameter open: a boolean value, the default is false
@objc optional func torchFlash(open: Bool)
@available(iOS 11.0, *)
/// Identify the content information in the picture (for details, please refer to the relevant API of the system cidetector, where the QR code content is identified by default)
/// - Parameters:
/// - image: a valid picture.
/// - ofType: the type is used to specify the detection intent. (Default: CIDetectorTypeQRCode)
/// - context: the context argument specifies the CIContext to be used to operate on the image. may be nil. (Default: nil)
/// - options: the options parameter lets you optinally specify a accuracy / performance tradeoff. can be nil or an empty dictionary. (Default: [[CIDetectorAccuracy: CIDetectorAccuracyHigh]]).
/// - Returns: returns an array of CIFeature instances in the given image.
@objc optional func detector(image: UIImage, ofType: String, context: CIContext?, options: [String : Any]?) -> [CIFeature]?