Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_video_frame_types()

Updated: April 19, 2023

Retrieve the video output frame types available on the camera

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_video_frame_types(camera_handle_t handle,
                                            int numasked,
                                            int *numsupported,
                                            camera_frametype_t *types)

Arguments:

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

Library:

libcamapi

Description:

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

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