camera_set_vf_property()

Updated: April 19, 2023

Configure one or more settings of the viewfinder

Synopsis:

#include <camera/camera_api.h>
#define camera_set_vf_property(handle,
                               args...)

Arguments:

handle
The handle returned by a call to the camera_open() function.
args
A series of comma-delimited property-value pairs. For details on how to specify multiple property-value pairs, see the function description.

Library:

libcamapi

Description:

For the args argument, you can provide one or more property-value pairs using a camera_imgprop_t value for the name of each property and a pointer to the correct type, such as an int or double, for the value. The following properties can be used with this function:
Note:

There is no type-checking performed by the compiler. Therefore, you must ensure that the value you provide for each property-value pair matches the expected data type. Data type mismatches can result in undefined behavior and cause your application to crash.

You can specify multiple property-value pairs by delimiting them with a comma as follows:
 camera_set_vf_property( camera_handle,
                         CAMERA_IMGPROP_WIN_GROUPID, "mygroup",
                         CAMERA_IMGPROP_WIN_ID, "vfwindow",
                         CAMERA_IMGPROP_WIDTH, 720,
                         CAMERA_IMGPROP_HEIGHT, 1280,
                         CAMERA_IMGPROP_ROTATION, 270,
                         CAMERA_IMGPROP_FRAMERATE, (double)15.0 );
The following properties can't be changed while the viewfinder is running:

While the viewfinder is running, the CAMERA_IMGPROP_WIN_GROUPID can be changed only if the current value is an empty string.

The following properties can't be changed while a non-video viewfinder is running:

Returns:

CAMERA_EOK when the function successfully completes, otherwise another camera_error_t value that provides the reason that the call failed.