AnylineDocumentModuleDelegate Protocol Reference

Conforms to NSObject
Declared in AnylineDocumentModuleView.h

– anylineDocumentModuleView:hasResult:fullImage:documentCorners: required method

Called if a full result is found. A full result is considerd to be a successful preview, followed by a successful full scan.

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView hasResult:(UIImage *_Nonnull)transformedImage fullImage:(UIImage *_Nonnull)fullFrame documentCorners:(ALSquare *_Nonnull)corners

Parameters

transformedImage

The transformed image (cropped, deskewed)

fullFrame

The full image (not cropped or deskewed)

corners

The corners of the document in the full frame

Availability

3.6.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:hasResult:fullImage:

Called if a full result is found. A full result is considerd to be a successful preview, followed by a successful full scan. (Deprecated: since 3.6.1)

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView hasResult:(UIImage *_Nonnull)transformedImage fullImage:(UIImage *_Nonnull)fullFrame

Parameters

transformedImage

The transformed image (cropped, deskewed)

fullFrame

The full image (not cropped or deskewed)

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:detectedPictureCorners:inImage:

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

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView detectedPictureCorners:(ALSquare *_Nonnull)corners inImage:(UIImage *_Nonnull)image

Parameters

corners

The corners of the document

image

The full image (not cropped or deskewed)

Availability

3.3.1

3.6.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView: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)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView reportsPreviewResult:(UIImage *_Nonnull)image

Parameters

anylineImage

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

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:reportsPreviewProcessingFailure:

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

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView reportsPreviewProcessingFailure:(ALDocumentError)error

Parameters

error

The error of the preview run.

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:reportsPictureProcessingFailure:

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

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView reportsPictureProcessingFailure:(ALDocumentError)error

Parameters

error

The error of the full frame run

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:documentOutlineDetected:anglesValid:

Return true if your implementation consumed the outline (e.g. drew the outline), or false / do not implement the delegate method, if the DocumentScanView should draw the outline.

- (BOOL)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView documentOutlineDetected:(NSArray *_Nonnull)outline anglesValid:(BOOL)anglesValid

Parameters

outline

An NSArray containing the points of the document outline wrapped in an NSValue

anglesValid

A boolean indicating if interior angles of the rectangle are within a tolerance (so that it is not skew)

Return Value

True if the outline is drawn by the implementation itself or omitted, false if the outline should be drawn by the {@link DocumentScanView}

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleViewTakePictureSuccess:

Called after a picture was successfully taken from the camera.

- (void)anylineDocumentModuleViewTakePictureSuccess:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView

Availability

3.3.1

Discussion

The taken picture will be processed after this method call.

Declared In

AnylineDocumentModuleView.h

– anylineDocumentModuleView:takePictureError:

Called if there was an error capturing the picture from the camera.

- (void)anylineDocumentModuleView:(AnylineDocumentModuleView *_Nonnull)anylineDocumentModuleView takePictureError:(NSError *_Nonnull)error

Parameters

error

The error that was thrown during taking the picture

Availability

3.3.1

Declared In

AnylineDocumentModuleView.h