Atalasoft MobileImage API Reference
Instance Methods | List of all members
<kfxKUIImageCaptureControlDelegate> Protocol Reference

This protocol must be implemented by classes whose objects are used as kfxKUIImageCaptureControl delegates. More...

#import <kfxKUIImageCaptureControl.h>

Inheritance diagram for <kfxKUIImageCaptureControlDelegate>:
kfxKUICaptureExperience kfxKUIDocumentBaseCaptureExperience kfxKUICheckCaptureExperience kfxKUIDocumentCaptureExperience

Instance Methods

(void) - imageCaptureControl:stabilityDelay:
 A message that indicates the current stability of the device. More...
 
(void) - imageCaptureControl:imageCaptured:
 A message that indicates that an image was captured. More...
 
(void) - imageCaptureControl:pitchChangedTo:rollChangedTo:
 A message that indicates the current pitch and roll. More...
 
(void) - imageCaptureControl:focusStateChanged:
 A message that indicates the camera has begun or finished focusing. More...
 
(void) - imageCaptureControl:pageDetected:pageCoordinates:
 A message that indicates page detection has located a document in the camera preview. More...
 
(void) - imageCaptureControl:videoFrameAvailable:
 A message that is dispatched whenever a new video frame is available from the camera. More...
 
(void) - imageCaptureControl:videoSampleAvailable:
 A message that is dispatched whenever a new video sample is available from the camera. More...
 
(void) - imageCaptureControl:pageDetected:
 A message that indicates page detection has located a document in the camera preview. More...
 

Detailed Description

This protocol must be implemented by classes whose objects are used as kfxKUIImageCaptureControl delegates.

This defines protocol messages that will be sent to kfxKUIImageCaptureControl delegate objects.

Method Documentation

- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
focusStateChanged: (BOOL)  isFocused 
optional

A message that indicates the camera has begun or finished focusing.

A message that indicates the camera has begun or finished focusing, where the boolean value NO indicates the camera is focusing, or YES, that focusing is complete

- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
imageCaptured: (kfxKEDImage *)  image 
optional

A message that indicates that an image was captured.

A message that indicates that an image was captured. This will only be sent after the control receives a takePicture message. The control will wait until the desired stability, levelness, and camera adjustments are met and then capture an image and send it with this message.

- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
pageDetected: (kfxKUIPageDetectionEvent *)  event 
optional

A message that indicates page detection has located a document in the camera preview.

When page detection locates a document, it dispatches this message with the kfxKUIPageDetectionEvent. The event includes the preview image that was processed by page detection, and the bounding coordinates of the detected page.

The handler is being invoked only when ImageCaptureControl is using in conjuction with CaptureExperience.

While the handler is being run, the rest of the pipeline will block. Any new video frames that would have been available from the camera during this time will be discarded. When the handler finishes, the rest of the capture logic will be processed normally.

The handler is being invoked from internal SDK thread, and its highly recommended to make implementation lightweight with no blocking.

Parameters
imageCaptureControlThe capture control dispatching the message.
eventThe event with the preview image and bounding coordinates of the detected page.
See also
kfxKUIPageDetectionEvent
- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
pageDetected: (UIImage *)  previewImage
pageCoordinates: (kfxKEDBoundingTetragon *)  DEPRECATED_ATTRIBUTE 
optional

A message that indicates page detection has located a document in the camera preview.

When page detection locates a document, it dispatches this message with the preview image that it searched and the coordinates of the located feature.

Parameters
imageCaptureControlThe capture control dispatching the message.
previewImageThe camera preview image data that was used by page detection.
Thebounding coordinates of the located document.
See also
pageDetectMode for the property that controls page detection.
- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
pitchChangedTo: (int)  pitch
rollChangedTo: (int)  roll 
optional

A message that indicates the current pitch and roll.

A message that indicates the current angles of pitch and roll of the device. Both pitch and roll are angles in degrees.

- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
stabilityDelay: (int)  stabilityDelay 
optional

A message that indicates the current stability of the device.

A message that indicates the current stability, which is a number from 0-100, where 100 means that the device is completely stable and 0 is the maximum instability.

- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
videoFrameAvailable: (UIImage *)  DEPRECATED_ATTRIBUTE 
optional

A message that is dispatched whenever a new video frame is available from the camera.

As the control processes video frames from the camera preview, the handler for this message will be called before any other processing takes place, except for turning the raw camera data into a correctly oriented UIImage.

While the handler is being run, the rest of the pipeline will block. Any new video frames that would have been available from the camera during this time will be discarded. When the handler finishes, the rest of the capture logic will be processed normally. If built-in features such as page detection or stability would create redundant work or undesirable behavior, then they should be disabled.

Subscribing on this causes performance overhead due internal video sample buffer convertion into UIImage.

Parameters
imageCaptureControlThe capture control dispatching the message.
videoFrameThe camera preview image.
See also
imageCaptureControl:videoSampleAvailable
- (void) imageCaptureControl: (kfxKUIImageCaptureControl *)  imageCaptureControl
videoSampleAvailable: (CMSampleBufferRef)  videoSample 
optional

A message that is dispatched whenever a new video sample is available from the camera.

As the control processes video frames from the camera preview, the handler for this message will be called before any other processing takes place.

While the handler is being run, the rest of the pipeline will block. Any new video frames that would have been available from the camera during this time will be discarded. When the handler finishes, the rest of the capture logic will be processed normally. If built-in features such as page detection or stability would create redundant work or undesirable behavior, then they should be disabled.

The handler is being invoked from internal SDK thread, and its highly recommended to make implementation lightweight with no blocking and avoiding sample buffer retain.

This is preferred to use instead of imageCaptureControl:videoFrameAvailable: with no performance overhead.

Parameters
imageCaptureControlThe capture control dispatching the message.
videoSampleThe camera preview sample buffer in kCVPixelFormatType_32BGRA format.

The documentation for this protocol was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.