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 
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 
151 
165 @property (nonatomic, strong) kfxKUICaptureMessage* tutorialDismissMessage;
166 
168 
186 @property (nonatomic, strong) kfxKUICaptureMessage* rotateMessage;
187 
189 
209 @property (nonatomic, strong) kfxKUICaptureMessage* holdParallelMessage;
210 
212 
217 @property (nonatomic) BOOL tutorialEnabled;
218 
220 
225 @property (nonatomic, strong) UIImage* tutorialSampleImage;
226 
228 
233 @property (nonatomic, strong) UIColor* outerViewfinderColor;
234 
236 
241 @property (nonatomic, strong) UIColor* guidanceFrameColor;
242 
244 
250 @property (nonatomic, strong) UIColor* steadyGuidanceFrameColor;
251 
253 
258 @property (nonatomic) BOOL vibrationEnabled;
259 
261 
265 - (void)takePicture;
266 
268 
271 - (void)takePictureContinually;
272 
274 
277 - (void)stopCapture;
278 
280 
292 - (instancetype)initWithCaptureControl:(kfxKUIImageCaptureControl*)captureControl criteria:(kfxKUIDocumentBaseCaptureExperienceCriteriaHolder*)criteria;
293 
294 @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:250
BOOL vibrationEnabled
Whether to start vibration when an image is captured.
Definition: kfxKUIDocumentBaseCaptureExperience.h:258
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:217
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:225
kfxKUICaptureMessage * rotateMessage
An instructional balloon that is displayed to the user for rotate action.
Definition: kfxKUIDocumentBaseCaptureExperience.h:186
kfxKUICaptureMessage * tutorialDismissMessage
An instructional message that is displayed to the user for closing the tutorial.
Definition: kfxKUIDocumentBaseCaptureExperience.h:165
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:159
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:241
kfxKUICaptureMessage * holdParallelMessage
An instructional balloon that is displayed to the user for holding the device more flat...
Definition: kfxKUIDocumentBaseCaptureExperience.h:209
UIColor * outerViewfinderColor
Outer viewfinder color.
Definition: kfxKUIDocumentBaseCaptureExperience.h:233
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.