camera_get_focus_modes()

Retrieve the focus modes available on the camera.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_get_focus_modes(camera_handle_t handle,                 
                                      int numasked,                 
                                      int *numsupported,                 
                                      camera_focusmode_t *modes)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

numasked

The requested number of focus modes to return in the modes array. You can use a value of 0 to determine the number of focus modes supported by the camera.

numsupported

The returned number of focus modes supported by the camera.

modes

A pointer to a camera_focusmode_t array. The array is updated with the focus modes supported by the camera. Ensure that you allocate an array with the same number of elements as specified in the numasked argument.

Library:

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

Description:

Use this function to retrieve the focus modes available on the current camera.

Ensure that the modes argument points to an array which has at least numasked element allocated. To determine an appropriate size for this array, you can invoke this function in presizing mode by setting the numasked argument to 0 or the modes argument to NULL. When the function is invoked in this presizing mode, the maximum array size required is returned in the numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with the numasked argument set to the value returned previously in the numsupported argument.

If you are using CAMERA_VFMODE_DEFAULT, or if your application is running on a device which uses CAMERA_API_VERSION 2 or lower (BlackBerry 10.2.1 or older), the viewfinder must be running prior to calling this function. If you are using a different viewfinder mode, then this function may be queried before starting the viewfinder.

Returns:

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