DocScanningSDK Framework

Name: Pixelnetica™ Document Scanning SDK
Brand: Pixelnetica
SKU: DSSDK
Availability: InStock
Rating: 5 (3 reviews)

Classes

Name	Summary
PxBundledOcrData	Resolves the directory of OCR data that ships bundled inside the SDK, so text-orientation detection works offline on a fresh install with no network download.
PxCatchExceptions	A helper for catching the SDK’s Objective-C exceptions from Swift, where `@catch` is not available.
PxCutout	A document (or other) region detected in a picture, described as an array of points linked in clockwise order.
PxException	An error raised by the SDK to signal misuse or an internal failure.
PxFrameObserver	Detects when a document’s corners are stable across camera frames, so the app knows when it is safe to capture a still.
PxImageWriter	Writes one or more `PxPicture`s to a file in a chosen image or PDF format, optionally with an embedded recognised-text layer.
PxLanguageDownloader	Downloads an OCR language data file and decrypts it into a local directory, reporting progress and completion to a delegate.
PxLicense	Activates an SDK license and exposes the active license’s details.
PxNativeException	An error raised when a native (C++) exception crosses into the SDK’s Objective-C layer.
PxPicture	An image plus its scanning metadata (orientation, flash status, and so on), and the operations to detect a document in it and refine it.
PxRefineFeatures	A builder describing the refinement steps to apply to a `PxPicture`.
PxSDK	SDK-wide information, such as the version of the Document Scanning SDK.
PxTextAttribute	One node in a recognised-text result: a page, block, paragraph, line, word, or symbol, together with the properties available at that level.
PxTextDetector	Detects the orientation of the text in a picture, using the bundled OSD (orientation and script detection) model.
PxTextReader	Recognises (OCRs) the text in a picture, producing a `PxTextResult`.
PxTextResult	The result of a text-recognition scan: the recognised text and the per-element attributes (pages, blocks, paragraphs, lines, words, symbols) behind it.

Protocols

Name	Summary
PxLanguageDownloaderDelegate	Receives progress and completion callbacks from a `PxLanguageDownloader`.
PxTextReaderDisplayCallback	Receives the scanned picture for display while `PxTextReader` works.
PxTextReaderProgressCallback	Receives progress and cancellation callbacks from `PxTextReader`.

Structures

Name	Summary
PxDimension	A single paper measurement: a magnitude together with its unit.
PxMatrixF	A 3x3 2D transformation matrix with single-precision elements, in row-major order.
PxMatrixI	A 3x3 2D transformation matrix with integer elements, in row-major order.
PxPaper	Paper parameters for `PxImageWriter`: page size and margins.
PxPointD	A 2D point with double-precision coordinates.
PxPointF	A 2D point with single-precision coordinates.
PxPointI	A 2D point with integer coordinates.
PxRectD	A 2D rectangle with double-precision corners; also used to carry a line segment.
PxRectF	A 2D rectangle with single-precision corners; also used to carry a line segment.
PxRectI	A 2D rectangle with integer corners; also used to carry a line segment.

Functions

Name	Summary
exifFromUIOrientation	Converts a UIKit image orientation to the equivalent EXIF orientation.
exifToUIOrientation	Converts an EXIF orientation to the equivalent UIKit image orientation.
rotateExifOrientation	Rotates an EXIF orientation by a number of 90-degree steps.
rotateUIOrientation	Rotates a UIKit image orientation by a number of 90-degree steps.

Enumerations

Name	Summary
PxAttrLevel	The granularity of a recognised-text attribute: the level in the page hierarchy (page, block, paragraph, line, word, or symbol) it applies to.
PxColorHint	A hint about an image’s colour content, used to guide processing.
PxColorProfile	The colour profile to binarise a picture into during refinement.
PxCutoutFlag	Bit flags describing the state of the currently detected document cutout, combined into the value returned by `PxFrameObserver`’s `observe:` methods.
PxDimension_Units	The unit a `PxDimension` value is expressed in.
PxFlashStatus	Whether the camera flash fired when an image was captured.
PxImageWriter_CompressionLevel	A predefined compression level for `setCompressionLevel:`. Higher compression means a smaller file at lower quality.
PxImageWriter_Type	The output format a `PxImageWriter` produces.
PxLicenseFeature	A product feature that a license can grant. The `features` mask combines these.
PxLicenseStatus	The result of validating an SDK license key.
PxOrientation	Image orientation, matching the EXIF orientation values.
PxPaper_Orientation	Paper orientation.
PxPaper_Size	A predefined paper size.
PxScanFlags	Flags controlling how recognised text is laid out and marked, combined into the `flags` passed when creating a `PxTextReader`.
PxScanStatus	The outcome of a text-recognition scan.