camera_set_manual_white_balance()

Change the manual white balance color temperature.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_set_manual_white_balance(camera_handle_t handle,                 
                                               unsigned whitebalancevalue)

Since:

BlackBerry 10.2.0

Arguments:

handle

The handle returned by a call to the camera_open() function.

whitebalancevalue

The manual white balance color temperature (in Kelvin). Use the camera_get_supported_manual_white_balance_values() function to determine the white balance color temperature values that can be set.

Library:

libcamapi (For the qcc command, use the -l camapi option to link against this library)

Description:

Use this function to set the white balance color temperature. The white balance alters the color for the image. The value that you set using this function is only applied when the white balance mode has been set to manual white balance using the camera_set_whitebalance_mode() function with the CAMERA_WHITEBALANCEMODE_MANUAL property.

For more information regarding when these manual settings take effect, see Manual camera settings and camera_whitebalancemode_t.

The viewfinder must be running before calling this function.

Returns:

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