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

Interface FocusControl

All Superinterfaces:

CameraControl

All Known Implementing Classes:

CachingFocusControl, UvcApiFocusControl

public interface FocusControl
extends CameraControl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FocusControl.Mode

Field Summary

Fields

Modifier and Type	Field	Description
static double	unknownFocusLength

Method Summary

Modifier and Type	Method	Description
double	getFocusLength()	Get the camera's current focus length
double	getMaxFocusLength()	Get the maximum focal distance supported by the camera
double	getMinFocusLength()	Get the minimum focal distance supported by the camera
FocusControl.Mode	getMode()	Get the current focus mode of the camera
boolean	isFocusLengthSupported()	Check whether your camera supports control over focus
boolean	isModeSupported(FocusControl.Mode mode)	Check whether the camera supports a given focus mode
boolean	setFocusLength(double focusLength)	Set the camera's focus length.
boolean	setMode(FocusControl.Mode mode)	Set the focus mode of the camera

Field Detail

unknownFocusLength

static final double unknownFocusLength

See Also:

Constant Field Values

Method Detail

getMode

FocusControl.Mode getMode()

Get the current focus mode of the camera

Returns:

the current focus mode of the camera

setMode

boolean setMode(FocusControl.Mode mode)

Set the focus mode of the camera

Parameters:

mode - the mode to enter

Returns:

whether the operation was successful

isModeSupported

boolean isModeSupported(FocusControl.Mode mode)

Check whether the camera supports a given focus mode

Parameters:

mode - the mode in question

Returns:

whether the mode in question is supported

getMinFocusLength

double getMinFocusLength()

Get the minimum focal distance supported by the camera

Returns:

the minimum focal distance supported, or 0 if unavailable

getMaxFocusLength

double getMaxFocusLength()

Get the maximum focal distance supported by the camera

Returns:

the maximum focal distance supported, or 0 if unavailable

getFocusLength

double getFocusLength()

Get the camera's current focus length

Returns:

the camera's current focus length, or 0 if unavailable

setFocusLength

boolean setFocusLength(double focusLength)

Set the camera's focus length. Only works if you're in fixed mode.

Parameters:

focusLength - the desired focus length

Returns:

whether the operation succeeded

isFocusLengthSupported

boolean isFocusLengthSupported()

Check whether your camera supports control over focus

Returns:

whether your camera supports control over focus