camera_get_video_vf_framerates()

Retrieve the supported photo viewfinder frame rates.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_get_video_vf_framerates(camera_handle_t handle, int numasked, int *numsupported, double *rates, bool *maxmin)

Arguments:

handle

The handle returned by a call to the camera_open() function.

numasked

The requested number of frame rates to return in the rates array. You can specify a value of zero to determine the number of supported frame rates.

numsupported

The pointer to an integer that is populated with the number of supported frame rates.

rates

A pointer to a double array. The array is updated with the photo viewfinder frame rates supported. Ensure that you allocate an array with the same number of elements as the numasked argument. If the maxmin flag returns true, then the first value returned in the rates array is the maximum supported frame rate, and the second value returned is the minimum supported frame rate.

maxmin

A pointer to a bool value which is set to true if the rates returned should be interpreted as a maximum and minimal rates, or set to false if the rates returned describe only the discrete frame rates supported.

handle

The handle returned by a call to the camera_open() function.

numasked

The requested number of frame rates to return in the rates array. You can specify a value of zero to determine the number of supported frame rates.

numsupported

The pointer to an integer that is populated with the number of supported frame rates.

rates

A pointer to a double array. The array is updated with the photo viewfinder frame rates supported. Ensure that you allocate an array with the same number of elements as the numasked argument. If the maxmin argument returns true, then the first value returned in the rates array is the maximum supported frame rate, and the second value returned is the minimum supported frame rate.

maxmin

A pointer to a bool value which is set to true if the rates returned should be interpreted as a max and min rate, or set to false if the rates returned describe only the discrete frame rates supported.

Library:

libcamapi

Description:

Retrieve the supported video viewfinder frame rates.

Use this function to retrieve the set of supported photo viewfinder frame rates.

When calling this function, ensure that the rates argument points to an array which has at least the number of elements allocated as specified in the numasked argument. To determine an appropriate size for this array, you can invoke this function in presizing-mode by setting the numasked argument to 0 or rates argument set to NULL. When the function is invoked in this presizing-mode, the maximum array size required is returned in numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with numasked argument set to the value returned previously in the numsupported argument.

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

When calling this function, ensure that the rates argument points to an array which has at least the number of elements allocated as specified in the numasked argument. To determine an appropriate size for this array, you can invoke this function in presizing-mode by setting the numasked argument to 0 or rates argument set to NULL. When the function is invoked in this presizing-mode, the maximum array size required is returned in numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with numasked argument set to the value returned previously in the numsupported argument.

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

Returns:

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

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