1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>CAMERA_SetLED*</TITLE>
8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">CAMERA_SetLED* <IMG src="../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14  <DD>
15<CODE>#include &lt;twl/camera.h&gt;</CODE><BR> <BR> <CODE><A href="CAMERAResult.html">CAMERAResult</A> CAMERA_SetLED(BOOL isBlink);</CODE> <BR> <CODE><A href="CAMERAResult.html">CAMERAResult</A> CAMERA_SetLEDAsync(BOOL isBlink, <A href="CAMERACallback.html">CAMERACallback</A> callback, void *arg);</CODE>
16</DL>
17<H2>Arguments</H2>
18<TABLE border="1" width="100%">
19  <TBODY>
20    <TR>
21<TD width="13%"><EM><STRONG>isBlink</STRONG></EM></TD>
22<TD width="87%">Specify <CODE>TRUE</CODE> for blinking light and <CODE>FALSE</CODE> for steady light.</TD>
23    </TR>
24    <TR>
25<TD width="13%"><EM><STRONG>callback</STRONG></EM></TD>
26<TD width="87%">Function that is called when asynchronous processing has completed.</TD>
27    </TR>
28    <TR>
29<TD width="13%"><EM><STRONG>arg</STRONG></EM></TD>
30<TD width="87%">Arguments when the callback function is invoked.</TD>
31    </TR>
32  </TBODY>
33</TABLE>
34
35<H2>Return Values</H2>
36<P>
37Returns <CODE>CAMERA_RESULT_SUCCESS</CODE> if configuration was successful.
38</P>
39
40<H2>Description</H2>
41<P>
42Toggles the outer camera indicator LED between a blinking light and a steady light.<BR><BR> The camera indicator LED lights up with a steady light when the outer camera is activated. Once it has lit up, you can call this function to switch the LED between steady light and blinking light.<BR> Note that this function therefore fails if the outer camera is not active.<BR> <BR> The blinking light cycle starts from the unlit state, and the LED can transition from blinking light to steady light only from the lit state. As a result, even if the camera indicator LED is toggled to blinking light and then immediately toggled back to steady light, the LED invariably blinks once anyway.<br> When the LED blinks, the light is off and then on for a duration of approximately 0.8 seconds each. This varies by about 5% due to differences in individual cameras.<br> <br>If the LED is toggled to blink, and then, in less than 6 ms, toggled to steady light, there is no guarantee that the LED will blink once. Therefore, if you try to toggle the LED to blink and then back to steady light in less than 6 ms, the library ensures that at least 6 ms transpire. The elapsed time is measured from the call to <code>CAMERA_SetLED(TRUE)</code> to the return from the call to <code>CAMERA_SetLED(FALSE)</code>.<br>For example, if you call <code>CAMERA_SetLED(FALSE)</code> 3 ms after <code>CAMERA_SetLED(TRUE)</code> is called, it will take an additional (6-3 = 3) ms to return from <code>CAMERA_SetLED(FALSE)</code>.
43</P>
44
45<H2>See Also</H2>
46<P><CODE><A href="CAMERA_I2CActivate.html">CAMERA_I2CActivate*</A></CODE></P>
47<H2>Revision History</H2>
48<P>
492009/06/08 Explained the time it takes to blink, and the function's timing.<br> 2009/04/15 Explained that execution is blocked inside the function when FALSE has been specified.<br> 2008/05/23 Initial version
50</P>
51<hr><p>CONFIDENTIAL</p></body>
52</HTML>
53