Focus & Zoom Methods

You are viewing a history document page of DCE v1.0.3.

setAutoFocusPosition

Set the position that you want to auto focus at. This setting will replace the default focus value and always focus on the set point.

setAutoFocusPosition(float, float)

Parameters

X: A float value that stands for the X coordinate of the focus position.
Y: A float value that stands for the Y coordinate of the focus position.

Code Snippet

Java:

mCameraEnhancer.setAutoFocusPosition(0.5f,0.6f);

Kotlin:

mCameraEnhancer!!.setAutoFocusPosition(0.5f,0.6f)

setManualFocusPosition

Set the manual focus position. This position only takes effect once when this API is called.

setAutoFocusPosition(int, int)

Parameters

X: The int pixel value that stands for the X coordinate of the focus position.
Y: The int pixel value that stands for the Y coordinate of the focus position.

Code Snippet

Java:

//The focus position will be 200 pixel from left and 300 pixel from top.
mCameraEnhancer.setManualFocusPosition(200, 300);

Kotlin:

mCameraEnhancer!!.setManualFocusPosition(200,300)

setFocalLength

Set the focal length (float). The range of focal length is from 0 to 10. The value is a precentage. If user sets setFocalLength(5); it means the focal length will be 50% of the maxium focal length of the camera. Please note, If this API is called to set a focal length, the focal length will be fixed and all other auto focus mode will be disabled. To quit this fixed focal length mode, please set the focal length into -1.

setFocalLength(float)

Parameters

float: A float value between 0 to 10 that stands for the focal length. You can input -1 to quit the fixed focal length mode.

Code Snippet

Java:

mCameraEnhancer.setFocalLength(8.5);

Kotlin:

mCameraEnhancer!!.setFocalLength(8.5)

To quit:

Java:

mCameraEnhancer.setFocalLength(-1);

Kotlin:

mCameraEnhancer!!.setFocalLength(-1)

enableDCEAutoFocus

This API is designed to turn on DCE auto focus mode which is specially designed and is separate from the systems default auto focus mode. DCE auto focus and the default auto focus can work together at the same time without any conflict. The above focus settings are also available for controlling system default auto focus.

enableDCEAutoFocus(boolean)

Parameters

true: Enable the DCE auto focus.
false: Disable the DCE auto focus.

Code Snippet

Java:

mCameraEnhancer.enableDCEAutoFocus(true);

Kotlin:

mCameraEnhancer!!.enableDCEAutoFocus(true)

getEnabledDCEAutoFocusStatus

Get the status (on/off) of DCE autofocus mode:

getEnabledDCEAutoFocusStatus()

Return Value

true: The DCE auto focus is enabled.
false: The DCE auto focus is disabled.

Code Snippet

Java:

boolean x = mCameraEnhancer.getEnabledDCEAutoFocusStatus();

Kotlin:

var x:boolean? = mCameraEnhancer!!.enabledDCEAutoFocusStatus

enableDefaultAutoFocus

This API is designed for controlling the system default autofocus.

enableDefaultAutoFocus(boolean)

Parameters

true: Enable the default auto focus.
false: Disable the default auto focus.

Code Snippet

Java:

mCameraEnhancer.enableDefaultAutoFocus(false);

Kotlin:

mCameraEnhancer!!.enableDefaultAutoFocus(false)

getEnabledDefaultAutoFocusStatus

To get status (on/off) of Default autofocus mode:

getEnabledDefaultAutoFocusStatus()

Return Value

true: The default auto focus is enabled.
false: The default auto focus is disabled.

Code Snippet

Java:

boolean x = mCameraEnhancer.getEnabledDefaultAutoFocusStatus();

Kotlin:

var x:boolean? = mCameraEnhancer!!.enabledDefaultAutoFocusStatus

enableRegularAutoFocus

Regular auto focus is an advanced setting that enables the camera to auto focus every 3 seconds. It is contained in DCE auto focus. When DCE auto focus is enabled, regular auto focus is enabled as well. To turn off regular auto focus mode:

enableRegularAutoFocus(boolean)

Parameters

true: Enable the regular auto focus.
false: Disable the regular auto focus.

Code Snippet

Java:

mCameraEnhancer.enableRegularAutoFocus(false);

Kotlin:

mCameraEnhancer!!.enableRegularAutoFocus(false)

getEnabledRegularAutoFocusStatus

Get status (on/off) of regular autofocus mode:

getEnabledRegularAutoFocusStatus()

Parameters

true: The regular auto focus is enabled.
false: The regular auto focus is disabled.

Code Snippet

Java:

boolean x = mCameraEnhancer.getEnabledRegularAutoFocusStatus();

Kotlin:

var x:boolean? = mCameraEnhancer!!.enabledRegularAutoFocusStatus

setRegularAutoFocusParam

You can set the focus interval time and focus terminate time in regular auto focus mode. Please use setregularautofocusparam to make these settings.

setRegularAutoFocusParam(int, int)

Parameters

int: Focus interval, Default value is 3000 (millisecond), which means the camera will auto focus for every 3000 milliseconds.
int: Terminate time, Default value is 500 (millisecond), which means the camera will not focus once again within 500 milliseconds.

Code Snippet

Java:

// Set focus interval = 3000 and focus terminate time = 500.
mCameraEnhancer.setRegularAutoFocusParam(3000, 500);

Kotlin:

mCameraEnhancer!!.setRegularAutoFocusParam(3000,500)

enableAutoFocusOnSharpnessChange

This API is another advanced setting that enabled the camera to autofocus when sharpness change is detected between contiguous frames. The same with regular autofocus, this focus mode is also enabled by default when DCE autofocus is enabled. To turn off camera autofocus when sharpness changes:

enableAutoFocusOnSharpnessChange(boolean)

Parameters

true: Enable the sharpness auto focus.
false: Disable the sharpness auto focus.

Code Snippet

Java:

mCameraEnhancer.enableAutoFocusOnSharpnessChange(false);

Kotlin:

mCameraEnhancer!!.enableAutoFocusOnSharpnessChange(false)

getEnabledAutoFocusOnSharpnessChangeStatus

Get the status (on/off) of the sharpness autofocus mode:

getEnabledAutoFocusOnSharpnessChangeStatus()

Return Value

true: The sharpness auto focus is enabled.
false: The sharpness auto focus is disabled.

Code Snippet

Java:

boolean x = mCameraEnhancer.getEnabledAutoFocusOnSharpnessChangeStatus();

Kotlin:

var x:boolean? = mCameraEnhancer!!.enabledAutoFocusOnSharpnessChangeStatus

enableAutoZoom

This auto zoom mode is specially designed for Dynamsoft Barcode Reader users. The barcode reader can always get a localization result even if it fails on decoding. DCE auto zoom will enable the camera to approach the localized barcode area if the barcode reader got a localization result but failed to get a barcode result.

enableAutoZoom(boolean)

Parameters

true: Enable the auto zoom.
false: Disable the auto zoom.

Code Snippet

Java:

mCameraEnhancer.enableAutoZoom(true);

Kotlin:

mCameraEnhancer!!.enableAutoZoom(true)

getEnabledAutoZoomStatus

Get the status (on/off) of autozoom mode:

getEnabledAutoZoomStatus()

Return Value

true: The auto zoom is enabled.
false: The auto zoom is disabled.

Code Snippet

Java:

boolean x = mCameraEnhancer.getEnabledAutoZoomStatus();

Kotlin:

var x:boolean? = mCameraEnhancer!!.enabledAutoZoomStatus

setZoomFactor

Set the zoom factor (float).

setZoomFactor(float)

Parameters

float: A float value that stands for the zoom factor.

Code Snippet

Java:

mCameraEnhancer.setZoomFactor(1.5f);

Kotlin:

mCameraEnhancer!!.setZoomFactor(1.5f)