CAMERA_SetLED*

Syntax

#include <twl/camera.h>

CAMERAResult CAMERA_SetLED(BOOL isBlink);
CAMERAResult CAMERA_SetLEDAsync(BOOL isBlink, CAMERACallback callback, void *arg);

Arguments

isBlink Specify TRUE for blinking and FALSE otherwise.
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

Changes the outer-camera LED to blink or stay lit.


The outer camera LED lights up when the outer camera is activated. You can call this function in this state to switch the LED between blinking and a constantly lit state.
Note that this function consequently fails if the outer camera is not active.


Blinking starts from the unlit state, and the LED transitions to the constant-lit state only while lit. As a result, even if the outer-camera LED is set to blink and then immediately changed to stay lit, the LED invariably blinks once anyway.

Note
It takes longer for the process to return from CAMERA_SetLED(FALSE) if you act to switch the LED back to the stay-lit state within 6 ms of setting it to the blinking state.
To be specific, if the function with FALSE specified is called 3 ms after the call with TRUE has been returned, there will be (6-3 = 3) ms of extra time before the process returns from the call with FALSE.

See Also

CAMERA_I2CActivate*

Revision History

2009/04/15 Added a note about the blocking inside the function when FALSE is specified.
2008/05/23 Initial version.


CONFIDENTIAL