camera_get_photo_output

Retrieve the supported photo output frame rates.

Synopsis:

#include <camera/camera_api.h>

camera_error_t camera_get_photo_output_framerates(camera_handle_t handle,                 
                                                  camera_frametype_t frametype,                 
                                                  int numasked,                 
                                                  int *numsupported,                 
                                                  double *rates,                 
                                                  bool *maxmin)

Since:

BlackBerry 10.2.0

Arguments:

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

frametype: The frametype for which supported framerates are being requested.

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 photo output 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 output 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 continuous range of framerates between a maximum and minimum, or set to false if the rates returned describe only the discrete frame rates 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 photo output frame rates.

Note: The photo output frame rate is used in burst capture modes and deprecates the previous method of using CAMERA_IMGPROP_BURSTDIVISOR as of BlackBerry 10.2.0.

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.

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

Returns: