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 - 2017 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 
42 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
43  imageCaptured:(kfxKEDImage*)image;
44 
46 
49 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
50  pitchChangedTo:(int)pitch rollChangedTo:(int)roll;
51 
53 
55 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
56  focusStateChanged:(BOOL)isFocused;
57 
59 
74 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl videoSampleAvailable:(CMSampleBufferRef)videoSample;
75 
77 
111 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
112  pageDetected:(kfxKUIPageDetectionEvent *)event;
113 
114 @end
115 
116 
118 
122 @interface kfxKUIImageCaptureControl : UIView
123 
125 
130 +(void) initializeControl;
131 
133 
136 @property (nonatomic) kfxKUIFlashSetting flash;
137 
139 
146 @property (nonatomic) BOOL useVideoFrame;
147 
149 
158 
160 
169 @property (nonatomic) BOOL highResolutionStillImageEnabled;
170 
172 
179 @property (nonatomic) int deviceDeclinationPitch;
180 
182 
189 @property (nonatomic) int deviceDeclinationRoll;
190 
192 
200 @property (readonly, nonatomic) CGSize imagePreviewSize;
201 
203 
206 @property (readonly) CGPoint defaultFocusPoint;
207 
209 
231 @property (nonatomic) CGPoint focusPoint;
232 
234 
237 @property (nonatomic, weak) IBOutlet id<kfxKUIImageCaptureControlDelegate> delegate;
238 
240 
245 @property (nonatomic, strong) CMMotionManager* motionManager;
246 
248 
259 @property (nonatomic) kfxKUIGPSUsageLimits gpsUsageLimits;
260 
262 
269 -(int)forceTakePicture;
270 
272 
281 -(int)forceTakePicture:(BOOL)waitForFocus;
282 
284 
300 -(int)setImageResolution:(NSString*)resolution;
301 
303 
317 -(BOOL)canSetResolution:(NSString*)resolution;
318 
320 
325 - (void) SessionCreate;
326 
328 
332 - (void) SessionDismiss;
333 
335 
343 -(int)setCameraType:(kfxKUICameraType)cameraType;
344 
345 @end
346 
347 
int forceTakePicture()
Begins the image capture process and ignores all capture constraints.
int deviceDeclinationPitch
The reference pitch that indicates what angle means that the device is level.
Definition: kfxKUIImageCaptureControl.h:179
This class that indicates a page was detected in the camera preview.
Definition: kfxKUIPageDetectionEvent.h:20
CGSize imagePreviewSize
Gets the camera preview resolution.
Definition: kfxKUIImageCaptureControl.h:200
kfxKUIFlashSetting
An enumeration to set the flash mode of a capture control.
Definition: kfxKUICommon.h:13
BOOL highResolutionStillImageEnabled
A Boolean value that indicates whether capture control should emit still images at the highest resolu...
Definition: kfxKUIImageCaptureControl.h:169
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:189
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
CGPoint focusPoint
The camera focus point.
Definition: kfxKUIImageCaptureControl.h:231
BOOL useVideoFrame
Whether the video frame is retured, or a full-resolution image is captured.
Definition: kfxKUIImageCaptureControl.h:146
CMMotionManager * motionManager
The motion manager being used to detect the levelness of the device.
Definition: kfxKUIImageCaptureControl.h:245
CGPoint defaultFocusPoint
Gets the default camera focus point.
Definition: kfxKUIImageCaptureControl.h:206
void initializeControl()
This message initializes the control and must be sent to the class before it is used.
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
kfxKUICameraType
An enumeration to set camera type.
Definition: kfxKUICommon.h:108
IBOutlet id< kfxKUIImageCaptureControlDelegate > delegate
A delegate to receive messages from the control.
Definition: kfxKUIImageCaptureControl.h:237
kfxKUIGPSUsageLimits gpsUsageLimits
gpsUsageLimits - controls whether GPS location information is captured with the image.
Definition: kfxKUIImageCaptureControl.h:259
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:122
BOOL automaticallyEnablesStillImageStabilization
A Boolean value that indicates whether still image stabilization should be automatically enabled when...
Definition: kfxKUIImageCaptureControl.h:157
kfxKUIFlashSetting flash
The current camera flash mode.
Definition: kfxKUIImageCaptureControl.h:136
void SessionDismiss()
End an AppStats session.
void SessionCreate()
Begin an AppStats session.
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.