camera_config_flash()

Configure the flash mode for the camera.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_config_flash(camera_handle_t handle,                 
                                   camera_flashmode_t mode)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

mode

The desired flash mode to apply.

Library:

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

Description:

Only call this function if the CAMERA_FEATURE_FLASH feature is available. You can determine whether this feature is available by calling the camera_can_feature() function. You specify the flash mode to set using the mode argument.

The viewfinder must be running before using this function.

Returns:

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