camera_get_video_rotations()

Updated: April 19, 2023

Retrieve the configurable rotation angles supported for the encoded video produced by the camera

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_video_rotations(camera_handle_t handle,
                                          camera_frametype_t frametype,
                                          int numasked,
                                          int *numsupported,
                                          uint32_t *rotations,
                                          bool *nonsquare)

Arguments:

handle
The handle returned by a call to the camera_open() function.
frametype
The frame type to query supported rotations for. Using CAMERA_FRAMETYPE_UNSPECIFIED will return the supported rotations for the current frame type (see camera_frametype_t).
numasked
The requested number of video rotations to return in the rotations array.
numsupported
The returned number of video rotations supported by the specified camera.
rotations
A pointer to a uint32_t array that is updated with the video rotations supported by the camera.
nonsquare
The value updated to reflect whether the camera supports rotation of video output images that are not a square angle (i.e., multiples of 90 degrees).

Library:

libcamapi

Description:

Typical rotations are multiples of 90 degrees (called square rotations), such as 0, 90, 180, and 270. For cameras that support only square rotations, a value of false will be returned in the nonsquare argument.

The values that you retrieve using this function can be written to the CAMERA_IMGPROP_ROTATION property using the camera_set_video_property() function.

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