Kofax Mobile SDK API Reference
Classes | Public Member Functions | List of all members
CameraInitializationEvent Class Reference

This event fires when the camera is initialized or reinitialized. More...

Inheritance diagram for CameraInitializationEvent:

Classes

enum  CameraInitStatus
 

Public Member Functions

 CameraInitializationEvent (Object source, Camera.Size defaultImageResolution, CameraInitStatus cameraInitStatus)
 
final Size getDefaultImageCaptureResolution ()
 Returns the auto-calculated image capture resolution which becomes the default image resolution used when capturing. More...
 
final CameraInitStatus getCameraInitStatus ()
 Returns the CameraInitStatus value which represents the reason the camera was initialized. More...
 

Detailed Description

This event fires when the camera is initialized or reinitialized.

This event fires every time the camera is initialized or reinitialized. The camera will be initialized every time the ImageCaptureView is instantiated. It will be reinitialized every time the application explicitly sets the desired resolution for image capture by calling setImageResolution(Size resolution). It will also be reinitialized every time the application toggles between 'capture video frame as captured frame', and 'capture full-resolution photo' by calling setUseVideoFrame(boolean useVideo). The property getter getDefaultImageCaptureResolution() returns the auto-calculated image capture resolution. The returned resolution is the same resolution that would be set if setImageResolution were never called.
Note: It is recommended for low-resolution devices to not exceed the megapixel value of this size.
Note: The returned resolution may differ depending on the value of getUseVideoFrame().

See also
com.kofax.kmc.kui.uicontrols.ImageCaptureView::getAllowableImageResolutions()
com.kofax.kmc.kui.uicontrols.ImageCaptureView::setImageResolution(Size)
com.kofax.kmc.kui.uicontrols.ImageCaptureView::setUseVideoFrame(boolean)

Constructor & Destructor Documentation

CameraInitializationEvent ( Object  source,
Camera.Size  defaultImageResolution,
CameraInitStatus  cameraInitStatus 
)

Member Function Documentation

final CameraInitStatus getCameraInitStatus ( )

Returns the CameraInitStatus value which represents the reason the camera was initialized.

final Size getDefaultImageCaptureResolution ( )

Returns the auto-calculated image capture resolution which becomes the default image resolution used when capturing.


The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.