Atalasoft MobileImage API Reference
kfxKUIDocumentBaseCaptureExperience.h
Go to the documentation of this file.
1 //
2 // kfxKUIDocumentBaseCaptureExperience.h
3 // kfxLibUIControls
4 //
5 // Copyright (c) 2016 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 
23 
25 
43 @property (nonatomic, strong) kfxKUICaptureMessage* userInstruction;
44 
46 
64 @property (nonatomic, strong) kfxKUICaptureMessage* holdSteadyMessage;
65 
67 
85 @property (nonatomic, strong) kfxKUICaptureMessage* centerMessage;
86 
88 
106 @property (nonatomic, strong) kfxKUICaptureMessage* capturedMessage;
107 
109 
127 @property (nonatomic, strong) kfxKUICaptureMessage* zoomOutMessage;
128 
130 
148 @property (nonatomic, strong) kfxKUICaptureMessage* zoomInMessage;
149 
150 
152 
166 @property (nonatomic, strong) kfxKUICaptureMessage* tutorialDismissMessage;
167 
169 
187 @property (nonatomic, strong) kfxKUICaptureMessage* rotateMessage;
188 
190 
210 @property (nonatomic, strong) kfxKUICaptureMessage* holdParallelMessage;
211 
213 
218 @property (nonatomic) BOOL tutorialEnabled;
219 
221 
226 @property (nonatomic, strong) UIImage* tutorialSampleImage;
227 
229 
234 @property (nonatomic, strong) UIColor* outerViewfinderColor;
235 
237 
242 @property (nonatomic, strong) UIColor* guidanceFrameColor;
243 
245 
251 @property (nonatomic, strong) UIColor* steadyGuidanceFrameColor;
252 
254 
259 @property (nonatomic) BOOL vibrationEnabled;
260 
262 
267 - (void)takePicture;
268 
270 
275 - (void)takePictureContinually;
276 
278 
281 - (void)stopCapture;
282 
284 
297 - (instancetype)initWithCaptureControl:(kfxKUIImageCaptureControl*)captureControl criteria:(kfxKUIDocumentBaseCaptureExperienceCriteriaHolder*)criteria;
298 
299 @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:64
kfxKUICaptureMessage * userInstruction
An instructional text box that is displayed to the user while trying to capture a document...
Definition: kfxKUIDocumentBaseCaptureExperience.h:43
UIColor * steadyGuidanceFrameColor
Steady guidance frame color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:251
BOOL vibrationEnabled
Whether to start vibration when an image is captured.
Definition: kfxKUIDocumentBaseCaptureExperience.h:259
kfxKUICaptureMessage * centerMessage
An instructional balloon that is displayed to the user for center the document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:85
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:148
BOOL tutorialEnabled
Whether to show an animated tutorial about how to capture a document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:218
Definition: kfxKUIDocumentBaseCaptureExperienceCriteriaHolder.h:10
kfxKUICaptureMessage * zoomOutMessage
An instructional balloon that is displayed to the user for zoom out action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:127
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:22
kfxKUICaptureMessage * capturedMessage
An instructional balloon that is displayed to the user for when document is successfully captured...
Definition: kfxKUIDocumentBaseCaptureExperience.h:106
UIImage * tutorialSampleImage
A tutorial image showing how to capture a document.
Definition: kfxKUIDocumentBaseCaptureExperience.h:226
kfxKUICaptureMessage * rotateMessage
An instructional balloon that is displayed to the user for rotate action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:187
kfxKUICaptureMessage * tutorialDismissMessage
An instructional message that is displayed to the user for closing the tutorial.
Definition: kfxKUIDocumentBaseCaptureExperience.h:166
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:144
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:242
kfxKUICaptureMessage * holdParallelMessage
An instructional balloon that is displayed to the user for holding the device more flat...
Definition: kfxKUIDocumentBaseCaptureExperience.h:210
UIColor * outerViewfinderColor
Outer viewfinder color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:234
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.