ALDocumentInfoDelegate Protocol Reference

Conforms to NSObject
Declared in ALDocumentScanPlugin.h

– anylineDocumentScanPlugin:detectedPictureCorners:inImage:

If triggerPictureCornerDetectionAndReturnError: is used this callback provides the image and the document corners successful full scan.

- (void)anylineDocumentScanPlugin:(ALDocumentScanPlugin *_Nonnull)anylineDocumentScanPlugin detectedPictureCorners:(ALSquare *_Nonnull)corners inImage:(UIImage *_Nonnull)image

Parameters

corners

The corners of the document

image

The full image (not cropped or deskewed)

Declared In

ALDocumentScanPlugin.h

– anylineDocumentScanPlugin:reportsPreviewResult:

Called if the preview scan detected a sharp and correctly placed document. After this callback, a full frame scan of the document starts automatically.

- (void)anylineDocumentScanPlugin:(ALDocumentScanPlugin *_Nonnull)anylineDocumentScanPlugin reportsPreviewResult:(UIImage *_Nonnull)image

Parameters

anylineImage

The image of the successful preview. There is no transformation performed on this image.

Declared In

ALDocumentScanPlugin.h

– anylineDocumentScanPlugin:reportsPreviewProcessingFailure:

Called if the preview run failed on an image. The error is provided, and the next run is started automatically.

- (void)anylineDocumentScanPlugin:(ALDocumentScanPlugin *_Nonnull)anylineDocumentScanPlugin reportsPreviewProcessingFailure:(ALDocumentError)error

Parameters

error

The error of the preview run.

Declared In

ALDocumentScanPlugin.h

– anylineDocumentScanPlugin:reportsPictureProcessingFailure:

Called if the run on the full frame was unsuccessful. The scanning process automatically starts again with a preview scan.

- (void)anylineDocumentScanPlugin:(ALDocumentScanPlugin *_Nonnull)anylineDocumentScanPlugin reportsPictureProcessingFailure:(ALDocumentError)error

Parameters

error

The error of the full frame run

Declared In

ALDocumentScanPlugin.h

– anylineDocumentScanPlugin:reportInfo:

Called with interesting values, that arise during processing.

Some possibly reported values:

  • $brightness - the brightness of the center region of the cutout as a float value
  • $confidence - the confidence, an Integer value between 0 and 100
  • $thresholdedImage - the current image transformed into black and white (the base image used for OCR)

- (void)anylineDocumentScanPlugin:(ALDocumentScanPlugin *_Nonnull)anylineDocumentScanPlugin reportInfo:(ALScanInfo *_Nonnull)scanInfo

Parameters

scanInfo

The reported ScanInfo

anylineScanPlugin

The ALDocumentScanPlugin

Declared In

ALDocumentScanPlugin.h