This pod contains a ready to use view controller for document scanning.
- iOS 10.0 SDK or later
DocumentScanner is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'DocumentScanner', :git => 'https://github.com/adorsys/document-scanner-ios'
The main class in this project is ScannerViewController
. You can access it
with import DocumentScanner
.
class ViewController: UIViewController, {
var scannedImage: UIImage?
override func viewDidLoad() {
super.viewDidLoad()
let scanner = ScannerViewController()
scanner.delegate = self
navigationController?.pushViewController(scanner, animated: true)
}
}
The scanner will not capture images without a delegate.
You should therefore set the delegate
property of the scanner VC.
You will then receive calls when the scanner found an image of suitable quality:
extension ViewController: ScannerViewControllerDelegate {
func didCapture(image: UIImage) {
scannedImage = image
navigationController?.popViewController(animated: true)
}
}
You can customize the scanner's accuracy using the jitter
property. Higher
values will make it easier to capture an image, but it won't be as steady.
The default value here is 100
.
The Scanner resolution can be configured by passing the ScannerViewController
an AVCaptureSession.Preset
during initialization. The default value is
.high
. If the given preset isn't supported by the capture device, it'll fall
back to the default value.
The scanner's UI can be configured using the initializer:
ScannerViewController(config: [.all])
The following options are available:
.targetBraces
: A button to toggle targeting braces.torch
: A button for controlling the torch.manualCapture
: A manual camera shutter
The default value here is .all
You can also configure the previewColor
(color of scan preview rect) and
braceColor
(color of the target finder braces).
The defaults here are UIColor.green
and UIColor.red
, respectively.
The scanner takes quite some time to fire up the AVCaptureSession, etc, which
means initializing a ScannerViewController
is expensive.
Depending on your use case, it probably makes sense to store a strong reference
to the ScannerViewController
in the presenting View Controller (as seen in
the Example project).
DocumentScanner is released under the Apache 2.0 License. Please see the LICENSE file for more information.