Kofax Mobile SDK API Reference
KFXSelfieCaptureExperience.h
Go to the documentation of this file.
1 //
2 // KFXSelfieCaptureExperience.h
3 //
4 // Created by Kofax on 18/01/17.
5 // Copyright © 2017 Kofax. All rights reserved.
6 //
7 
8 #import <Foundation/Foundation.h>
9 #import <kfxLibUIControls/kfxKUIImageCaptureControl.h>
10 #import <kfxLibUIControls/KFXSelfieCaptureExperienceCriteriaHolder.h>
11 #import <kfxLibUIControls/KFXBaseObjectCaptureExperience.h>
12 #import <kfxLibUIControls/kfxKUICaptureMessage.h>
13 
15 
21 
23 
28 - (void)takePicture;
29 
31 
35 - (void)stopCapture;
36 
38 
49 - (id)initWithCaptureControl:(kfxKUIImageCaptureControl*)captureControl criteria:(KFXSelfieCaptureExperienceCriteriaHolder*)criteria;
50 
52 
57 
58 
60 
78 @property (nonatomic, strong) kfxKUICaptureMessage* userInstruction;
79 
81 
100 @property (nonatomic, strong) kfxKUICaptureMessage* eyesBlinkInstruction;
101 
103 
121 @property (nonatomic, strong) kfxKUICaptureMessage* capturedMessage;
122 
124 
128 @property (nonatomic, strong) UIColor* frameColor;
129 
131 
136 @property (nonatomic, strong) UIColor* outerViewfinderColor;
137 
139 
144 @property (nonatomic) BOOL vibrationEnabled;
145 
146 
147 @end
KFXSelfieCaptureExperience::criteriaHolder
KFXSelfieCaptureExperienceCriteriaHolder * criteriaHolder
Document capture criteria.
Definition: KFXSelfieCaptureExperience.h:56
KFXSelfieCaptureExperienceCriteriaHolder
Definition: KFXSelfieCaptureExperienceCriteriaHolder.h:11
KFXSelfieCaptureExperience::outerViewfinderColor
UIColor * outerViewfinderColor
Outer viewfinder color.
Definition: KFXSelfieCaptureExperience.h:136
kfxKUIImageCaptureControl
This class renders the camera preview to the screen and returns an image.
Definition: kfxKUIImageCaptureControl.h:146
KFXSelfieCaptureExperience::frameColor
UIColor * frameColor
frame color.
Definition: KFXSelfieCaptureExperience.h:128
KFXSelfieCaptureExperience::vibrationEnabled
BOOL vibrationEnabled
Whether to start vibration when an image is captured.
Definition: KFXSelfieCaptureExperience.h:144
KFXBaseObjectCaptureExperience
Base class for rendering a visual experience on top of the capture control when it is facing front si...
Definition: KFXBaseObjectCaptureExperience.h:13
KFXSelfieCaptureExperience::eyesBlinkInstruction
kfxKUICaptureMessage * eyesBlinkInstruction
An instructional text box that is displayed to the user while trying to capture a selfie.
Definition: KFXSelfieCaptureExperience.h:100
-[KFXSelfieCaptureExperience stopCapture]
void stopCapture()
Stops taking a picture.
KFXSelfieCaptureExperience
This class renders a visual experience on top of the capture control when it is facing front side and...
Definition: KFXSelfieCaptureExperience.h:20
-[KFXSelfieCaptureExperience takePicture]
void takePicture()
Begins the image capture process.
kfxKUICaptureMessage
This class renders the messages on the Imagecapturecontrol.
Definition: kfxKUICaptureMessage.h:21
KFXSelfieCaptureExperience::userInstruction
kfxKUICaptureMessage * userInstruction
An instructional text box that is displayed to the user while trying to capture a selfie.
Definition: KFXSelfieCaptureExperience.h:78
KFXSelfieCaptureExperience::capturedMessage
kfxKUICaptureMessage * capturedMessage
An instructional balloon that is displayed to the user for when seflie is successfully captured.
Definition: KFXSelfieCaptureExperience.h:121
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.