camera_get_scene_modes()

Retrieve the scene modes available on the camera.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_get_scene_modes(camera_handle_t handle,                 
                                      int numasked,                 
                                      int *numsupported,                 
                                      camera_scenemode_t *modes)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

numasked

The requested number of scene modes to return in the modes array. You can specify a value of 0 to determine the number of scene modes supported by the camera.

numsupported

A pointer to an integer that will be updated with the number of scene modes supported by the camera.

modes

A pointer to a camera_scenemode_t array. The array is updated with the scene modes supported by the camera. Ensure that you allocate an array with the same number of elements as the numasked argument.

Library:

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

Description:

The API allows you to retrieve the scene modes available given the current platform and camera.

The list of supported scene modes may vary based on the currently configured viewfinder mode. However, if you are using the deprecated CAMERA_VFMODE_DEFAULT viewfinder mode, then you must start the viewfinder prior to retrieving supported scene modes. For more information about new and deprecated viewfinder functionality, see Viewfinder modes.

Ensure that the modes 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 modes 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-09-30



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

comments powered by Disqus