Atalasoft MobileImage API Reference
kfxKUIImageCaptureControl.h
Go to the documentation of this file.
1 //
2 // API Reference
3 // kfxKUIImageCaptureControl.h
4 // Framework: kfxLibUIControls
5 //
6 // Copyright (c) 2012 - 2016 Kofax. Use of this code is with permission pursuant to Kofax license terms.
7 
8 
9 #import <UIKit/UIKit.h>
10 #import <CoreMotion/CoreMotion.h>
11 #import <CoreMedia/CMSampleBuffer.h>
12 
13 #import "kfxKUICommon.h"
14 #import "kfxKUIFrame.h"
16 
18 @class kfxKEDImage;
20 
22 
27 
28 @optional
30 
34 -(void)imageCaptureControl:(kfxKUIImageCaptureControl*)imageCaptureControl
35  stabilityDelay:(int) stabilityDelay;
36 
38 
43 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
44  imageCaptured:(kfxKEDImage*)image;
45 
47 
50 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
51  pitchChangedTo:(int)pitch rollChangedTo:(int)roll;
52 
54 
56 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
57  focusStateChanged:(BOOL)isFocused;
58 
60 
70 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
71  pageDetected:(UIImage *)previewImage pageCoordinates:(kfxKEDBoundingTetragon *)bound DEPRECATED_ATTRIBUTE;
72 
74 
91 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl videoFrameAvailable:(UIImage *)videoFrame DEPRECATED_ATTRIBUTE;
92 
94 
111 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl videoSampleAvailable:(CMSampleBufferRef)videoSample;
112 
114 
133 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
134  pageDetected:(kfxKUIPageDetectionEvent *)event;
135 
136 @end
137 
138 
140 
144 @interface kfxKUIImageCaptureControl : UIView
145 
147 
152 +(void) initializeControl;
153 
155 
160 @property (nonatomic) int stabilityDelay;
161 
163 
166 @property (nonatomic) kfxKUIFlashSetting flash;
167 
169 
172 @property (nonatomic, strong) kfxKUIFrame* imageFrame;
173 
175 
182 @property (nonatomic) BOOL useVideoFrame;
183 
185 
194 
196 
223 @property (nonatomic) kfxKUIPageDetect pageDetectMode DEPRECATED_ATTRIBUTE;
224 
226 
235 @property (nonatomic) int levelThresholdPitch;
236 
238 
247 @property (nonatomic) int levelThresholdRoll;
248 
250 
257 @property (nonatomic) int deviceDeclinationPitch;
258 
259 
261 
268 @property (nonatomic) int deviceDeclinationRoll;
269 
271 
279 @property (readonly, nonatomic) CGSize imagePreviewSize;
280 
282 
300 @property (nonatomic) int pageAreaForDetection DEPRECATED_ATTRIBUTE;
301 
303 
306 @property (readonly) CGPoint defaultFocusPoint;
307 
309 
332 @property (nonatomic) CGPoint focusPoint;
333 
335 
338 @property (nonatomic, weak) IBOutlet id<kfxKUIImageCaptureControlDelegate> delegate;
339 
341 
346 @property (nonatomic, strong) CMMotionManager* motionManager;
347 
349 
360 @property (nonatomic) kfxKUIGPSUsageLimits gpsUsageLimits;
361 
363 
370 -(int)takePicture;
371 
373 
381 -(int)forceTakePicture;
382 
383 
385 
395 -(int)forceTakePicture:(BOOL)waitForFocus;
396 
397 
398 
400 
413 -(int)doContinuousMode:(BOOL)enable;
414 
416 
432 -(int)setImageResolution:(NSString*)resolution;
433 
435 
449 -(BOOL)canSetResolution:(NSString*)resolution;
450 
452 
457 - (void) SessionCreate;
458 
460 
464 - (void) SessionDismiss;
465 
467 
470 -(void)stopCapture;
471 
472 @end
473 
474 
475 
476 
void stopCapture()
Stops taking a picture.
int forceTakePicture()
Begins the image capture process and ignores all capture constraints.
kfxKUIPageDetect pageDetectMode DEPRECATED_ATTRIBUTE
Gets or sets the the page detection behavior of the control.
Definition: kfxKUIImageCaptureControl.h:223
int deviceDeclinationPitch
The reference pitch that indicates what angle means that the device is level.
Definition: kfxKUIImageCaptureControl.h:257
This class that indicates a page was detected in the camera preview.
Definition: kfxKUIPageDetectionEvent.h:18
CGSize imagePreviewSize
Gets the camera preview resolution.
Definition: kfxKUIImageCaptureControl.h:279
kfxKUIFlashSetting
An enumeration to set the flash mode of a capture control.
Definition: kfxKUICommon.h:13
int stabilityDelay
The current stability delay.
Definition: kfxKUIImageCaptureControl.h:160
kfxKUIGPSUsageLimits
An enumeration to control use of GPS location information.
Definition: kfxKUICommon.h:84
int deviceDeclinationRoll
The reference roll that indicates what angle means that the device is level.
Definition: kfxKUIImageCaptureControl.h:268
This class defines a frame that can be applied to a capture control.
Definition: kfxKUIFrame.h:15
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
CGPoint focusPoint
The camera focus point.
Definition: kfxKUIImageCaptureControl.h:332
BOOL useVideoFrame
Whether the video frame is retured, or a full-resolution image is captured.
Definition: kfxKUIImageCaptureControl.h:182
int levelThresholdRoll
The threshold used to determine if the device is level.
Definition: kfxKUIImageCaptureControl.h:247
kfxKUIFrame * imageFrame
The kfxKUIFrame object.
Definition: kfxKUIImageCaptureControl.h:172
kfxKUIPageDetect
An enumeration to control page detection mode.
Definition: kfxKUICommon.h:72
CMMotionManager * motionManager
The motion manager being used to detect the levelness of the device.
Definition: kfxKUIImageCaptureControl.h:346
CGPoint defaultFocusPoint
Gets the default camera focus point.
Definition: kfxKUIImageCaptureControl.h:306
void initializeControl()
This message initializes the control and must be sent to the class before it is used.
int levelThresholdPitch
The threshold used to determine if the device is level.
Definition: kfxKUIImageCaptureControl.h:235
int takePicture()
Begins the image capture process.
This protocol must be implemented by classes whose objects are used as kfxKUIImageCaptureControl dele...
Definition: kfxKUIImageCaptureControl.h:26
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
IBOutlet id< kfxKUIImageCaptureControlDelegate > delegate
A delegate to receive messages from the control.
Definition: kfxKUIImageCaptureControl.h:338
kfxKUIGPSUsageLimits gpsUsageLimits
gpsUsageLimits - controls whether GPS location information is captured with the image.
Definition: kfxKUIImageCaptureControl.h:360
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:144
BOOL automaticallyEnablesStillImageStabilization
A Boolean value that indicates whether still image stabilization should be automatically enabled when...
Definition: kfxKUIImageCaptureControl.h:193
kfxKUIFlashSetting flash
The current camera flash mode.
Definition: kfxKUIImageCaptureControl.h:166
void SessionDismiss()
End an AppStats session.
void SessionCreate()
Begin an AppStats session.
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.