Atalasoft MobileImage API Reference
kfxKUIDocumentBaseCaptureExperience.h
Go to the documentation of this file.
1 //
2 // kfxKUIDocumentBaseCaptureExperience.h
3 // kfxLibUIControls
4 //
5 // Copyright (c) 2017 Kofax. All rights reserved.
6 //
7 
8 #import <Foundation/Foundation.h>
9 #import <kfxLibUIControls/kfxKUICaptureExperience.h>
10 #import <kfxLibUIControls/kfxKUIDocumentBaseCaptureExperienceCriteriaHolder.h>
11 #import <kfxLibUIControls/kfxKUICaptureMessage.h>
12 
14 
16 
21 
23 
41 @property (nonatomic, strong) kfxKUICaptureMessage* userInstruction;
42 
44 
62 @property (nonatomic, strong) kfxKUICaptureMessage* holdSteadyMessage;
63 
65 
83 @property (nonatomic, strong) kfxKUICaptureMessage* centerMessage;
84 
86 
104 @property (nonatomic, strong) kfxKUICaptureMessage* capturedMessage;
105 
107 
125 @property (nonatomic, strong) kfxKUICaptureMessage* zoomOutMessage;
126 
128 
146 @property (nonatomic, strong) kfxKUICaptureMessage* zoomInMessage;
147 
149 
163 @property (nonatomic, strong) kfxKUICaptureMessage* tutorialDismissMessage;
164 
166 
184 @property (nonatomic, strong) kfxKUICaptureMessage* rotateMessage;
185 
187 
207 @property (nonatomic, strong) kfxKUICaptureMessage* holdParallelMessage;
208 
210 
215 @property (nonatomic) BOOL tutorialEnabled;
216 
218 
223 @property (nonatomic, strong) UIImage* tutorialSampleImage;
224 
226 
231 @property (nonatomic, strong) UIColor* outerViewfinderColor;
232 
234 
239 @property (nonatomic, strong) UIColor* guidanceFrameColor;
240 
242 
248 @property (nonatomic, strong) UIColor* steadyGuidanceFrameColor;
249 
251 
256 @property (nonatomic) BOOL vibrationEnabled;
257 
259 
264 @property (nonatomic, assign) BOOL diagnosticsViewEnabled;
265 
267 
271 - (void)takePicture;
272 
274 
277 - (void)takePictureContinually;
278 
280 
283 - (void)stopCapture;
284 
286 
298 - (instancetype)initWithCaptureControl:(kfxKUIImageCaptureControl*)captureControl criteria:(kfxKUIDocumentBaseCaptureExperienceCriteriaHolder*)criteria;
299 
300 @end
void takePicture()
Begins the image capture process.
This class renders the messages on the Imagecapturecontrol.
Definition: kfxKUICaptureMessage.h:21
kfxKUICaptureMessage * holdSteadyMessage
An instructional balloon that is displayed to the user to hold the device steady. ...
Definition: kfxKUIDocumentBaseCaptureExperience.h:62
kfxKUICaptureMessage * userInstruction
An instructional text box that is displayed to the user while trying to capture a document...
Definition: kfxKUIDocumentBaseCaptureExperience.h:41
UIColor * steadyGuidanceFrameColor
Steady guidance frame color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:248
BOOL diagnosticsViewEnabled
Whether to show a diagnostics view.
Definition: kfxKUIDocumentBaseCaptureExperience.h:264
BOOL vibrationEnabled
Whether to start vibration when an image is captured.
Definition: kfxKUIDocumentBaseCaptureExperience.h:256
kfxKUICaptureMessage * centerMessage
An instructional balloon that is displayed to the user for center the document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:83
void takePictureContinually()
Starts the continuous capture of images.
kfxKUICaptureMessage * zoomInMessage
An instructional balloon that is displayed to the user for zoom in action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:146
BOOL tutorialEnabled
Whether to show an animated tutorial about how to capture a document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:215
Definition: kfxKUIDocumentBaseCaptureExperienceCriteriaHolder.h:10
kfxKUICaptureMessage * zoomOutMessage
An instructional balloon that is displayed to the user for zoom out action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:125
void stopCapture()
Stops taking a picture.
This is the base class for check and document capture, that renders a visual experience on top of the...
Definition: kfxKUIDocumentBaseCaptureExperience.h:20
kfxKUICaptureMessage * capturedMessage
An instructional balloon that is displayed to the user for when document is successfully captured...
Definition: kfxKUIDocumentBaseCaptureExperience.h:104
UIImage * tutorialSampleImage
A tutorial image showing how to capture a document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:223
kfxKUICaptureMessage * rotateMessage
An instructional balloon that is displayed to the user for rotate action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:184
kfxKUICaptureMessage * tutorialDismissMessage
An instructional message that is displayed to the user for closing the tutorial.
Definition: kfxKUIDocumentBaseCaptureExperience.h:163
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:122
This class is a base class for the animation experience.
Definition: kfxKUICaptureExperience.h:17
Base class for detector settings.
Definition: kfxKEDDocumentBaseDetectionSettings.h:20
UIColor * guidanceFrameColor
Guidance frame color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:239
kfxKUICaptureMessage * holdParallelMessage
An instructional balloon that is displayed to the user for holding the device more flat...
Definition: kfxKUIDocumentBaseCaptureExperience.h:207
UIColor * outerViewfinderColor
Outer viewfinder color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:231
Untitled Document © 2017 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.