FUITextRecognitionView

open class FUITextRecognitionView : UIView

The FUITextRecognitionView can be used to perform text recognition using device camera. Video captured from device camera would be shown in entire bounds. Use captureMaskPath to define the sub-frame of the view, in which the text would be recognized. If captureMaskPath is set to nil, the text in full screen will be reconized. Rest of the frame would be dimmed by overlayView. This default behavior can be changed by setting view and layer properties of overlayView. All the observations, that is, recognized text blocks and corresponding bounding boxes, would be returned back to observationHandler. To provide hint to user to what texts are recognized, use showTexts to show the observations on top of captured video.

Call startSession to start capturing the video. This is normally called when view appears. Since text recognition model are memory and cpu intensive, it won’t be run until user has stabilized the device camera. After that observationHandler would be called for every video frame with observations. observationHandler can be used to perform any validations and filtering on the observations. Validate if it is a credit card number if observations have 16 numeric digits in total and discard any other observations, for example. Once the filtered observations meet the desired criteria, call stopSession to stop capturing the video. Make sure to call stopSession in case view disappears.

When initializing FUITextRecognitionView, you can specify the style you want. Default style is singleField style. singleField provides a default-sized capturing box for capturing infomation of a single field (E.g. phone number or email address). The other one is multi-field style which provides a large-sized capturing box for capturing information of mutiple fields (E.g. business card).

Example Initialization and Configuration

let recognitionView = FUITextRecognitionView()

recognitionView.observationHandler = { observations

   let filteredObservations = <#filter out unwanted text#>

   //show text over captured video to provide feedback to user to what is scanned
   recognitionView.showTexts(for: filteredObservations)

   let areObservationsValid = <#filteredObservations meets desired criteria#>

   if areObservationsValid {
       DispatchQueue.main.async {
           //place captured text in text field
           textField.text = filteredObservations.map { $0.value }.joined(separator:" ")
       }
       //on return true, session would be automatically stoped and observationHandler would no longer be called
       return true
   }
   return false
}

//start session to capture frames from back camera
recognitionView.startSession()