Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_specified_vf_resolutions()

Updated: October 28, 2024

Get the list of supported viewfinder resolutions for a given frame type

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_specified_vf_resolutions(camera_handle_t handle,
                                                   camera_frametype_t frametype,
                                                   uint32_t numasked,
                                                   uint32_t *numsupported,
                                                   camera_res_t *resolutions)

Arguments:

handle
The handle returned by a call to the camera_open() function.
frametype
The frame type for which to query the supported frame rates (see camera_frametype_t).
numasked
The requested number of viewfinder resolutions to return in the resolutions array.
numsupported
The returned number of viewfinder resolutions supported by the specified camera.
resolutions
A pointer to a camera_res_t array. The array is updated with the viewfinder resolutions supported by the camera.

Library:

libcamapi

Description:

After you use this function to retrieve the viewfinder resolutions that are supported by the camera, you can configure the viewfinder size using camera_set_vf_property().

Ensure that the resolutions argument points to an array that 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 resolutions 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 resolutions, 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