Kofax Mobile SDK 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 #import "kfxKEDImageCapturedEvent.h"
17 
19 @class kfxKEDImage;
21 
23 
28 
29 @optional
31 
35 -(void)imageCaptureControl:(kfxKUIImageCaptureControl*)imageCaptureControl
36  stabilityDelay:(int) stabilityDelay;
37 
39 
45 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
46  imageCaptured:(kfxKEDImage*)image DEPRECATED_ATTRIBUTE;
47 
49 
55 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
56  imageCapturedEvent:(kfxKEDImageCapturedEvent*)imageCapturedEvent;
57 
59 
62 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
63  pitchChangedTo:(int)pitch rollChangedTo:(int)roll;
64 
66 
68 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
69  focusStateChanged:(BOOL)isFocused;
70 
72 
74 -(void)imageIsAboutToCaptureForControl:(kfxKUIImageCaptureControl*)imageCaptureControl;
75 
77 
79 -(void)imageCaptureControl:(kfxKUIImageCaptureControl*)imageCaptureControl
80  imageJustCaptured:(kfxKEDImage*)image;
81 
83 
98 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl videoSampleAvailable:(CMSampleBufferRef)videoSample;
99 
101 
135 -(void)imageCaptureControl:(kfxKUIImageCaptureControl *)imageCaptureControl
136  pageDetected:(kfxKUIPageDetectionEvent *)event;
137 
138 @end
139 
140 
142 
146 @interface kfxKUIImageCaptureControl : UIView
147 
149 
154 +(void) initializeControl;
155 
157 
169 @property (nonatomic) kfxKUIFlashSetting flash;
170 
172 
179 @property (nonatomic) BOOL useVideoFrame;
180 
182 
191 
193 
202 @property (nonatomic) BOOL highResolutionStillImageEnabled;
203 
205 
212 @property (nonatomic) int deviceDeclinationPitch;
213 
215 
222 @property (nonatomic) int deviceDeclinationRoll;
223 
225 
233 @property (readonly, nonatomic) CGSize imagePreviewSize;
234 
236 
239 @property (readonly) CGPoint defaultFocusPoint;
240 
242 
264 @property (nonatomic) CGPoint focusPoint;
265 
267 
270 @property (nonatomic, weak) IBOutlet id<kfxKUIImageCaptureControlDelegate> delegate;
271 
273 
278 @property (nonatomic, strong) CMMotionManager* motionManager;
279 
281 
292 @property (nonatomic) kfxKUIGPSUsageLimits gpsUsageLimits;
293 
295 
302 -(int)forceTakePicture;
303 
305 
314 -(int)forceTakePicture:(BOOL)waitForFocus;
315 
317 
333 -(int)setImageResolution:(NSString*)resolution;
334 
336 
350 -(BOOL)canSetResolution:(NSString*)resolution;
351 
353 
358 - (void) SessionCreate;
359 
361 
365 - (void) SessionDismiss;
366 
368 
376 -(int)setCameraType:(kfxKUICameraType)cameraType;
377 
378 @end
379 
380 
-[kfxKUIImageCaptureControl SessionDismiss]
void SessionDismiss()
End an AppStats session.
kfxKUIImageCaptureControlDelegate-p
This protocol must be implemented by classes whose objects are used as kfxKUIImageCaptureControl dele...
Definition: kfxKUIImageCaptureControl.h:27
-[kfxKUIImageCaptureControl forceTakePicture]
int forceTakePicture()
Begins the image capture process and ignores all capture constraints.
kfxKUIFlashSetting
kfxKUIFlashSetting
An enumeration to set the flash mode of a capture control.
Definition: kfxKUICommon.h:13
-[kfxKUIImageCaptureControl SessionCreate]
void SessionCreate()
Begin an AppStats session.
kfxKUIImageCaptureControl
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:146
kfxKUIImageCaptureControl::imagePreviewSize
CGSize imagePreviewSize
Gets the camera preview resolution.
Definition: kfxKUIImageCaptureControl.h:233
kfxKUICameraType
kfxKUICameraType
An enumeration to set camera type.
Definition: kfxKUICommon.h:108
kfxKUIImageCaptureControl::deviceDeclinationPitch
int deviceDeclinationPitch
The reference pitch that indicates what angle means that the device is level.
Definition: kfxKUIImageCaptureControl.h:212
kfxKUIImageCaptureControl::deviceDeclinationRoll
int deviceDeclinationRoll
The reference roll that indicates what angle means that the device is level.
Definition: kfxKUIImageCaptureControl.h:222
kfxKUIImageCaptureControl::focusPoint
CGPoint focusPoint
The camera focus point.
Definition: kfxKUIImageCaptureControl.h:264
kfxKUIPageDetectionEvent
This class that indicates a page was detected in the camera preview.
Definition: kfxKUIPageDetectionEvent.h:20
kfxKUIImageCaptureControl::highResolutionStillImageEnabled
BOOL highResolutionStillImageEnabled
A Boolean value that indicates whether capture control should emit still images at the highest resolu...
Definition: kfxKUIImageCaptureControl.h:202
kfxKUIFrame.h
kfxKEDBoundingTetragon
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
kfxKUIImageCaptureControl::useVideoFrame
BOOL useVideoFrame
Whether the video frame is retured, or a full-resolution image is captured.
Definition: kfxKUIImageCaptureControl.h:179
kfxKEDImage
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:157
kfxKUIImageCaptureControl::motionManager
CMMotionManager * motionManager
The motion manager being used to detect the levelness of the device.
Definition: kfxKUIImageCaptureControl.h:278
kfxKUIImageCaptureControl::defaultFocusPoint
CGPoint defaultFocusPoint
Gets the default camera focus point.
Definition: kfxKUIImageCaptureControl.h:239
kfxKUIImageCaptureControl::flash
kfxKUIFlashSetting flash
The current camera flash mode.
Definition: kfxKUIImageCaptureControl.h:169
+[kfxKUIImageCaptureControl initializeControl]
void initializeControl()
This message initializes the control and must be sent to the class before it is used.
kfxKUIImageCaptureControl::gpsUsageLimits
kfxKUIGPSUsageLimits gpsUsageLimits
gpsUsageLimits - controls whether GPS location information is captured with the image.
Definition: kfxKUIImageCaptureControl.h:292
kfxKUIGPSUsageLimits
kfxKUIGPSUsageLimits
An enumeration to control use of GPS location information.
Definition: kfxKUICommon.h:84
kfxKUIImageCaptureControl::delegate
IBOutlet id< kfxKUIImageCaptureControlDelegate > delegate
A delegate to receive messages from the control.
Definition: kfxKUIImageCaptureControl.h:270
kfxKUIPageDetectionEvent.h
kfxKUICommon.h
kfxKUIImageCaptureControl::automaticallyEnablesStillImageStabilization
BOOL automaticallyEnablesStillImageStabilization
A Boolean value that indicates whether still image stabilization should be automatically enabled when...
Definition: kfxKUIImageCaptureControl.h:190
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.