Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_get_supported_manual_aperture_values()

Retrieve the supported manual aperture values (f-numbers)

Synopsis:

#include <camera/camera_3a.h>
camera_error_t camera_get_supported_manual_aperture_values(camera_handle_t handle,
                                                           unsigned numasked,
                                                           unsigned *numsupported,
                                                           double *aperturevalues,
                                                           bool *maxmin)

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of manual aperture values to return in the aperturevalues array. You can specify a value of zero to determine the number of supported manual aperture values.
numsupported
A pointer to an integer that will be updated with the number of supported manual aperture values.
aperturevalues
A pointer to a double array. The array is updated with the manual aperture values supported. Ensure that you allocate an array with the same number of elements as the numasked argument. If the maxmin argument returns true, then the first value returned in the aperturevalues array is the maximum supported manual aperture value, and the second value returned is the minimum supported manual aperture value.
maxmin
A pointer to a bool value that specifies how to interpret the aperturevalues argument. This argument is set to true if the values are to be interpreted as a maximum and minimum value; otherwise, it's set to false to indicate that the values describe only the discrete manual aperture values that are supported.

Library:

libcamapi

Description:

Use this function to retrieve the set of supported manual aperture values (f-numbers) for the camera.

Ensure that the aperturevalues argument points to an array which has at least numasked elements allocated. To determine an appropriate size for this array, you can invoke this function in presizing mode by setting the numasked argument to 0 or the aperturevalues argument to NULL. When the function is invoked in this presizing mode, the maximum array size required is returned in the numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with the numasked argument set to the value returned previously in the numsupported argument.

The values that you retrieve using this function can be set using the camera_set_manual_aperture() function.

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