get_whitebalance_func_t

Updated: October 26, 2022

Retrieve the currently set white balance value

Synopsis:

#include <camera/external_camera_api.h>
typedef int(* get_whitebalance_func_t)(void *handle,
            unsigned *wbVal);

Arguments:

handle
The handle that's returned from calling the function open_external_camera_func_t.
wbVal
A pointer to an unsigned that will be set to the current white balance value (in Kelvin).

Library:

libcamapi

Description:

This function retrieves the current white balance value. The white balance value is a color temperature in Kelvin. This is either the determined auto white balance value or the one applied manually with set_whitebalance_func_t.

Note:

This function is optional. If it is not present, retrieving the current white balance will not be supported for this camera.

Returns:

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