Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_set_manual_aperture()

Updated: April 19, 2023

Change the manual aperture value (f-number) on the camera

Synopsis:

#include <camera/camera_3a.h>
camera_error_t camera_set_manual_aperture(camera_handle_t handle,
                                          double aperturevalue)

Arguments:

handle
The handle returned by a call to the camera_open() function.
aperturevalue
The aperture value to set on the camera.

Library:

libcamapi

Description:

Use this function to set the manual aperture value. Setting a small f-number results in a reduced depth of field. Setting a large f-number results in an increased depth of field.

The value that you set using this function is only applied when the exposure mode has been set to allow manual aperture settings using camera_set_exposure_mode(). You can use the camera_get_supported_manual_aperture_values() function to determine the range of valid aperture values that you can use.

For more information regarding these manual settings, see the Manual camera settings section.

Returns:

CAMERA_EOK when the function successfully completes, otherwise another camera_error_t value that provides the reason that the call failed.

Parent topic: camera_3a.h