QKMRZScanner

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #go #docker #nodejs #windows #cli #awesome-list #pytorch #ios #open-source

(★ 152)

Scan MRZ (Machine Readable Zone) from identity documents (passport, id, visa) using iPhone/iPad (iOS)

File Explorer

Download Latest Version (.zip)

- - project.pbxproj
- - LICENSE
  - README.md
- - LICENSE.md
  - Readme.md
- Manifest.lock
- - AVCaptureVideoOrientation.swift
  - CIContext.swift
  - CIImage.swift
  - CVImageBuffer.swift
- - Info.plist
  - QKMRZScanner.h
- LuminanceThresholdFilter.swift
- QKCutoutView.swift
- QKMRZScannerView.swift
- QKMRZScanResult.swift
- - contents.xcworkspacedata
- project.pbxproj
- - IDEWorkspaceChecks.plist
- contents.xcworkspacedata
- scanning.gif
- storyboard.png
.gitignore
LICENSE
Podfile
Podfile.lock
QKMRZScanner.podspec
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![SwiftPackageSupport](https://img.shields.io/badge/Swift_Package_Index-red?logo=swift&logoColor=white)](https://swiftpackageindex.com/Mattijah/QKMRZScanner)
[![Swift 5](https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat)](https://developer.apple.com/swift/)
[![Git](https://img.shields.io/badge/GitHub-Mattijah-blue.svg?style=flat)](https://github.com/Mattijah)

# QKMRZScanner

Scans MRZ (Machine Readable Zone) from identity documents.

![scanning_preview](https://raw.githubusercontent.com/Mattijah/QKMRZScanner/master/ReadmeAssets/scanning.gif)

## Installation

##### Swift Package Manager
For better M1 & SPM support please see [master-spm](https://github.com/Mattijah/QKMRZScanner/tree/master-spm#installation).

##### CocoaPods
QKMRZScanner is available through CocoaPods. To install it, simply add the following line to your Podfile:

```ruby
pod 'QKMRZScanner'
```

Please note: **Xcode 12** and **CocoaPods** >= 1.10.0.rc.1 is recommended. More info [here](https://github.com/SwiftyTesseract/SwiftyTesseract/tree/support/3.x.x#note-on-cocoapods).

## Setup

Assign `QKMRZScannerView` to the component responsible for displaying the camera view.

![storyboard_setup](https://raw.githubusercontent.com/Mattijah/QKMRZScanner/master/ReadmeAssets/storyboard.png)

Subsequently connect this component to your UIViewController.

```swift
@IBOutlet weak var mrzScannerView: QKMRZScannerView!
```

#### Start scanning
```swift
override func viewWillAppear(_ animated: Bool) {
    super.viewWillAppear(animated)
    mrzScannerView.startScanning()
}
```

#### Stop scanning
```swift
override func viewWillDisappear(_ animated: Bool) {
    super.viewWillDisappear(animated)
    mrzScannerView.stopScanning()
}
```

#### Scanning Result

In order to retrieve the scanning results you need to implement `QKMRZScannerViewDelegate`.

```swift
class MRZScannerViewController: UIViewController, QKMRZScannerViewDelegate {
    @IBOutlet weak var mrzScannerView: QKMRZScannerView!

override func viewDidLoad() {
        super.viewDidLoad()
        mrzScannerView.delegate = self
    }

func mrzScannerView(_ mrzScannerView: QKMRZScannerView, didFind scanResult: QKMRZScanResult) {
        print(scanResult)
    }
}
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

QKMRZScanner

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

QKMRZScanner

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README