1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>SetAutoWhiteBalance</title>
8  </head>
9  <body>
10<h1><CODE>nn::camera::CTR::SetAutoWhiteBalance</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> SetAutoWhiteBalance(
15<a href="../../../nn/camera/CTR/CameraSelect.html">CameraSelect</a> select,
16bool on
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>select</th>
33<td>Specifies which camera to change settings for.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>on</th>
38<td>Specify <CODE>true</CODE> to enable or <CODE>false</CODE> to disable.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>ResultSuccess</CODE></th>
52<td>Process was successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultIsSleeping</CODE></th>
56<td>Unusable because the system is closed.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultFatalError</CODE></th>
60<td>There may be something physically wrong with the camera.</td>
61        </tr>
62      </table> </div>
63<h2>Description</h2>
64    <div class="section">
65<p>Enables/disables automatic white balance.</p><P>
66If the camera's white balance is set to &quot;automatic&quot; and <CODE>WHITE_BALANCE_NORMAL</CODE>, this function enables or disables automatic white balancing. When the automatic adjustment feature is disabled, the white balance setting is locked to its value at that time. If the setting is not <CODE>WHITE_BALANCE_NORMAL</CODE>, this function fails.
67            </P><P>
68A camera's exposure value is unstable immediately after the camera is started with the <CODE>Activate</CODE> function.
69            </P><P>
70Calling the <CODE>SetWhiteBalance</CODE> function resets the value set by this function and enables automatic white balancing.
71            </P><P>
72The default value is <CODE>true</CODE> for all cameras.
73</P><p>Note that this function may block for an extended period if a camera is restarting.</p></div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2010/09/24</dt>
78<dd>Added explanation about disabling the automatic adjustment feature.
79        </dd>
80        <dt>2010/07/17</dt>
81<dd>Added explanation about operation during restart.
82        </dd>
83        <dt>2010/07/14</dt>
84<dd>Deleted related text following deletion of <CODE>SynchronizeWhiteBalance</CODE> function.
85        </dd>
86        <dt>2010/06/18</dt>
87<dd>Added information about this function's relationship with the <CODE>SynchronizeWhiteBalance</CODE> function.<br />
88        </dd>
89        <dt>2010/04/14</dt>
90<dd>Added a description of the default values.<br />
91        </dd>
92        <dt>2010/04/09</dt>
93<dd>Added description text.<br />
94        </dd>
95        <dt>2010/02/02</dt>
96<dd>Initial version.<br />
97        </dd>
98      </dl>
99    </div>
100  <hr><p>CONFIDENTIAL</p></body>
101</html>