camera_config_videolight()

#include <camera/camera_api.h>
 

camera_error_t camera_config_videolight(camera_handle_t handle,                 
                                        camera_videolightmode_t mode)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

mode

The desired video-light 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_VIDEOLIGHT feature is available. You can determine whether this feature is available by calling the camera_can_feature() function.

The viewfinder does not need to be running in order to use this function. The video-light is turned off whenever the viewfinder starts or stops.

Please see also camera_get_videolight_level() to determine if sufficient power is available to operate the videolight.

Returns:

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