camera_get_photovf_frame_types()

(Deprecated) Retrieve the photo viewfinder frame types available on the camera.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_get_photovf_frame_types(camera_handle_t handle,                 
                                              int numasked,                 
                                              int *numsupported,                 
                                              camera_frametype_t *types)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

numasked

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

numsupported

The returned number of photo viewfinder frame types supported by the specified camera.

types

A pointer to a camera_frametype_t array. The array is updated with the photo viewfinder frame types supported by the camera. Ensure that you allocate an array with the same number of elements as specified in the numasked argument.

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_frametypes() function. For more information about new and deprecated viewfinder functionality, see Viewfinder modes.

Use this function to retrieve the photo viewfinder frame types supported by the current camera. The returned formats can be applied to CAMERA_IMGPROP_FORMAT using the camera_set_photovf_property() function.

Ensure that the types 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 0 or the types argument to NULL. When the function is invoked in this presizing mode, the maximum array size 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-06-24



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

comments powered by Disqus