Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_supported_vf_modes()

Updated: April 19, 2023

Retrieve the list of supported viewfinder modes

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_supported_vf_modes(camera_handle_t handle,
                                             uint32_t numasked,
                                             uint32_t *numsupported,
                                             camera_vfmode_t *modes)

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of viewfinder modes to return in the modes array.
numsupported
A pointer to an integer that is updated with the number of viewfinder modes supported.
modes
A pointer to a camera_vfmode_t array. The array is updated with the list of viewfinder modes supported.

Library:

libcamapi

Description:

Use this function to determine which viewfinder modes can be selected using the camera_set_vf_mode() function. For more information about about viewfinder modes, see “Viewfinder Mode”.

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, store its address in modes, 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_api.h