com.wikitude.common.camera

Enum CameraSettings.CameraFocusMode

java.lang.Object

java.lang.Enum<CameraSettings.CameraFocusMode>

com.wikitude.common.camera.CameraSettings.CameraFocusMode

All Implemented Interfaces:

Serializable, Comparable<CameraSettings.CameraFocusMode>

Enclosing class:

CameraSettings

public static enum CameraSettings.CameraFocusMode
extends Enum<CameraSettings.CameraFocusMode>

The CameraFocusMode type can be used to define which focus mode should be used by the camera.

To use a CameraFocusMode from the start of the Wikitude SDK it can be set in the StartupConfiguration by using StartupConfiguration.setCameraFocusMode(CameraFocusMode.ONCE/CONTINUOUS/OFF).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUOUS The camera will continuously try to find the best focus.
OFF OFF Has different meanings based on which camera API is used.
ONCE The camera focuses once automatically and then stays at this focus until the camera is stopped or a new focus mode is set

Method Summary

Modifier and Type	Method and Description
static CameraSettings.CameraFocusMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CameraSettings.CameraFocusMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONCE

public static final CameraSettings.CameraFocusMode ONCE

The camera focuses once automatically and then stays at this focus until the camera is stopped or a new focus mode is set

CONTINUOUS

public static final CameraSettings.CameraFocusMode CONTINUOUS

The camera will continuously try to find the best focus.

OFF

public static final CameraSettings.CameraFocusMode OFF

OFF Has different meanings based on which camera API is used. For the deprecated camera api the camera will fix the focus, which is usually at hyperfocal distance. For the camera2 API the auto-focus routine does not control the lens, the focus distance can be controlled on devices which support manual focus. If manual focus is not supported or no focus distance is set it will be set to infinity focus.

Method Detail

values

public static CameraSettings.CameraFocusMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CameraSettings.CameraFocusMode c : CameraSettings.CameraFocusMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CameraSettings.CameraFocusMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null