This is the base class for check and document capture, that renders a visual experience on top of the capture control and returns an image, depending on the criteria set by the user. More...
#import <kfxKUIDocumentBaseCaptureExperience.h>
Instance Methods | |
| (void) | - takePicture |
| Begins the image capture process. More... | |
| (void) | - takePictureContinually |
| Starts the continuous capture of images. More... | |
| (void) | - stopCapture |
| Stops taking a picture. More... | |
| (instancetype) | - initWithCaptureControl:criteria: |
| Initialized for the object using the specified parameters. More... | |
 Instance Methods inherited from kfxKUICaptureExperience | |
| (void) | - stateChanged: |
| Instance Methods inherited from <kfxKUIImageCaptureControlDelegate> | |
| (void) | - imageCaptureControl:stabilityDelay: |
| A message that indicates the current stability of the device. More... | |
| (void) | - imageCaptureControl:imageCaptured: |
| A message that indicates that an image was captured. More... | |
| (void) | - imageCaptureControl:pitchChangedTo:rollChangedTo: |
| A message that indicates the current pitch and roll. More... | |
| (void) | - imageCaptureControl:focusStateChanged: |
| A message that indicates the camera has begun or finished focusing. More... | |
| (void) | - imageIsAboutToCaptureForControl: |
| A message that indicates that an image is about to capture. More... | |
| (void) | - imageCaptureControl:imageJustCaptured: |
| A message that indicates that an image is just captured. More... | |
| (void) | - imageCaptureControl:videoSampleAvailable: |
| A message that is dispatched whenever a new video sample is available from the camera. More... | |
| (void) | - imageCaptureControl:pageDetected: |
| A message that indicates page detection has located a document in the camera preview. More... | |
Properties | |
| kfxKUICaptureMessage * | userInstruction |
| An instructional text box that is displayed to the user while trying to capture a document. More... | |
| kfxKUICaptureMessage * | holdSteadyMessage |
| An instructional balloon that is displayed to the user to hold the device steady. More... | |
| kfxKUICaptureMessage * | centerMessage |
| An instructional balloon that is displayed to the user for center the document. More... | |
| kfxKUICaptureMessage * | capturedMessage |
| An instructional balloon that is displayed to the user for when document is successfully captured. More... | |
| kfxKUICaptureMessage * | zoomOutMessage |
| An instructional balloon that is displayed to the user for zoom out action. More... | |
| kfxKUICaptureMessage * | zoomInMessage |
| An instructional balloon that is displayed to the user for zoom in action. More... | |
| kfxKUICaptureMessage * | tutorialDismissMessage |
| An instructional message that is displayed to the user for closing the tutorial. More... | |
| kfxKUICaptureMessage * | rotateMessage |
| An instructional balloon that is displayed to the user for rotate action. More... | |
| kfxKUICaptureMessage * | holdParallelMessage |
| An instructional balloon that is displayed to the user for holding the device more flat. More... | |
| BOOL | tutorialEnabled |
| Whether to show an animated tutorial about how to capture a document. More... | |
| UIImage * | tutorialSampleImage |
| A tutorial image showing how to capture a document. More... | |
| UIColor * | outerViewfinderColor |
| Outer viewfinder color. More... | |
| UIColor * | guidanceFrameColor |
| Guidance frame color. More... | |
| int | guidanceFrameThickness |
| Guidance frame thickness. More... | |
| UIColor * | steadyGuidanceFrameColor |
| Steady guidance frame color. More... | |
| BOOL | vibrationEnabled |
| Whether to start vibration when an image is captured. More... | |
| BOOL | diagnosticsViewEnabled |
| Whether to show a diagnostics view. More... | |
Detailed Description
This is the base class for check and document capture, that renders a visual experience on top of the capture control and returns an image, depending on the criteria set by the user.
This class is responsible for rendering the enhanced visual experience on top of the capture control, and provides feedback to guide the user to take a clear, legible and optimally zoomed in photo of a document.
Method Documentation
◆ initWithCaptureControl:criteria:()
| - (instancetype) initWithCaptureControl: | (kfxKUIImageCaptureControl *) | captureControl | |
| criteria: | (kfxKUIDocumentBaseCaptureExperienceCriteriaHolder *) | criteria | |
Initialized for the object using the specified parameters.
Initializes a base document capture experience and binds it to the given image capture control. The experience class overrides the capture control delegate to provide additional behavior and guidance useful for capturing documents. It also forwards delegate invocations to the original delegate set on the capture control, thus acting as a proxy.
If you are interested in handling any of the delegate methods on the capture control, it is important that you set your delegate before initializing the capture experience. Setting a new delegate after initializing the capture experience will break the association with the capture control, and allow the capture experience to be shut down and deallocated if no other references to the object remain. This is the proper protocol for cleaning up a capture experience you are no longer interested in.
The base document capture experience will add several overlays and subviews on top of the associated image capture control for visual guidance and feedback. It will also manage some of the capture control's native properties, which could interfere with any properties you directly modify on the control.
For best results, your image capture control should be configured to use video capture mode. This will normally result in a larger preview resolution being used. Small preview resolutions will make document detection difficult and negatively impact user guidance. In particular, the capture experience will rarely be able to deliver zoom-related guidance with low resolution preview images.
- Parameters
-
captureControl An instance of a kfxKUIImageCaptureControl object. criteria A collection of constraints and attributes that control the behavior of the capture experience. Pass nil for the default experience.
◆ stopCapture()
| - (void) stopCapture |
Stops taking a picture.
This can be used in continuous mode as well to stop taking pictures
◆ takePicture()
| - (void) takePicture |
Begins the image capture process.
Calling this method will start the process of monitoring the capture criteria that was configured to determine when a document that meets all the criteria can be captured. The delegate will receive a imageCaptureControl:imageCaptured: message for each captured image.
◆ takePictureContinually()
| - (void) takePictureContinually |
Starts the continuous capture of images.
Calling this method will start or stop the continuous capture of images. Images will automatically be captured when criteria are satisfied.
Property Documentation
◆ capturedMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for when document is successfully captured.
This message will be displayed when document is captured.
Default configuration:
- message: "Done!"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: green
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: checkmark.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxKUICaptureMessage
◆ centerMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for center the document.
This instruction will be displayed when document is not enough centered in the target frame for capture.
Default configuration:
- message: "Center Document"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: none Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxUICaptureMessage
◆ diagnosticsViewEnabled
|
readwritenonatomicassign |
Whether to show a diagnostics view.
A boolean to turn on/off diagnostics view.
By default is NO.
◆ guidanceFrameColor
|
readwritenonatomicstrong |
Guidance frame color.
Specifies the color that will be used for the guidance frame, for example in the case of check capture.
The default color is green.
◆ guidanceFrameThickness
|
readwritenonatomicassign |
Guidance frame thickness.
Specifies the thickness that will be used for the guidance frame, for example in the case of check capture. Valid values are in the range [1, 100]. Values outside this range will be interpreted as 8.
The default thickness is 8.
◆ holdParallelMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for holding the device more flat.
This instruction will be displayed when device is not enough parallel to the surface. The levelness thresholds can be set using the pitchThreshold and rollThreshold from kfxKUICaptureExperienceCriteriaHolder.
Default configuration:
- message: "Hold Device Level"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: holdparallelup.png and holdparalleldown.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
◆ holdSteadyMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user to hold the device steady.
A property to configure the attributes of the message that is displayed on the capture control to direct the user to hold the device steady so that a clear focused image can be captured. This message is shown when all the constraints are met and ready to capture.
Default configuration:
- message: "Hold Steady"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: red
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: cameragrey.png and cameracolor.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxUICaptureMessage
◆ outerViewfinderColor
|
readwritenonatomicstrong |
Outer viewfinder color.
Specifies the color that will be used for the outer viewfinder background.
The default color is transparent grey.
◆ rotateMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for rotate action.
This message will be displayed when the capture experience needs to instruct the user to rotate the device or the document.
Default configuration:
- message: "Rotate Device"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: rotatecolor.png and rotateblack.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxKUICaptureMessage
◆ steadyGuidanceFrameColor
|
readwritenonatomicstrong |
Steady guidance frame color.
Specifies the color that will be used for the guidance frame when control is ready to capture. If set to nil, the guidanceFrameColor will be used.
By default is nil.
◆ tutorialDismissMessage
|
readwritenonatomicstrong |
An instructional message that is displayed to the user for closing the tutorial.
This message will be displayed when the capture experience needs to instruct the user to skip tutorial demo.
Default configuration:
- message: "Tap to dismiss"
- text font: HelveticaNeue. If text can't be fit then font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: clear
- position: left/right aligned to inside of viewfinder
- size: width is equal to the viewfinder width and height is 100 points
- orientation: landscape right
- See also
- kfxKUICaptureMessage
◆ tutorialEnabled
|
readwritenonatomicassign |
Whether to show an animated tutorial about how to capture a document.
A boolean that indicates whether to show an animated tutorial about how to capture a document. A demo animation runs, which can educate users on how to capture the document. App can add a check box to take input from the user, as to whether to show or skip this animation every time. In the action method this property can be set accordingly.
By default is OFF.
◆ tutorialSampleImage
|
readwritenonatomicstrong |
A tutorial image showing how to capture a document.
A UIImage that will be displayed over the document frame area when the tutorialEnabled field is set to YES. The set image will be stretched to fill the entire document frame area while displayed.
By default is nil.
◆ userInstruction
|
readwritenonatomicstrong |
An instructional text box that is displayed to the user while trying to capture a document.
This instruction will be displayed during periods where other guidance is not available to correct a user. This may happen in particular when the user is holding a device far away from a document, preventing automated detection from recognizing the document.
The following kfxKUICaptureMessage properties are not supported for this message:
- messageIcons
- backGround
Default configuration:
- message: "Fill viewable area with document"
- font: HelveticaNeue with size 25. If text can't be fit in the message box tail truncation will be used.
- text color: white
- backGroundColor: clear
- position: centered inside viewfinder
- size: width is equal to the viewfinder width and height is 100 points
- orientation: landscape right
- See also
- kfxKUICaptureMessage
◆ vibrationEnabled
|
readwritenonatomicassign |
Whether to start vibration when an image is captured.
A boolean to turn on/off vibration when an image is captured for haptic feedback.
By default is YES.
◆ zoomInMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for zoom in action.
This message will be displayed when the capture experience needs to instruct the user to move the device closer to the target document.
Default configuration:
- message: "Move Closer"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: zoomincolor.png and zoominblack.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxKUICaptureMessage
◆ zoomOutMessage
|
readwritenonatomicstrong |
An instructional balloon that is displayed to the user for zoom out action.
This message will be displayed when the capture experience needs to instruct the user to move the device farther away from the target document.
Default configuration:
- message: "Move Back"
- text font: HelveticaNeue. If text can't be fit than font size will be decreased down to 10 and tail truncation will be used if required.
- text color: white
- backGroundColor: black with 0.7 alpha component
- position: centered inside viewfinder
- size: 40% of imageCaptureControl size
- orientation: landscape right
- messageIcons: zoomoutcolor.png and zoomoutblack.png from uiimages.bundle Icon is placed inside of the balloon and its position and size depends on the balloon size and text message. Icon will be centered inside balloon if there is no text message, otherwise it will be horizontally centered and shifted to the top to hold from 33% to 50% of vertical space depending on message length. Icon is scaled to fit available balloon space with fixed aspect ratio.
- backGround: none
- See also
- kfxKUICaptureMessage
The documentation for this class was generated from the following file: