camera_config_focus

Configure the focus assist light.

Synopsis:

#include <camera/camera_api.h>

camera_error_t camera_config_focus_assist(camera_handle_t handle,                 
                                          bool enable)

Since:

BlackBerry 10.0.0

Arguments:

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

enable: A flag that indicates whether or not to enable focus assist. To enable, set to true. To disable, set to false.

Library:

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

Description:

The focus assist feature allows for improved focus performance in low-light situations. When focus assist is enabled, the light will be turned on when the camera is running a single autofocus cycle and a low-light condition is detected. A single autofocus cycle can occur in either of the following situations:

the user invoked camera_set_focus_mode() explicitly to trigger a single autofocus cycle.
the user triggered a capture using camera_take_photo() while in a continuous autofocus mode and while a low-light condition is detected.

Only call this function if the CAMERA_FEATURE_FOCUSASSIST feature is available. You can determine whether this feature is available by calling the camera_can_feature() function.

The viewfinder must be running before using this function.

Returns: