com.otaliastudios.cameraview

Enum Flash

java.lang.Object

java.lang.Enum<Flash>

com.otaliastudios.cameraview.Flash

All Implemented Interfaces:

Control, java.io.Serializable, java.lang.Comparable<Flash>

public enum Flash
extends java.lang.Enum<Flash>
implements Control

Flash value indicates the flash mode to be used.

See Also:

CameraView.setFlash(Flash)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Flash mode is chosen by the camera.
OFF Flash is always off.
ON Flash will be on when capturing.
TORCH Flash is always on, working as a torch.

Method Summary

Modifier and Type	Method and Description
static Flash	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Flash[]	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

OFF

public static final Flash OFF

Flash is always off.

ON

public static final Flash ON

Flash will be on when capturing. This is not guaranteed to be supported.

See Also:

CameraOptions.getSupportedFlash()

AUTO

public static final Flash AUTO

Flash mode is chosen by the camera. This is not guaranteed to be supported.

See Also:

CameraOptions.getSupportedFlash()

TORCH

public static final Flash TORCH

Flash is always on, working as a torch. This is not guaranteed to be supported.

See Also:

CameraOptions.getSupportedFlash()

Method Detail

values

public static Flash[] 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 (Flash c : Flash.values())
    System.out.println(c);

Returns:

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

valueOf

public static Flash valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null