CAMERA_SwitchOffLED*

Syntax

#include <twl/camera.h>

CAMERAResult CAMERA_SwitchOffLED(void);
CAMERAResult CAMERA_SwitchOffLEDAsync(CAMERACallback callback, void *arg);

Arguments

callback Function that is called when asynchronous processing has completed.
arg Arguments when the callback function is invoked.

Return Values

Returns CAMERA_RESULT_SUCCESS if configuration was successful.

Description

Turns off the outer camera indicator LED for the duration of a single blink (approximately 0.8 seconds).

The camera indicator LED is configured to light up when the outer camera is activated. If you call this function from that state, the camera indicator LED is turned off for the duration of a single blink, as configured by the CAMERA_SetLED function. Note that the function therefore fails if the outer camera is not active.

This function behaves the same as calling CAMERA_SetLED(TRUE), waiting 6 ms, and then calling CAMERA_SetLED(FALSE).

Note: For this reason, the synchronous version of this function blocks execution internally for 6 ms after it is called.
When the asynchronous version is called, execution returns immediately without being blocked, but note that you cannot use other CAMERA functions during the 6 ms after calling the function.

If these restrictions are confusing, you can use a separate CAMERA_SetLED call to turn off the LED.

See Also

CAMERA_SetLED*

Revision History

2009/06/08 Explained the time it takes to blink.
2009/04/15 Added text about the restrictions on calling this function.
2008/09/09 Initial version


CONFIDENTIAL