Atalasoft MobileImage API Reference
Instance Methods | Properties | List of all members
kfxKUICheckCaptureExperience Class Reference

This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the use. More...

#import <kfxKUICheckCaptureExperience.h>

Inheritance diagram for kfxKUICheckCaptureExperience:
kfxKUIDocumentBaseCaptureExperience kfxKUICaptureExperience <kfxKUIImageCaptureControlDelegate>

Instance Methods

(instancetype) - initWithCaptureControl:criteria:
 Initializes a new object using the specified parameters. More...
 
(void) - setCheckCriteria:
 A setter for check capture criteria. More...
 
- Instance Methods inherited from kfxKUIDocumentBaseCaptureExperience
(void) - takePicture
 Begins the image capture process. More...
 
(void) - takePictureContinually
 Starts the continuous capture of images. More...
 
(void) - stopCapture
 Stops taking a picture. More...
 
(instancetype) - initWithCaptureControl:criteria:
 Initialized for the object using the specified parameters. More...
 
- Instance Methods inherited from kfxKUICaptureExperience
(void) - stateChanged:
 
- Instance Methods inherited from <kfxKUIImageCaptureControlDelegate>
(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...
 

Properties

kfxKUICaptureMessageuserInstruction
 An instructional text box that is displayed to the user while trying to capture a check. More...
 
kfxKUICaptureMessagecenterMessage
 An instructional balloon that is displayed to the user for center the check. More...
 
UIImage * tutorialSampleImage
 A tutorial image showing how to capture a check. More...
 
- Properties inherited from kfxKUIDocumentBaseCaptureExperience
kfxKUICaptureMessageuserInstruction
 An instructional text box that is displayed to the user while trying to capture a document. More...
 
kfxKUICaptureMessageholdSteadyMessage
 An instructional balloon that is displayed to the user to hold the device steady. More...
 
kfxKUICaptureMessagecenterMessage
 An instructional balloon that is displayed to the user for center the document. More...
 
kfxKUICaptureMessagecapturedMessage
 An instructional balloon that is displayed to the user for when document is successfully captured. More...
 
kfxKUICaptureMessagezoomOutMessage
 An instructional balloon that is displayed to the user for zoom out action. More...
 
kfxKUICaptureMessagezoomInMessage
 An instructional balloon that is displayed to the user for zoom in action. More...
 
kfxKUICaptureMessagetutorialDismissMessage
 An instructional message that is displayed to the user for closing the tutorial. More...
 
kfxKUICaptureMessagerotateMessage
 An instructional balloon that is displayed to the user for rotate action. More...
 
kfxKUICaptureMessageholdParallelMessage
 An instructional balloon that is displayed to the user for holding the device more flat. More...
 
BOOL tutorialEnabled
 Whether to show an animated tutorial about how to capture a document. More...
 
UIImage * tutorialSampleImage
 A tutorial image showing how to capture a document. More...
 
UIColor * outerViewfinderColor
 Outer viewfinder color. More...
 
UIColor * guidanceFrameColor
 Guidance frame color. More...
 
UIColor * steadyGuidanceFrameColor
 Steady guidance frame color. More...
 
BOOL vibrationEnabled
 Whether to start vibration when an image is captured. More...
 

Detailed Description

This class renders a visual experience on top of the capture control and returns an image depending on the criteria set by the use.

This class is responsible for rendering the enhanced visual experience on top of the capture control, and provides feedback to guide the user to take a clear, legible and optimally zoomed in photo of a check.

This class only supports Landscape Orientation for Check Capture. Users should lock the orientation of the view finder while using this class.

Method Documentation

- (instancetype) initWithCaptureControl: (kfxKUIImageCaptureControl *)  captureControl
criteria: (kfxKUICheckCaptureExperienceCriteriaHolder *)  criteria 

Initializes a new object using the specified parameters.

Initializes a check capture experience and binds it to the given image capture control. The experience class overrides the capture control delegate to provide additional behavior and guidance useful for capturing checks. It also forwards delegate invocations to the original delegate set on the capture control, thus acting as a proxy.

If you are interested in handling any of the delegate methods on the capture control, it is important that you set your delegate before initializing the capture experience. Setting a new delegate after initializing the capture experience will break the association with the capture control, and allow the capture experience to be shut down and deallocated if no other references to the object remain. This is the proper protocol for cleaning up a capture experience you are no longer interested in.

The check capture experience will add several overlays and subviews on top of the associated image capture control for visual guidance and feedback. It will also manage some of the capture control's native properties, which could interfere with any properties you directly modify on the control.

For best results, your image capture control should be configured to use video capture mode. This will normally result in a larger preview resolution being used. Small preview resolutions will make check detection difficult and negatively impact user guidance. In particular, the capture experience will rarely be able to deliver zoom-related guidance with low resolution preview images.

Parameters
captureControlAn instance of a kfxKUIImageCaptureControl object.
criteriaA collection of constraints and attributes that control the behavior of the capture experience. Pass nil for the default experience.
- (void) setCheckCriteria: (kfxKUICheckCaptureExperienceCriteriaHolder *)  checkCriteria

A setter for check capture criteria.

Calling this method will cause all of the capture related parameters to be configured.

Parameters
checkCriteriaThe check capture criteria object.

Property Documentation

- (kfxKUICaptureMessage*) centerMessage
readwritenonatomicstrong

An instructional balloon that is displayed to the user for center the check.

This instruction will be displayed when check is not enough centered in the target frame for capture.

Default configuration:

  • message: "Center Check"
  • text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
  • text color: white
  • backGroundColor: black with 0.7 alpha component
  • position: centered inside viewfinder
  • size: 40% of imageCaptureControl size
  • orientation: landscape right
  • messageIcons: none Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
  • backGround: none
See also
kfxUICaptureMessage
- (UIImage*) tutorialSampleImage
readwritenonatomicstrong

A tutorial image showing how to capture a check.

A UIImage that will be displayed over the check frame area when the tutorialEnabled field is set to YES. The set image will be stretched to fill the entire check frame area.

By default initialized with sample_check.png for front side and sample_check_back.png for back side from uiimages.bundle.

- (kfxKUICaptureMessage*) userInstruction
readwritenonatomicstrong

An instructional text box that is displayed to the user while trying to capture a check.

This instruction will be displayed during periods where other guidance is not available to correct a user. This may happen in particular when the user is holding a device far away from a check, preventing automated detection from recognizing the check.

The following kfxKUICaptureMessage properties are not supported for this message:

  • messageIcons
  • backGround

Default configuration:

  • message: "Fill viewable area with check"
  • font: HelveticaNeue with size 25. If text can't be fit in the message box tail truncation will be used.
  • text color: white
  • backGroundColor: clear
  • position: centered inside viewfinder
  • size: width is equal to the viewfinder width and height is 100 points
  • orientation: landscape right
See also
kfxKUICaptureMessage

The documentation for this class 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.