DocScanningSDK_UI Framework

Classes

NameSummary
PxUiCameraScreenBatteries-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.
PxUiCameraScreenConfigurationPer-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.
PxUiLanguagePickerInMemorySelectionStoreIn-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).
PxUiLanguagePickerScreenReady-to-use OCR language picker screen. Present it to let the user choose the recognition languages.
PxUiLanguagePickerScreenConfigurationPer-presentation configuration for PxUiLanguagePickerScreen.
PxUiLanguagePickerSelectionThe ordered language selection returned by PxUiLanguagePickerScreen.
PxUiOcrEditorScreenReady-to-use OCR results editor screen. Review and correct recognised text over the page.
PxUiOcrEditorScreenConfigurationPer-presentation configuration for PxUiOcrEditorScreen.
PxUiOcrEditorSessionObservable session that delivers live updates to the OCR editor screen.
PxUiPageCropScreenReady-to-use crop / page editor screen. Adjust the detected document corners and rotation.
PxUiPageCropScreenConfigurationPer-presentation configuration for PxUiPageCropScreen.
PxUiPageCropViewA view that displays a document image and lets the user adjust its page corners.
NameSummary
PxUiPageCropViewA view that displays a document image and lets the user adjust its page corners.

Protocols

NameSummary
PxUiCameraScreenDelegateCompletion contract for PxUiCameraScreen. UIKit-canonical surface (Obj-C-bridgeable). SwiftUI adopters use PxUiCameraScreenView and switch on PxUiCameraScreenResult instead.
PxUiLanguagePickerScreenDelegateCompletion callbacks for PxUiLanguagePickerScreen.
PxUiLanguagePickerSelectionStoreAdopter-supplied persistence for the language picker selection.
PxUiOcrEditorScreenDelegateCompletion callbacks for PxUiOcrEditorScreen.
PxUiPageCropScreenDelegateCompletion callbacks for PxUiPageCropScreen.
PxUiPageCropViewDelegateReceives editing callbacks from a PxUiPageCropView.
NameSummary
PxUiPageCropViewDelegateReceives editing callbacks from a PxUiPageCropView.

Structures

NameSummary
PxUiCameraScreenViewThin SwiftUI adapter wrapping PxUiCameraScreen. Adopters embed inside a .fullScreenCover and switch on PxUiCameraScreenResult.
PxUiLanguagePickerScreenViewThin SwiftUI adapter wrapping PxUiLanguagePickerScreen. Adopters embed inside a .fullScreenCover / .sheet and switch on PxUiLanguagePickerScreenResult.
PxUiOcrEditorScreenViewSwiftUI wrapper for PxUiOcrEditorScreen.
PxUiPageCropScreenViewSwiftUI wrapper for PxUiPageCropScreen.

Variables

NameSummary
PxUiCameraScreenErrorDomainThe NSError domain for failures reported by PxUiCameraScreenDelegate.

Enumerations

NameSummary
PxUiCameraScreenErrorError codes carried by NSError.code in PxUiCameraScreenDelegate’s failure callback. The associated NSError.domain is PxUiCameraScreenErrorDomain (string constant declared in this file).
PxUiCameraScreenResultSwiftUI-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.
PxUiLanguagePickerScreenResultSwiftUI-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.
PxUiOcrEditorScreenResultSwiftUI-idiomatic result for PxUiOcrEditorScreenView. Swift-only by design — Obj-C adopters route through PxUiOcrEditorScreenDelegate on the screen directly.
PxUiPageCropScreenResultSwiftUI-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).
Top