Updated: April 19, 2023

Retrieve the supported hue values


#include <camera/camera_api.h>
camera_error_t camera_get_supported_hue(camera_handle_t handle,
                                        uint32_t numasked,
                                        uint32_t *numsupported,
                                        int32_t *values,
                                        bool *maxmin)


The handle returned by a call to the camera_open() function.
The requested number of hue values to return in the values array.
The returned number of hue values supported by the camera.
A pointer to an int32_t array that is updated with the hue values supported by the camera. If the maxmin flag returns true, the first value returned in the values array is the maximum supported hue value, and the second value is the minimum supported hue value.
A pointer to a bool value that specifies how to interpret the values array. If the maxmin flag is set to true, the array values represent a maximum and minimum value. If it's set to false, the array values describe the discrete hue values that are supported.




Use this function to retrieve the supported hue values. You can use the values returned by this function to configure the hue using the function camera_set_hue().

Ensure that the values argument points to an array that 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 values 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, store its address in values, and invoke the function again with numasked set to that previous numsupported value.


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