camera_get_supported_vf_framerates()

Retrieve the supported viewfinder frame rates.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_get_supported_vf_framerates(camera_handle_t handle,                 
                                                  camera_frametype_t frametype,                 
                                                  uint32_t numasked,                 
                                                  uint32_t *numsupported,                 
                                                  double *rates,                 
                                                  bool *maxmin)

Since:

BlackBerry 10.3.0

Arguments:

handle

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

frametype

The frame type to query supported frame rates for. Using CAMERA_FRAMETYPE_UNSPECIFIED will return the supported frame rates for the currently configured frame type.

numasked

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

numsupported

The returned number of frame rates supported by the specified camera.

rates

A pointer to a double array. The array is updated with the viewfinder frame rates supported by the camera. Ensure that you allocate an array with the same number of elements as specified in 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 frame rates that are supported.

Library:

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

Description:

Use this function to retrieve the set of supported viewfinder frame rates. You can use the values returned by this function to configure the viewfinder frame rate using camera_set_vf_property().

As of CAMERA_API_VERSION 3 (BlackBerry 10.3.0), this function deprecates camera_get_photo_vf_framerates() and camera_get_video_vf_framerates(). For more information about new and deprecated viewfinder functionality, see Viewfinder modes.

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.

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-09-29



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

comments powered by Disqus