接口示例
<p>SDK提供的功能接口大部分形如:void nvSetColorTemperature(const char *data, ExportViplexCallback callback)</p>
<p><strong>简要描述:</strong> </p>
<ul>
<li>获取箱体温度的接口</li>
</ul>
<p><strong>请求URL:</strong>
此项为函数定义
功能接口同时支持同步和异步模式,形如表格:</p>
<table>
<thead>
<tr>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">同步<td width="90%" > <code>void nvGetScreenPowerModeSync(const char *data, ExportViplexCallback callback)</code></td>
</tr>
<tr>
<td style="text-align: left;">异步</td>
<td><code>void nvGetScreenPowerModeAsync(const char *data, ExportViplexCallback callback)</code></td>
</tr>
</tbody>
</table>
<p>为了文档更精简并突出关键信息,<strong>在后续的接口文档中只列出不带同异步标识的函数名,如:</strong></p>
<ul>
<li><code>void nvGetScreenPowerMode(const char *data, ExportViplexCallback callback)</code></li>
</ul>
<p><strong>函数参数</strong>
由于SDK提供的功能接口都是同样的样式,为了文档更精简并突出关键信息,<strong>在后续的接口文档中不再提供此项信息</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Header名</th>
<th style="text-align: left;">是否必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">string</td>
<td>请求的JSON参数,参数示例和字段描述详见<code>请求参数示例</code>和<code>参数</code></td>
</tr>
<tr>
<td style="text-align: left;">callback</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">ExportViplexCallback</td>
<td>接收返回值的回调函数</td>
</tr>
</tbody>
</table>
<p><strong>请求参数示例</strong></p>
<pre><code>{
"sn":"BZSA17332J0A20002272",
"colorTemperatureInfo":{
"colorTemperature":6500
}
}</code></pre>
<p><strong>参数:</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">是否必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">sn</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">string</td>
<td>产品唯一序列号</td>
</tr>
<tr>
<td style="text-align: left;">colorTemperatureInfo</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">Object</td>
<td>JSON对象</td>
</tr>
<tr>
<td style="text-align: left;">colorTemperature</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">int</td>
<td>色温值</td>
</tr>
</tbody>
</table>
<p><strong>回调函数返回值</strong>
接口调用都是通过<code>ExportViplexCallback</code>回调函数参数提供,为了文档更精简并突出关键信息,<strong>在后续的接口文档中不再提供此项信息,并将<code>code</code>归入到<code>返回参数说明</code>里</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td>错误码:<code>0</code>获取成功<code>65535</code>请求超时</td>
</tr>
<tr>
<td style="text-align: left;">result</td>
<td style="text-align: left;">string</td>
<td>返回信息,返回值示例和字段描述详见<strong>返回示例</strong>和<strong>返回参数说明</strong></td>
</tr>
</tbody>
</table>
<p><strong>返回示例</strong></p>
<pre><code>""</code></pre>
<p><strong>返回参数说明</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<p><strong>备注</strong> </p>
<ul>
<li>
</li>
</ul>