Document Scanner SDKCore engine (DocScanningSDK) Pixelnetica™ Document Scanning SDK for Apple iOS
This is the map of the DocScanningSDK core engine API. The full generated reference (every class, method, and type) is published alongside these pages; this page orients you in it. The core API is Objective-C and is callable from both Objective-C and Swift.
Setup & licensing
| Type | Purpose |
|---|---|
PxSDK | Global SDK info — version, build. |
PxLicense | Apply and inspect the license. See Licensing. |
PxException / PxCatchExceptions | Convert engine exceptions into NSError (PxCatchExceptions.do { … }). |
Image & processing
| Type | Purpose |
|---|---|
PxPicture | The image and its processing — create from camera/import, then detect, refine, and extractImage. |
PxRefineFeatures | A builder describing the processing to apply (rectify, perspective, colour profile); pass it to PxPicture’s refine. |
PxCutout | The detected document quad (four corners). |
PxFrameObserver | Live edge detection over camera frames (for custom camera UIs). |
PxColorProfile, PxColorHint, PxOrientation | Processing options and image orientation. |
| Value types | Basic value types — PxPointF/I/D, PxRectF/I/D, PxMatrixF/I. |
OCR
| Type | Purpose |
|---|---|
PxTextReader / PxTextDetector | Run text recognition over a PxPicture. |
PxTextResult | The recognised text and its PxTextAttribute elements (blocks, lines, words, symbols). |
PxLanguageDownloader | Download OCR language packs on demand. |
PxBundledOcrData | The bundled offline orientation/script-detection data. |
Export
| Type | Purpose |
|---|---|
PxImageWriter | Write PDF / TIFF / JPEG / PNG, including searchable PDFs. See Export. |
PxPaper | Paper size and dimensions for PDF output. |
See also
- The ready-to-use UI layer: API reference — ready-to-use UI.
- Task guides under Core concepts walk these types stage by stage.