org.firstinspires.ftc.robotcore.external.hardware.camera

Interface CameraCharacteristics

public interface CameraCharacteristics

THIS INTERFACE IS EXPERIMENTAL. Its form and function may change in whole or in part before being finalized for production use. Caveat emptor. Metadata regarding the configuration of video streams that a camera might produce. Modelled after android.hardware.camera2.params.StreamConfigurationMap, though significantly simplified here.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CameraCharacteristics.CameraMode

Method Summary

Modifier and Type	Method and Description
java.util.List<CameraCharacteristics.CameraMode>	getAllCameraModes() Returns all the combinatorial format, size, and fps camera modes supported.
int[]	getAndroidFormats() Get the image format output formats in this camera
Size	getDefaultSize(int androidFormat) Gets the device-recommended optimum size for the indicated format
int	getMaxFramesPerSecond(int androidFormat, Size size) Returns the maximum fps rate supported for the given format.
long	getMinFrameDuration(int androidFormat, Size size) Get the minimum frame duration for the format/size combination (in nanoseconds).
Size[]	getSizes(int androidFormat) Get a list of sizes compatible with the requested image format.

Method Detail

getAndroidFormats

int[] getAndroidFormats()

Get the image format output formats in this camera

All image formats returned by this function will be defined in either ImageFormat or in PixelFormat (and there is no possibility of collision).

Returns:

an array of integer format. The formats are as identified by ImageFormat and PixelFormat.

See Also:

ImageFormat, PixelFormat

getSizes

Size[] getSizes(int androidFormat)

Get a list of sizes compatible with the requested image format.

The format should be a supported format (one of the formats returned by getAndroidFormats()).

Parameters:

androidFormat - an image format from ImageFormat or PixelFormat

Returns:

an array of supported sizes, or null if the format is not a supported output

See Also:

ImageFormat, PixelFormat, getAndroidFormats()

getDefaultSize

Size getDefaultSize(int androidFormat)

Gets the device-recommended optimum size for the indicated format

getMinFrameDuration

long getMinFrameDuration(int androidFormat,
                         Size size)

Get the minimum frame duration for the format/size combination (in nanoseconds).

format should be one of the ones returned by getAndroidFormats().

size should be one of the ones returned by getSizes(int).

Parameters:

androidFormat - an image format from ImageFormat or PixelFormat

size - an output-compatible size

Returns:

a minimum frame duration > 0 in nanoseconds, or 0 if the minimum frame duration is not available.

Throws:

java.lang.IllegalArgumentException - if format or size was not supported

java.lang.NullPointerException - if size was null

See Also:

ImageFormat, PixelFormat

getMaxFramesPerSecond

int getMaxFramesPerSecond(int androidFormat,
                          Size size)

Returns the maximum fps rate supported for the given format.

Returns:

the maximum fps rate supported for the given format.

getAllCameraModes

java.util.List<CameraCharacteristics.CameraMode> getAllCameraModes()

Returns all the combinatorial format, size, and fps camera modes supported.

Returns:

all the combinatorial format, size, and fps camera modes supported