获取亮度调节方案
<p><strong>简要描述:</strong> </p>
<ul>
<li>获取亮度调节方案的接口</li>
</ul>
<p><strong>请求URL:</strong> </p>
<ul>
<li><code>void nvGetBrightnessPolicyAsync(const char *data, ExportViplexCallback callback)</code></li>
</ul>
<p><strong>请求方式:</strong></p>
<ul>
<li>
<p><strong>请求参数示例</strong></p>
</li>
</ul>
<pre><code>{
"sn":"",
"brightnessPolicyInfo":{
"isSupportCompleteCron":false
}
}</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;">brightnessPolicyInfo</td>
<td style="text-align: left;">必选</td>
<td style="text-align: left;">Object</td>
<td>请求信息对象</td>
</tr>
<tr>
<td style="text-align: left;">isSupportCompleteCron</td>
<td style="text-align: left;">非必选</td>
<td style="text-align: left;">bool</td>
<td>是否支持完整cron表达式调节及有效期,不传此参数,默认为false</td>
</tr>
</tbody>
</table>
<p><strong>返回示例</strong></p>
<pre><code>{
"enable":true,
"source":{
"platform":1,
"type":1
},
"conditions":[
{
"opticalFailureInfo":{
"enable":true,
"screenBrightness":30
},
"enable":true,
"crons":[
"0 15 10 ? ** *"
],
"startTime":"2017-09-01 00:00 : 00",
"endTime":"4016-06-06 23:59:59",
"segments":[
{
"screenBrightness":80,
"environmentBrightness":12000
},
{
"screenBrightness":60,
"environmentBrightness":10000
}
],
"type":2,
"args":[
12000,
20,
80,
40,
10
]
},
{
"opticalFailureInfo":{
"enable":true,
"screenBrightness":30
},
"enable":true,
"crons":[
"0 15 10 ? **"
],
"startTime":"2017-09-01 00:00:00",
"endTime":"4016-06-06 23:59:59",
"segments":[
],
"type":1,
"args":[
30
]
}
],
"type":"BRIGHTNESS",
"segmentConfig":{
"opticalFailureInfo":{
"enable":true,
"screenBrightness":30
},
"segments":[
{
"screenBrightness":80,
"environmentBrightness":12000
},
{
"screenBrightness":60,
"environmentBrightness":10000
}
],
"args":[
12000,
20,
80,
40,
10
]
},
"timeStamp":"2018-07-19 11:27:15"
}</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>
<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;">data</td>
<td style="text-align: left;">Object</td>
<td>返回参数</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">string</td>
<td>固定为"BRIGHTNESS"</td>
</tr>
<tr>
<td style="text-align: left;">source</td>
<td style="text-align: left;">object</td>
<td>表示任务的发布来源,我们现在终端的节目可以来自不同的来源,如PC、移动终端、云服务等</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">number</td>
<td>1:nova自己的平台,0:第三方平台</td>
</tr>
<tr>
<td style="text-align: left;">platform</td>
<td style="text-align: left;">number</td>
<td>1:移动终端发来的(如手机),2:表示传统电脑,3:表示平板,4:表示web端发来的。</td>
</tr>
<tr>
<td style="text-align: left;">enable</td>
<td style="text-align: left;">boolean</td>
<td>使能开关,</td>
</tr>
<tr>
<td style="text-align: left;">conditions</td>
<td style="text-align: left;">object</td>
<td>按照条件执行的条件集合,我们支持多个条件触发。</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">number</td>
<td>调节类型,1:定时调节,2:自动调节</td>
</tr>
<tr>
<td style="text-align: left;">cron</td>
<td style="text-align: left;">array</td>
<td>重复次数,每条条件使用cron表达式数组表示,当为数组时,cron表达式之间使用或的关系</td>
</tr>
<tr>
<td style="text-align: left;">startTime</td>
<td style="text-align: left;">string</td>
<td>策略有效期开始时间yyyy-MM-dd</td>
</tr>
<tr>
<td style="text-align: left;">endTime</td>
<td style="text-align: left;">string</td>
<td>策略有效期结束时间yyyy-MM-dd</td>
</tr>
<tr>
<td style="text-align: left;">args</td>
<td style="text-align: left;">object</td>
<td>亮度调节参数,定时调试时args只有一个值为亮度百分比,自动调节时args含有5个值,分别为最大环境亮度,最小环境亮度,最大屏体亮度,最小屏体亮度,</td>
</tr>
<tr>
<td style="text-align: left;">segments</td>
<td style="text-align: left;">object</td>
<td>亮度调节参数的分段详细设置</td>
</tr>
<tr>
<td style="text-align: left;">environmentBrightness</td>
<td style="text-align: left;">number</td>
<td>环境亮度值</td>
</tr>
<tr>
<td style="text-align: left;">screenBrightness</td>
<td style="text-align: left;">number</td>
<td>对应环境亮度所要调节的屏体亮度值</td>
</tr>
<tr>
<td style="text-align: left;">opticalFailureInfo</td>
<td style="text-align: left;">object</td>
<td>自动亮度调节时,获取环境亮度失败,是否调到固定值的选项,该字段只对自动亮度调节有效。</td>
</tr>
<tr>
<td style="text-align: left;">enable</td>
<td style="text-align: left;">boolean</td>
<td>自动亮度调节时,获取环境亮度失败,是否调到固定值</td>
</tr>
<tr>
<td style="text-align: left;">screenBrightness</td>
<td style="text-align: left;">number</td>
<td>需要调节到的固定亮度值</td>
</tr>
<tr>
<td style="text-align: left;">enable</td>
<td style="text-align: left;">boolean</td>
<td>该条方案的使能开关</td>
</tr>
<tr>
<td style="text-align: left;">segmentConfig</td>
<td style="text-align: left;">object</td>
<td>根据环境亮度配置的分段表数据segmentsConfig字段,内部字段参见自动亮度调节的参数说明</td>
</tr>
<tr>
<td style="text-align: left;">timeStamp</td>
<td style="text-align: left;">string</td>
<td>当前数据的时间戳,为后期可能使用</td>
</tr>
</tbody>
</table>
<p><strong>备注</strong> </p>
<ul>
<li>
</li>
</ul>