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>SetPackageParameterWithoutContext</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/camera/Overview.html">camera</a>::<a href="../../../nn/camera/CTR/Overview.html">CTR</a>::SetPackageParameterWithoutContext</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> SetPackageParameterWithoutContext(
15     const <a href="../../../nn/camera/CTR/PackageParameterCameraSelect/Overview.html">PackageParameterCameraSelect</a> & param
16);
17</pre>
18    </div>
19<h2>Parameters</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>param</th>
32<td>Parameter value to set.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<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 />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th><CODE>Result::IsSuccess</CODE></th>
46<td>Process was successful.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultIsSleeping</CODE></th>
50<td>This function is unusable because the system cover is closed.</td>
51        </tr>
52        <tr>
53<th><CODE>ResultFatalError</CODE></th>
54<td>There may be something physically wrong with the camera.</td>
55        </tr>
56      </table> </div>
57<h2>Description</h2>
58    <div class="section">
59<p>Batch-configures settings for a camera with no context specified.</p><p>
60Some members of the <SPAN class="argument">param</SPAN> argument are listed below. As explained in the PhotoMode reference, the settings that correspond to these members are usually configured by <CODE>photoMode</CODE>, but you can use this function to configure individual settings for these members that take priority over settings made by <CODE>photoMode</CODE>.
61<ul><li><span><CODE>nn::camera::CTR::exposure</CODE></span></li><li><span><CODE>nn::camera::CTR::whiteBalance</CODE></span></li><li><span><CODE>nn::camera::CTR::sharpness</CODE></span></li><li><span><CODE>nn::camera::CTR::contrast</CODE></span></li><li><span><CODE>nn::camera::CTR::autoExposureWindowStartX</CODE></span></li><li><span><CODE>nn::camera::CTR::autoExposureWindowStartY</CODE></span></li><li><span><CODE>nn::camera::CTR::autoExposureWindowWidth</CODE></span></li><li><span><CODE>nn::camera::CTR::autoExposureWindowHeight</CODE></span></li></ul>
62For example, the white balance setting for <CODE>PHOTO_MODE_LANDSCAPE</CODE> is <CODE>WHITE_BALANCE_DAYLIGHT</CODE>, but if <CODE>photoMode</CODE> is <CODE>PHOTO_MODE_LANDSCAPE</CODE> and you use this function to specify <CODE>WHITE_BALANCE_NORMAL</CODE> for <CODE>whiteBalance</CODE>, the white balance is set to <CODE>WHITE_BALANCE_NORMAL</CODE>.<BR />An argument for setting the gain exists for <CODE>photoMode</CODE>. This is something other functions cannot configure.
63            </p><p>
64The <SPAN class="argument">param</SPAN> argument member <CODE>autoWhiteBalanceOn</CODE> only has effect when <CODE>whiteBalance</CODE> is <CODE>WHITE_BALANCE_NORMAL</CODE>. It is ignored when <CODE>whiteBalance</CODE> is anything other than <CODE>WHITE_BALANCE_NORMAL</CODE>.
65            </p><p>
66The following member variables of the <SPAN class="argument">param</SPAN> argument can be set even when auto-exposure is disabled (when <CODE>autoExposureOn</CODE> is <CODE>false</CODE>): <CODE>autoExposureWindowStartX</CODE>, <CODE>autoExposureWindowStartY</CODE>, <CODE>autoExposureWindowWidth</CODE>, and <CODE>autoExposureWindowHeight</CODE>. You must therefore set these arguments to appropriate values regardless of whether auto-exposure is enabled or disabled.
67            </p><p>
68In the same way, you must set the following to appropriate values regardless of whether auto white balance is enabled or disabled: <CODE>autoWhiteBalanceWindowStartX</CODE>, <CODE>autoWhiteBalanceWindowStartY</CODE>, <CODE>autoWhiteBalanceWindowWidth</CODE>, and <CODE>autoWhiteBalanceWindowHeight</CODE>.
69            </p><P>
70If synchronization with the stereo camera's brightness was enabled via the <CODE><a href="../../../nn/camera/CTR/SetBrightnessSynchronization.html">nn::camera::CTR::SetBrightnessSynchronization</a></CODE> function, it will not be possible to specify any of the following. Function execution will fail.
71<ul><li>Specification of other than <CODE>WHITE_BALANCE_NORMAL</CODE> for <CODE>whiteBalance</CODE>.</li><li>Setting  <CODE>autoWhiteBalanceOn</CODE> to <CODE>false</CODE> when <CODE>whiteBalance</CODE> is <CODE>WHITE_BALANCE_NORMAL</CODE>.</li><li>Specification of <CODE>PHOTO_MODE_LANDSCAP</CODE> in <CODE>photoMode</CODE>.</li><li>Specification of <CODE>CONTRAST_PATTERN_10</CODE> in <CODE>contrast</CODE>.</li></ul></P><p><B>Note:</B> This function may block for an extended period if a camera is restarting.</p></div>
72<h2>Revision History</h2>
73    <div class="section">
74      <dl class="history">
75        <dt>2011/03/22</dt>
76<dd>Added information about failure conditions when brightness synchronization is enabled.<br />
77        </dd>
78        <dt>2010/12/13</dt>
79<dd>Noted that the response frame must be set regardless of whether auto-exposure and auto white balance are enabled or disabled.
80        </dd>
81        <dt>2010/11/23</dt>
82<dd>Explained the conflict with the <CODE>PhotoMode</CODE> settings.<br />
83        </dd>
84        <dt>2010/07/17</dt>
85<dd>Initial version.<br />
86        </dd>
87      </dl>
88    </div>
89  <hr><p>CONFIDENTIAL</p></body>
90</html>
91