Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_supported_vf_frame_types()

Updated: April 19, 2023

Retrieve the viewfinder frame types available on the camera

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_supported_vf_frame_types(camera_handle_t handle,
                                                   uint32_t numasked,
                                                   uint32_t *numsupported,
                                                   camera_frametype_t *frametypes)

Arguments:

handle
The handle returned by a call to the camera_open() function.
numasked
The requested number of viewfinder frame types to return in the frametypes array.
numsupported
The returned number of viewfinder frame types supported by the specified camera.
frametypes
A pointer to a camera_frametype_t array. The array is updated with the viewfinder frame types supported by the camera.

Library:

libcamapi

Description:

Use this function to retrieve the viewfinder frame types supported by the current camera. The returned formats can be applied to CAMERA_IMGPROP_FORMAT using the camera_set_vf_property() function.

Ensure that the frametypes 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 frametypes 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 frametypes, 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