camera_get_photo_vf_framerates()

(Deprecated) Retrieve the supported photo viewfinder frame rates

Synopsis:

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

Since:

BlackBerry 10.0.0

Arguments:

handle

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

burst

Whether the frame rates should be valid for burst viewfinder mode. To enable burst viewfinder mode, call the camera_set_photovf_property() function and set the CAMERA_IMGPROP_BURSTMODE property to 1.

numasked

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

numsupported

A pointer to an int that will be updated with the number of supported photo viewfinder 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 will be set to true if the values returned should be interpreted as a maximum and a minimum value, or set to false if the values only describe the discrete photo viewfinder frame rates that are supported.

Library:

libcamapi (For the qcc command, use the -l camapi option to link against this library)

Description:

Deprecated:

As of CAMERA_API_VERSION 3 (BlackBerry 10.3.0). Instead, use the camera_get_supported_vf_framerates() function. For more information about new and deprecated viewfinder functionality, see Viewfinder modes.

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

Ensure that the rates argument points to an array which 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 to 0 or the rates argument to NULL. When the function is invoked in presizing mode, the maximum array size that is required is returned in the numsupported argument. You can then allocate an array of the appropriate size and invoke the function again with the numasked argument set to the value returned previously in the numsupported argument.

You can call the camera_set_photovf_property() function to set the CAMERA_IMGPROP_FRAMERATE property to one of the values retrieved using this function.

Returns:

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

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus