Atalasoft MobileImage API Reference
Public Member Functions | Protected Member Functions | List of all members
LicenseCaptureView Class Reference
Inheritance diagram for LicenseCaptureView:

Public Member Functions

 LicenseCaptureView (Context context)
 LicenseCaptureView (Context context, AttributeSet set)
 LicenseCaptureView (Context context, AttributeSet set, int defStyle)
void addLicenseFoundEventListener (LicenseFoundListener listener)
void removeLicenseFoundEventListener (LicenseFoundListener listener)
double getViewfinderPaddingPercent ()
void setViewfinderPaddingPercent (double paddingPercent)
int getOuterViewFinderColor ()
void setOuterViewFinderColor (int colorCode)
CaptureMessage getUserInstructionMessage ()
void setUserInstructionMessage (CaptureMessage userInstructionsMessage)
void readLicense ()
void onPreviewFrame (PreviewImageReadyBusEvent evt)
- Public Member Functions inherited from ImageCaptureView
 ImageCaptureView (Context context)
 ImageCaptureView (Context context, AttributeSet set)
 ImageCaptureView (Context context, AttributeSet set, int defStyle)
final void takePicture ()
final ImageCaptureFrame getImageCaptureFrame ()
final void setImageCaptureFrame (ImageCaptureFrame imageCaptureFrame)
final int getImagePreviewWidth ()
final int getImagePreviewHeight ()
final int getStabilityDelay ()
final void setStabilityDelay (int stabilityDelay)
final PageDetectMode getPageDetectMode ()
final void setPageDetectMode (PageDetectMode mode)
ViewGroup getViewGroup ()
final int getPageAreaForDetection ()
final Flash getFlash ()
final void setFlash (Flash flash)
final boolean isFlashSupported (Flash flash)
final GpsUsageLimits getGpsUsage ()
final void setGpsUsage (GpsUsageLimits limits)
final int getLevelThresholdPitch ()
final void setLevelThresholdPitch (int threshold)
final int getLevelThresholdRoll ()
final void setLevelThresholdRoll (int threshold)
final void setImageResolution (android.hardware.Camera.Size resolution)
final void setCameraType (CameraType cameraType)
final void setImageResolution (Size resolution)
final List< android.hardware.Camera.Size > getAllowableResolutions ()
final List< SizegetAllowableImageResolutions ()
final List< Rect > getFocusAreas ()
final void setFocusAreas (List< Rect > focusAreas) throws KmcRuntimeException
final int getMaxFocusAreas ()
final boolean getUseVideoFrame ()
final void setUseVideoFrame (boolean useVideo)
final int getDeviceDeclinationPitch ()
final void setDeviceDeclinationPitch (int angle)
final int getDeviceDeclinationRoll ()
final void setDeviceDeclinationRoll (int angle)
final int getLuminanceThreshold ()
final void setLuminanceThreshold (int luminanceThreshold)
final int getTorchDelay ()
final void setTorchDelay (int torchDelay)
final void muteAutoTorch ()
final void unmuteAutoTorch ()
final void forceTakePicture ()
final void forceTakePicture (boolean focusAgain)
final void doContinuousMode (boolean start)
final synchronized void sessionCreate ()
final synchronized void sessionDismiss ()
final void addOnAutoFocusResultListener (AutoFocusResultListener listener)
final void removeOnAutoFocusResultListener (AutoFocusResultListener listener)
final void addOnImageCapturedListener (ImageCapturedListener listener)
final void removeOnImageCapturedListener (ImageCapturedListener listener)
final void addStabilityDelayListener (StabilityDelayListener listener)
final void removeStabilityDelayListener (StabilityDelayListener listener)
final void addLevelnessListener (LevelnessListener listener)
final void removeLevelnessListener (LevelnessListener listener)
final void addCameraInitializationListener (CameraInitializationListener listener)
final void removeCameraInitializationListener (CameraInitializationListener listener)
final void addCameraInitializationFailedListener (CameraInitializationFailedListener listener)
final void removeCameraInitializationFailedListener (CameraInitializationFailedListener listener)
final void addPreviewCallbackListener (PreviewCallbackListener listener)
final void removePreviewCallbackListener (PreviewCallbackListener listener)
final void addTorchLuminanceListener (TorchLuminanceListener listener)
final void removeTorchLuminanceListener (TorchLuminanceListener listener)
void removeAllViews ()
void surfaceChanged (SurfaceHolder holder, int format, int width, int height)
void surfaceCreated (SurfaceHolder holder)
void surfaceDestroyed (SurfaceHolder holder)

Protected Member Functions

void checkLicense ()
- Protected Member Functions inherited from ImageCaptureView
void checkLicense ()
void onLayout (boolean changed, int l, int t, int r, int b)
void onDetachedFromWindow ()
void onAttachedToWindow ()

Additional Inherited Members

- Static Public Attributes inherited from ImageCaptureView
static final int DEFAULT_LUMINANCE_THRESHOLD = 100
static final int DEFAULT_TORCH_DELAY = 3
- Protected Attributes inherited from ImageCaptureView
IBus _bus

Detailed Description

This view provides a capture experience optimized for SDK license capture in QR code format. The view provides visual guidance to the end-user to maximize the chances of correctly decoding an SDK license. Once the view has been asked to read an SDK license, it will search continuously until one is found.

Constructor & Destructor Documentation

LicenseCaptureView ( Context  context)
LicenseCaptureView ( Context  context,
AttributeSet  set 
LicenseCaptureView ( Context  context,
AttributeSet  set,
int  defStyle 

Member Function Documentation

void addLicenseFoundEventListener ( LicenseFoundListener  listener)

Adds the specified SDK license search listener to receive license found events from this view.

void checkLicense ( )
int getOuterViewFinderColor ( )

Returns the color used for the outer view finder background.

The color used for the outer view finder background
CaptureMessage getUserInstructionMessage ( )

Returns the attributes of the instruction message that is displayed on the capture control while the user is trying to capture. This message 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 too far away from a document, preventing detection.

The following CaptureMessage properties are not supported for this message:

Default configuration:

  • message: "Fill viewable area with license in QR Code format"
  • text color: white
  • background color: transparent
  • background drawable: not specified
  • text size: 18
  • typeface: not specified
  • orientation: CaptureMessage.KUIMessageOrientation#PORTRAIT
  • width and height: not specified
  • position: center
  • visibility: true
See also
double getViewfinderPaddingPercent ( )

Returns padding percent required between the viewfinder and camera preview frame.

A double in the range [0-50].
void onPreviewFrame ( PreviewImageReadyBusEvent  evt)
void readLicense ( )

This call returns immediately and starts asynchronously searching for an SDK license. The search will continue indefinitely until an SDK license is found. Once an SDK license is positively read, the LicenseFoundEvent is raised. If license string is valid it will be set into SDK for licensing.

void removeLicenseFoundEventListener ( LicenseFoundListener  listener)

Removes the specified SDK license search listener from this view.

void setOuterViewFinderColor ( int  colorCode)

Specifies the color that will be used for the outer view finder background. The default color is translucent grey.

void setUserInstructionMessage ( CaptureMessage  userInstructionsMessage)

A property to configure the attributes of the instruction message that is displayed on the capture control while the user is trying to capture.

userInstructionsMessage: CaptureMessage
See also
void setViewfinderPaddingPercent ( double  paddingPercent)

This value determines how much percentage the viewfinder needs to be positioned inside the camera preview frame. Valid values are [0-50]. Default Value is 10.

paddingPercentdouble in the range [0-50].

The documentation for this class was generated from the following file:
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.