Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_get_zoom_ratio_from_zoom_level()

Updated: October 28, 2024

Retrieves the zoom ratio corresponding to a given zoom level

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_get_zoom_ratio_from_zoom_level(camera_handle_t handle,
                                                     uint32_t zoom_level,
                                                     double *zoom_ratio)

Arguments:

handle
The handle returned by a call to the camera_open() function.
zoom_level
The zoom level to retrieve a corresponding zoom ratio for.
zoom_ratio
A pointer to a double value which will be set to the magnification at the given zoom level.

Library:

libcamapi

Description:

Use this function to retrieve the zoom ratio associated with a given zoom level. The zoom ratio describes the amount of magnification applied to the scene. For example: A zoom ratio of 1.0 indicates that no magnification is applied to the scene. A zoom ratio of 2.0 indicates that 1/2 of the width and 1/2 of the height of the scene is pictured when compared to the 1.0 zoom ratio.

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