Camera Library Referencecamera_api.h Parent topic: camera_api.h

camera_set_vf_mode()

Updated: October 28, 2024

Set the viewfinder mode for a camera

Synopsis:

#include <camera/camera_api.h>
camera_error_t camera_set_vf_mode(camera_handle_t handle,
                                  camera_vfmode_t mode)

Arguments:

handle
The handle returned by a call to the camera_open() function.
mode
The desired viewfinder mode to set for the camera (see camera_vfmode_t).

Library:

libcamapi

Description:

A viewfinder mode must be selected prior to configuring and starting the viewfinder. Changing viewfinder modes is not allowed while the viewfinder is already running. The camera_get_supported_vf_modes() function should be called prior to setting the viewfinder mode to determine the supported viewfinder modes.

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