参数配置

## 1. 配置文件 ##
AIUI初始化时会读取cfg配置，格式是json，参数如下：
~~~ json
{
    "login":{
        "appid": "",
        "key":"",
        "api_secret": ""
    },

"interact":{
		"interact_timeout":"60000",
		"result_timeout":"5000"
	},

"global":{
		"scene":"main_box",
		"clean_dialog_history":"auto",
		/* 1（sdk5.x版本语义）  2（sdk 6.x版本语义） */
		"aiui_ver": "1"
	},

"vad":{
		"vad_enable":"1",
    	"engine_type":"evad",
    	"res_type":"assets",
    	"res_path":"vad/evad_16k.jet",
    	"vad_bos":"5000",
    	"vad_eos":"1000",
    	"threshold":"0.7",
    	"speech_timeout":"5000"
	},
	
	// 识别（音频输入）参数
	"iat":{
		"sample_rate":"16000"
	},

"speech":{
		"data_source":"sdk",
		"interact_mode": "oneshot"
	},

/* 用户参数，透传到后处理(非必须)*/
	"userparams":{
		"xxxx": "xxx" //自定义字段
	},

"tts": {
		"play_mode": "sdk",
		"buffer_time": "0",
		"stream_type": "3",
		"audio_focus": "0"
	}

/* 配置wss协议，避免路由器拦截数据*/
	"aiui_ssb":{
		"aiui_up_url": "wss://aiui-ipv6.openspeech.cn:443/aiui/v2.1/upload.do",
		"aiui_chid_url": "https://aiui-ipv6.openspeech.cn:443/v1.1/server/register",
	},
	
	/* 日志设置
    "log": {
        "debug_log": "0",
        "save_datalog": "0",
        "datalog_path": "",
        "datalog_size": 1024,
        "raw_audio_path": ""
    }
}
~~~
### 1.1. 配置字段说明 ##

<table>
	<tr>
		<td colspan="2" align="center">模块名称</td>
		<td colspan="3" align="center">模块说明</td>
	</tr>
	<tr>
		<td>模块名称</td>
		<td>模块说明</td>
		<td>参数名称</td>
		<td>是否必传</td>
		<td>参数和取值说明</td>
	</tr>
	<tr>
		<td rowspan="3">login</td>
		<td rowspan="3">登录参数</td>
		<td>appid</td>
		<td>是</td>
		<td>AIUI应用信息appid</td>
	</tr>
	<tr>
		<td>key</td>
		<td>否</td>
		<td>AIUI应用信息appKey</td>
	</tr>
	<tr>
		<td>api_secret</td>
		<td>否</td>
		<td>AIUI应用信息apiSecret</td>
	</tr>
	<tr>
		<td rowspan="3">global</td>
		<td rowspan="3">全局参数</td>
		<td>scene</td>
		<td>是</td>
		<td>AIUI应用情景模式</td>
	</tr>
	<tr>
		<td>aiui_ver</td>
		<td>否</td>
		<td>AIUI交互链路指定 1：传统语义链路 2：大模型语义链路（6.6.xxx及以上版本默认取值） </td>
	</tr>
	<tr>
		<td>clean_dialog_history</td>
		<td>否</td>
		<td>清除交互历史设置 auto：自动清除历史（默认模式） user：用户手动清除历史 </td>
	</tr>
	<tr>
		<td rowspan="2">interact</td>
		<td rowspan="2">交互控制参数</td>
		<td>interact_timeout</td>
		<td>否</td>
		<td>交互超时(单位：ms) 即唤醒之后，如果在这段时间内无有效交互则重新进入待唤醒状态， 取值：[10000,180000)。 默认为1min。</td>
	</tr>
	<tr>
		<td>result_timeout</td>
		<td>否</td>
		<td>结果超时(单位：ms) 即检测到语音后端点后一段时间内无结果返回则抛出10120错误码。 默认值：5000。</td>
	</tr>
	<tr>
		<td rowspan="2">speech</td>
		<td rowspan="2">业务相关参数</td>
		<td>data_source</td>
		<td>是</td>
		<td>录音数据来源配置 sdk：sdk内部录音 user： 外部录音</td>
	</tr>
	<tr>
		<td>interact_mode</td>
		<td>是</td>
		<td>交互模式设置 continuous：持续交互，对于语音即“一次唤醒，多次交互” oneshot：（默认模式）一次交互，对于语音即“一次唤醒，一次交互”</td>
	</tr>
	<tr>
		<td rowspan="10">vad</td>
		<td rowspan="10">音频端点检测参数</td>
		<td>vad_enable</td>
		<td>是</td>
		<td>VAD启用设置 1：(默认参数)开启vad 0：关闭vad</td>
	</tr>
	<tr>
		<td>engine_type</td>
		<td>是</td>
		<td>VAD引擎类型 取值有 meta、evad，注意该参数与实际加载的vad资源要对应</td>
	</tr>
	<tr>
		<td>res_type</td>
		<td>是</td>
		<td>VAD资源类型 使用模型vad时必须设置，取值说明如下 assets：assets资源（apk工程的assets文件） res：res资源（apk工程的res文件） path：path资源（sdcard文件）</td>
	</tr>
	<tr>
		<td>res_path</td>
		<td>是</td>
		<td>VAD资源文件路径 使用模型vad时必须设置。</td>
	</tr>
	<tr>
		<td>vad_bos</td>
		<td>否</td>
		<td>VAD前端超时时间 单位：毫秒 取值范围：[1000,10000] 默认值： "5000"</td>
	</tr>
	<tr>
		<td>vad_eos</td>
		<td>否</td>
		<td>VAD后端超时时间 单位：毫秒 取值范围：[0,10000] 默认值："1000"</td>
	</tr>
	<tr>
		<td>cloud_vad_eos</td>
		<td>否</td>
		<td>云端VAD后端超时时间 单位：毫秒 示例 "3000"</td>
	</tr>
	<tr>
		<td>cloud_vad_gap</td>
		<td>否</td>
		<td>云端VAD分句间隔 单位：毫秒 示例 "400"</td>
	</tr>
	<tr>
		<td>threshold</td>
		<td>否</td>
		<td>VAD检测阈值 控制VAD模块检测程度的，取值范围[0.1,0.9]， 值越大越难触发vad</td>
	</tr>
	<tr>
		<td>speech_timeout</td>
		<td>否</td>
		<td>对话超时时间 vad_bos开始说话时计时，超过设置的时间自动结束对话并回调vad_eos，单位：毫秒，示例 "500"（默认值60000）</td>
	</tr>
	<tr>
		<td>userparams</td>
		<td>用户自定义参数</td>
		<td>用户自定义key</td>
		<td>否</td>
		<td>用户自定义value 无固定取值限制，开发者自定义健值对符合json格式即可</td>
	</tr>
	<tr>
		<td rowspan="2">audioparams</td>
		<td rowspan="2">音频透传参数</td>
		<td>msc.lng</td>
		<td>否</td>
		<td>经度 示例：117.16334474（不超过8位精度）</td>
	</tr>
	<tr>
		<td>msc.lat</td>
		<td>否</td>
		<td>纬度 示例：31.82102191（不超过8位精度）</td>
	</tr>
	<tr>
		<td>iat</td>
		<td>识别音频参数</td>
		<td>sample_rate</td>
		<td>否</td>
		<td>采样率 16000</td>
	</tr>
	<tr>
		<td rowspan="4">tts</td>
		<td rowspan="4">合成播放控制参数</td>
		<td>play_mode</td>
		<td>否</td>
		<td>播放控制 sdk：内部SDK托管播放（默认取值) user：外部自行播放</td>
	</tr>
	<tr>
		<td>buffer_time</td>
		<td>否</td>
		<td>音频缓冲时长 当缓冲音频大于该值时才开始播放，默认值：0ms</td>
	<tr>
		<td>stream_type</td>
		<td>否</td>
		<td>播放音频流类型 取值参考AudioManager类，默认值：3</td>
	<tr>
		<td>audio_focus</td>
		<td>否</td>
		<td>播放音频时是否抢占焦点 1：抢占焦点 0：不抢占焦点（默认值）</td>
	</tr>
	<tr>
		<td rowspan="2">aiui_ssb</td>
		<td rowspan="2">交互协议透传参数 （使用加密协议，避免请求拦截）</td>
		<td>aiui_chid_url</td>
		<td>否</td>
		<td>登陆注册地址 https://aiui-ipv6.openspeech.cn:443/v1.1/server/register</td>
	</tr>
	<tr>
		<td>aiui_up_url</td>
		<td>否</td>
		<td>数据交互地址（传统语义链路） wss://aiui-ipv6.openspeech.cn:443/aiui/v2.1/upload.do</td>
	</tr>
	<tr>
		<td rowspan="5">log</td>
		<td rowspan="5">日志设置</td>
		<td>debug_log</td>
		<td>否</td>
		<td>Debug日志开关 取值：1（打开），0（关闭），默认值：0。 日志打开时会向logcat打印调试日志。</td>
	</tr>
	<tr>
		<td>save_datalog</td>
		<td>否</td>
		<td>是否保存数据日志 取值：1（打开），0（关闭），默认值：0。 打开之后会将所有上传到云端的音频和云端返回的结果保存到本地，保存的路径位于/sdcard/AIUI/data/，每一次唤醒后的交互音频都保存在此目录下wakeXX开始的文件夹下。</td>
	<tr>
		<td>datalog_path</td>
		<td>否</td>
		<td>数据日志的保存路径 当不设置或者为空值时，使用默认值：“/sdcard/AIUI/data/”。</td>
	<tr>
		<td>datalog_size</td>
		<td>否</td>
		<td>数据日志的大小限制（单位：MB） 取值：[-1，+∞) 默认值：-1（表示无大小限制）。 注意：设置成-1可能会造成SD卡被日志写满，从而导致AIUI性能下降，影响体验效果。</td>
	</tr>
	<tr>
		<td>raw_audio_path</td>
		<td>否</td>
		<td>原始音频保存路径 当不设置或者为空值时，使用默认值：“/sdcard/AIUI/audio/”。</td>
	<tr>
</table>

### 1.2. 动态参数配置 ##
动态设置scene可使用不同情景模式下对应的业务

**Android 示例代码**
~~~ java
String setParams = "{\"global\":{\"scene\":\"main\"}}";
AIUIMessage setMsg = new AIUIMessage(CMD_SET_PARAMS, 0 , 0, setParams, null);
mAIUIAgent.sendMessage(setMsg);
~~~

**iOS/Linux/Windows 示例代码**
~~~ c
const char* setParams = "{\"global\":{\"scene\":\"main\"}}";
IAIUIMessage* writeMsg=IAIUIMessage::create(AIUIConstant::CMD_SET_PARAMS, 0, 0, setParams, NULL);
m_angent->sendMessage(writeMsg);
writeMsg->destroy();
~~~