agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r2.jar)

Enum CameraSnapshotFileFormat

java.lang.Object

java.lang.Enum<CameraSnapshotFileFormat>

agi.foundation.graphics.advanced.CameraSnapshotFileFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CameraSnapshotFileFormat>

public enum CameraSnapshotFileFormat
extends Enum<CameraSnapshotFileFormat>
implements Enumeration

When using CameraSnapshot or CameraVideoRecording to save a snapshot to a file, this specifies the file format.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BMP BMP file format
JPEG JPEG file format
PNG PNG file format
TIFF TIFF file format

Method Summary

Modifier and Type	Method and Description
static CameraSnapshotFileFormat	getDefault() Get the enum constant that is considered to be the default.
static CameraSnapshotFileFormat	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CameraSnapshotFileFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static CameraSnapshotFileFormat[]	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

BMP

public static final CameraSnapshotFileFormat BMP

BMP file format

TIFF

public static final CameraSnapshotFileFormat TIFF

TIFF file format

JPEG

public static final CameraSnapshotFileFormat JPEG

JPEG file format

PNG

public static final CameraSnapshotFileFormat PNG

PNG file format

Method Detail

values

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

Returns:

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

valueOf

public static CameraSnapshotFileFormat 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CameraSnapshotFileFormat getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CameraSnapshotFileFormat getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.