SelfieCaptureExperience Class Reference

Inheritance diagram for SelfieCaptureExperience:

Public Member Functions
	SelfieCaptureExperience (ImageCaptureView view)
	SelfieCaptureExperience (ImageCaptureView view, SelfieCaptureExperienceCriteriaHolder criteria)
void	setCaptureCriteria (SelfieCaptureExperienceCriteriaHolder criteria)
Public Member Functions inherited from SelfieBaseCaptureExperience
	SelfieBaseCaptureExperience (ImageCaptureView view, SelfieCaptureExperienceCriteriaHolder criteria)
SelfieCaptureExperienceCriteriaHolder	getCaptureCriteria ()
void	setVibrationEnabled (boolean enable)
boolean	isVibrationEnabled ()
CaptureMessage	getUserInstructionMessage ()
CaptureMessage	getBlinkMessage ()
CaptureMessage	getHoldSteadyMessage ()
CaptureMessage	getCapturedMessage ()
void	setUserInstructionMessage (CaptureMessage userInstructionMessage)
void	setBlinkMessage (CaptureMessage blinkMessage)
void	setHoldSteadyMessage (CaptureMessage holdSteadyMessage)
void	setCapturedMessage (CaptureMessage capturedMessage)
void	takePicture ()
void	stopCapture ()
void	setOuterViewFinderColor (int colorCode)
int	getOuterViewFinderColor ()
void	setFrameColor (int colorCode)
int	getFrameColor ()
double	getPaddingPercent ()
final void	addOnImageCapturedListener (ImageCapturedListener listener)
final void	removeOnImageCapturedListener (ImageCapturedListener listener)
void	destroy ()

Additional Inherited Members
Protected Member Functions inherited from SelfieBaseCaptureExperience
void	initBase (ImageCaptureView view, SelfieCaptureExperienceCriteriaHolder criteria)
Protected Attributes inherited from SelfieBaseCaptureExperience
Context	_ctx

Detailed Description

This class is responsible for rendering the enhanced visual experience on an ImageCaptureView and provides feedback to guide the user to take a clear, legible photo of a Selfie. Criteria of such a Selfie can be specified by using a setCaptureCriteria(SelfieCaptureExperienceCriteriaHolder) method.

A photo will be taken automatically once the specified criteria are met, and takePicture() has been called.

Note

This class has Google Play services vision APIs dependency. Hence application needs to set up project with the Google Play services vision SDK. Recommended minimum version is com.google.android.gms:play-services-vision:10.0.1. The device should have only stable version of the google play services. All the dependencies will be downloaded at the installation time in order to run the detection. But if that download has not yet completed when your app starts, then the detector will not detect any faces (at least initially). This could happen if the user is not online, if the user lacks sufficient storage space on their device, or if the download is otherwise delayed (e.g., due to a slow network). SelfieCaptureExperience will render the same message on ImageCaptureView.

The detector will automatically become operational once the dependencies have been successfully downloaded on the device.

Constructor & Destructor Documentation

SelfieCaptureExperience

(

ImageCaptureView

view

)

Constructs an experience on a given ImageCaptureView.

KmcRuntimeException will be thrown, if Google Play Services is not installed, up-to-date, or enabled.

Parameters

view	The ImageCaptureView this will be drawn onto

Exceptions

KmcRuntimeException

SelfieCaptureExperience	(	ImageCaptureView	view,
		SelfieCaptureExperienceCriteriaHolder	criteria
	)

Constructs an experience on a given ImageCaptureView with specific SelfieCaptureExperienceCriteriaHolder

KmcRuntimeException will be thrown, if Google Play Services is not installed, up-to-date, or enabled.

Parameters

view	The ImageCaptureView this will be drawn onto
criteria	The criteria used to determine if a photo should be taken

Exceptions

KmcRuntimeException

Member Function Documentation

void setCaptureCriteria

(

SelfieCaptureExperienceCriteriaHolder

criteria

)

Calling this method will cause all of the capture related parameters to be configured

Parameters

criteria

The criteria used to determine if a photo should be taken

See also

SelfieCaptureExperienceCriteriaHolder

---

The documentation for this class was generated from the following file:

• SelfieCaptureExperience.java