Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_get_supported_manual_white_balance_values()

Updated: April 19, 2023

Retrieve the supported manual white balance color temperature values

Synopsis:

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

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of white balance color temperature values to return in the whitebalancevalues array. You can specify a value of zero to determine the number of supported white balance color temperature values.
numsupported
A pointer to an integer that will be updated with the number of supported white balance color temperature values.
whitebalancevalues
A pointer to an unsigned array that will be updated with the manual white balance color temperature values that are supported. Ensure that you allocate an array with numasked elements. For details about the meaning of the values returned in this array, see the maxmin description.
maxmin
A pointer to a bool that will specify how to interpret the whitebalancevalues array. This argument will be true if the first of two values returned in the array is to be interpreted as the maximum supported white balance color temperature value and the second as the minimum supported value. It will be false if the values are to be interpreted as the discrete white balance color temperature values that are supported.

Library:

libcamapi

Description:

Use this function to retrieve the set of supported manual white balance color temperature values for the camera.

Ensure that the whitebalancevalues 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 whitebalancevalues argument to NULL. The function then returns, in the numsupported argument, the maximum array size required. You can then allocate an array of this size and invoke the function again with numasked set to that previous numsupported value.

The values that you retrieve using this function can be set using the camera_set_manual_white_balance() 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