NEW: Learn to build amazing SwiftUI apps for macOS with my new book! >>

How to detect documents using VNDocumentCameraViewController

Swift version: 5.6

Paul Hudson    @twostraws   

iOS 13.0 introduced a new micro-framework called VisionKit, which is specifically designed to make it possible to scan documents like Notes does.

You can then Vision OCR to scan the text if you want, but by default VNDocumentCameraViewController just gives you images of each page.

To get started:

  1. Import VisionKit.
  2. Make some type (such as your view controller) conform to the VNDocumentCameraViewControllerDelegate protocol so you can handle delegate callbacks.
  3. Create and present an instance of VNDocumentCameraViewController, setting its delegate property to whatever should be notified when a scan completes.
  4. Present the document scanner as normal, then wait for feedback.

So, something like this:

let vc = VNDocumentCameraViewController()
vc.delegate = self
present(vc, animated: true)

Once the scan completes your delegate will get called with the document, like this:

func documentCameraViewController(_ controller: VNDocumentCameraViewController, didFinishWith scan: VNDocumentCameraScan) {
    print("Found \(scan.pageCount)")

    for i in 0 ..< scan.pageCount {
        let img = scan.imageOfPage(at: i)
        // ... your code here

The result of imageOfPage(at:) is a UIImage, so you’ll need to replace “your code here” with whatever you want to do with your images.

Hacking with Swift is sponsored by Fernando Olivares

SPONSORED Fernando's book will guide you in fixing bugs in three real, open-source, downloadable apps from the App Store. Learn applied programming fundamentals by refactoring real code from published apps. Hacking with Swift readers get a $10 discount!

Read the book

Sponsor Hacking with Swift and reach the world's largest Swift community!

Available from iOS 13.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

Buy Pro Swift Buy Swift Design Patterns Buy Testing Swift Buy Hacking with iOS Buy Swift Coding Challenges Buy Swift on Sundays Volume One Buy Server-Side Swift (Vapor Edition) Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Advanced iOS Volume Three Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with macOS Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Server-Side Swift (Kitura Edition) Buy Beyond Code

Was this page useful? Let us know!

Average rating: 4.0/5

Unknown user

You are not logged in

Log in or create account

Link copied to your pasteboard.