camera_enable_shutter_event()

Enable the shutter event.

Synopsis:

#include <camera/camera_api.h>
 
camera_error_t camera_enable_shutter_event(camera_handle_t handle,                 
                                           camera_eventkey_t *key,                 
                                           struct sigevent *event)

Since:

BlackBerry 10.0.0

Arguments:

handle

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

key

A pointer to a returned camera_eventkey_t value. This argument is required for subsequent function calls to identify the proper event.

event

A pointer to a struct sigevent. The struct sigevent must be initialized by the caller. This is the struct sigevent that will be delivered when the shutter activates.

Library:

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

Description:

Use this function to enable the shutter event. The shutter event is delivered when the shutter activates for image capture. There are no corresponding buffers to retrieve when the shutter event is delivered. The shutter event occurs at the same time that a the camera invokes your shutter_callback function registered when you started photo capture using camera_take_photo(), camera_take_burst(), or camera_start_burst().

Call this function when you are using the Camera API in event mode. For more information, see scope="peer">About event mode.

Use camera_disable_event() to disable an event when you no longer require shutter events to be delivered.

The Camera library does not automatically play audible shutter sounds when a picture is taken or a video is recorded. Camera applications must supply their own sound when a photo is captured or a video recording begins and ends. While you can choose to not have a shutter sound when taking a picture — you are responsible to ensure that the application adheres to the local laws of the regions in which you wish to distribute the application.

For example, it is illegal to mute or modify the shutter sound of a camera application in Japan and Korea. Ensure that you comply with the laws and regulations for the countries in which you distribute your application. For more information, see the BlackBerry World Vetting Criteria at https://appworld.blackberry.com/isvportal/home.do.

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