DocScanningSDK_UI Framework
Classes
| Name | Summary |
|---|---|
| PxUiCameraScreen | Batteries-included camera screen. Provides the live camera view plus the chrome (close / torch / shutter / border-detector buttons, autoshot progress overlay, detector label) that consumer apps previously had to build themselves. |
| PxUiCameraScreenConfiguration | Per-presentation configuration for PxUiCameraScreen. Adopter constructs a fresh instance per presentation (typically by reading its own persistence — UserDefaults, Core Data, in-memory, whatever). The SDK reads the configuration once at init time and does not observe live changes mid-camera. By design, the SDK does not write app defaults — settings persistence is entirely the adopter’s concern. |
| PxUiLanguagePickerInMemorySelectionStore | In-memory default the SDK ships when the adopter passes no store. State lives only for the lifetime of the instance (does not persist across launches). |
| PxUiLanguagePickerScreen | Ready-to-use OCR language picker screen. Present it to let the user choose the recognition languages. |
| PxUiLanguagePickerScreenConfiguration | Per-presentation configuration for PxUiLanguagePickerScreen. |
| PxUiLanguagePickerSelection | The ordered language selection returned by PxUiLanguagePickerScreen. |
| PxUiOcrEditorScreen | Ready-to-use OCR results editor screen. Review and correct recognised text over the page. |
| PxUiOcrEditorScreenConfiguration | Per-presentation configuration for PxUiOcrEditorScreen. |
| PxUiOcrEditorSession | Observable session that delivers live updates to the OCR editor screen. |
| PxUiPageCropScreen | Ready-to-use crop / page editor screen. Adjust the detected document corners and rotation. |
| PxUiPageCropScreenConfiguration | Per-presentation configuration for PxUiPageCropScreen. |
| PxUiPageCropView | A view that displays a document image and lets the user adjust its page corners. |
| Name | Summary |
|---|---|
| PxUiPageCropView | A view that displays a document image and lets the user adjust its page corners. |
Protocols
| Name | Summary |
|---|---|
| PxUiCameraScreenDelegate | Completion contract for PxUiCameraScreen. UIKit-canonical surface (Obj-C-bridgeable). SwiftUI adopters use PxUiCameraScreenView and switch on PxUiCameraScreenResult instead. |
| PxUiLanguagePickerScreenDelegate | Completion callbacks for PxUiLanguagePickerScreen. |
| PxUiLanguagePickerSelectionStore | Adopter-supplied persistence for the language picker selection. |
| PxUiOcrEditorScreenDelegate | Completion callbacks for PxUiOcrEditorScreen. |
| PxUiPageCropScreenDelegate | Completion callbacks for PxUiPageCropScreen. |
| PxUiPageCropViewDelegate | Receives editing callbacks from a PxUiPageCropView. |
| Name | Summary |
|---|---|
| PxUiPageCropViewDelegate | Receives editing callbacks from a PxUiPageCropView. |
Structures
| Name | Summary |
|---|---|
| PxUiCameraScreenView | Thin SwiftUI adapter wrapping PxUiCameraScreen. Adopters embed inside a .fullScreenCover and switch on PxUiCameraScreenResult. |
| PxUiLanguagePickerScreenView | Thin SwiftUI adapter wrapping PxUiLanguagePickerScreen. Adopters embed inside a .fullScreenCover / .sheet and switch on PxUiLanguagePickerScreenResult. |
| PxUiOcrEditorScreenView | SwiftUI wrapper for PxUiOcrEditorScreen. |
| PxUiPageCropScreenView | SwiftUI wrapper for PxUiPageCropScreen. |
Variables
| Name | Summary |
|---|---|
| PxUiCameraScreenErrorDomain | The NSError domain for failures reported by PxUiCameraScreenDelegate. |
Enumerations
| Name | Summary |
|---|---|
| PxUiCameraScreenError | Error codes carried by NSError.code in PxUiCameraScreenDelegate’s failure callback. The associated NSError.domain is PxUiCameraScreenErrorDomain (string constant declared in this file). |
| PxUiCameraScreenResult | SwiftUI-idiomatic result for PxUiCameraScreenView. Swift-only by design — surfaces only on the adapter’s completion-closure parameter. Does NOT carry @objc; Obj-C adopters route through the delegate protocol on PxUiCameraScreen directly. |
| PxUiLanguagePickerScreenResult | SwiftUI-idiomatic result for PxUiLanguagePickerScreenView. Swift-only by design — surfaces only on the adapter’s completion-closure parameter. Does NOT carry @objc; Obj-C adopters route through PxUiLanguagePickerScreenDelegate on PxUiLanguagePickerScreen directly. |
| PxUiOcrEditorScreenResult | SwiftUI-idiomatic result for PxUiOcrEditorScreenView. Swift-only by design — Obj-C adopters route through PxUiOcrEditorScreenDelegate on the screen directly. |
| PxUiPageCropScreenResult | SwiftUI-idiomatic result for PxUiPageCropScreenView. Swift-only by design — Obj-C adopters route through PxUiPageCropScreenDelegate on the screen directly. The verb is .finished (editor-family, matching the OCR editor); there is no .failure case — the editor cannot fail (it is handed a valid image + cutout and returns an adjusted one; corner degeneracy is refined inside the hosted view). |