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 LED for the duration of a single blink.

The outer-camera LED is configured to be lit when the outer camera is active. By calling this function from that state, the outer-camera LED is turned off for the duration of a single blink, as configured by the CAMERA_SetLED function. Note that this function consequently 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 that the process is thus blocked for 6 ms inside the function when the synchronous version is called.

When the asynchronous version is called, the process returns immediately without being blocked, but note that you cannot use other CAMERA functions during the 6 ms after the function is called.

If you are uneasy with the aforementioned restrictions, use a separate CAMERA_SetLED call to extinguish the LED.

See Also

CAMERA_SetLED*

Revision History

2009/04/15 Added mention of restrictions regarding call of this function.
2008/09/09 Initial version.


CONFIDENTIAL