Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_get_focus_modes()

Updated: April 19, 2023

Retrieve the focus modes available on the camera

Synopsis:

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

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 specify 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 will be updated with the focus modes supported by the camera. Ensure that you allocate an array with numasked elements.

Library:

libcamapi

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 elements 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. The function then returns, in the numsupported argument, the maximum array size required. You can then allocate an array of this size and invoke the function again with numasked set to that previous numsupported value.

Returns:

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

Parent topic: camera_3a.h