3.3.3 消息事件说明

<div style="max-width: 100%; margin: 20px auto;">
    
    <div style="background-color: #ffffff; border-radius: 8px; box-shadow: 0 2px 8px rgba(0,0,0,0.1); overflow: hidden; font-family: 'Comic Sans MS', cursive, sans-serif;">
        
        
        <div style="background-color: #F4F8FA; padding: 1px 10px; border-bottom: 1px solid #dee2e6; display: flex; justify-content: space-between; align-items: center;">
            <div style="color: #0E42D2; font-weight: bold;font-size: 1.3rem;">消息事件概述</div>
            <div>
            </div>
        </div>
        
        <div style="padding: 25px; line-height: 29px; background-image: linear-gradient(transparent 26px, #dee2e6 27px, #dee2e6 27px, transparent 27px); background-size: 100% 28px; min-height: 100px; color: #333;">
            <div>本章节详细介绍请求事件和回调事件对应的内部消息类型。AIUI SDK做请求发送和结果接受时，分别通过下面两个事件来进行详细区分:</div>
			<div><strong>请求事件：</strong>通过构建不同的AIUIMessage进行发送，来实现不同的消息指令请求。</div>
			<a href="#AIUIMessage" style="color: #6f42c1; font-weight: 500;margin-left: 40px;">
			<strong>- AIUIMessage>>>点击跳转</strong></a>
			<div><strong>回调事件：</strong>通过解析回调中AIUIEvent不同类型，可以获取AIUI SDK抛出的状态或结果。</div>
			<a href="#AIUIEvent" style="color: #6f42c1; font-weight: 500;margin-left: 40px;">
			<strong>- AIUIEvent>>>点击跳转</strong></a>
            <div></div>
        </div>
        
        </div>
    </div>
</div>

## 1. AIUIMessage
通过AIUIMessage向SDK发送指令，通过AIUIEvent获取sdk事件回调。

<div style="display: flex; align-items: flex-start; gap: 16px; padding: 16px; background: #fff5f6; border-radius: 5px; border-left: 4px solid #e83e8c; box-shadow: 0 4px 12px rgba(255, 215, 0, 0.08); margin-bottom: 16px; transition: transform 0.2s ease, box-shadow 0.2s ease;">
  <div>
    <div style="font-weight: 600; margin-bottom: 4px;">温馨提示</div>
    <div style="font-size: 14px; line-height: 1.5;">有返回值的消息类型，代表向AIUI发送该消息后，AIUI会抛出EVENT_CMD_RETURN事件返回结果。</div>
  </div>
</div>

<tr class="row-odd"><td>msgType（消息类型）</td>
<td>取值</td>
<td>返回值</td>
<td><div class="first last line-block">
<div class="line">说明</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_GET_STATE</td>
<td>1</td>
<td>有</td>
<td><div class="first last line-block">
<div class="line"><strong>获取<a href="https://aiui-doc.xf-yun.com/project-1/doc-15/">交互状态</a></strong></div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_WRITE</td>
<td>2</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>向AIUI写入数据，回调vad bos事件</strong></div><br>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-21/#数据写入">数据写入</a>。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_STOP_WRITE</td>
<td>3</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>停止写入数据，回调vad eos事件</strong></div><br>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-21/#数据写入">数据写入</a>。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_START</td>
<td>5</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>启动AIUI</strong></div>
<div class="line"><br /></div>
<div class="line">AIUI停止后，使用此命令启动</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_STOP</td>
<td>6</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>停止AIUI</strong></div>
<div class="line"><br /></div>
<div class="line">AIUI停止之后，将不响应外部输入。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_WAKEUP</td>
<td>7</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>唤醒消息</strong></div>
<div class="line"><br /></div>
<div class="line">手动唤醒AIUI，arg1为唤醒后拾音的波束号，默认为0。为了保障识别效果稳定性，请勿将手动唤醒用于延长交互时间。
</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_RESET_WAKEUP</td>
<td>8</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>休眠消息</strong></div>
<div class="line"><br /></div>
<div class="line">进入待唤醒状态</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_SET_PARAMS</td>
<td>10</td>
<td>无</td>
<td><div class="first line-block">
<div class="line"><strong>动态参数设置</strong></div>
<div class="line"><br /></div>
<div class="line">用params携带参数设置JSON字符串，具体格式参照aiui.cfg文件。</div>
<div class="line">可动态更新参数如下</div>
<div class="line"><br /></div>
</div>
<blockquote class="last">
<div><ul class="simple">
<li>global</li>
<li>speech</li>
<li>userparams</li>
<li>audioparams</li>
<li>tts</li>
</ul>
<p>示例:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="o">{</span>
  <span class="s">&quot;global&quot;</span><span class="o">:{</span>
     <span class="s">&quot;scene&quot;</span><span class="o">:</span><span class="s">&quot;main&quot;</span>
   <span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</div></blockquote><br>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-13/#动态配置">基础配置说明</a>。</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_SYNC</td>
<td>13</td>
<td>有</td>
<td><div class="first last line-block">
<div class="line"><strong>上传个性化数据</strong></div>
<div class="line"><br /></div>
<div class="line">arg1表示上传的数据类型</div>
<div class="line">data表示上传的数据内容</div><br/>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-24/">用户个性化使用文档</a>。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_RESULT_VALIDATION_ACK</td>
<td>20</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>结果确认</strong></div>
<div class="line">收到云端结果5s内发送该指令，重置交互超时的计时。</div>
<div class="line"><br /></div>
<div class="line">关于交互超时的机制参看<a class="reference internal" href="https://aiui-doc.xf-yun.com/project-1/doc-13/#配置文件示例"><span class="std std-ref">AIUI配置</span></a>中<cite>interact_timeout</cite>的解释。</div><br>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-21/#延迟休眠">延迟休眠</a>。</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_CLEAN_DIALOG_HISTORY</td>
<td>21</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>清空交互历史</strong></div><br>
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-21/#清除历史">清除历史</a>。</div>
</div>
</td>
</tr>
</tr>

<tr class="row-even"><td>CMD_START_RECORD</td>
<td>22</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>开始录制数据（暂只支持Android系统）</strong></div>
</div>
</td>
</tr>

<tr class="row-odd"><td>CMD_STOP_RECORD</td>
<td>23</td>
<td>无</td>
<td><div class="first last line-block">
<div class="line"><strong>停止录制数据（暂只支持Android系统）</strong></div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_QUERY_SYNC_STATUS</td>
<td>24</td>
<td>有</td>
<td><div class="first last line-block">
<div class="line"><strong>查询数据同步状态</strong></div>
<div class="line"><br /></div>
<div class="line">arg1表示状态查询的类型</div>
<div class="line">params包含查询条件</div><br />
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-24/#查询打包状态">查询打包状态</a>。
</div>
</div>
</td>
</tr>

<tr class="row-even"><td>CMD_TTS</td>
<td>27</td>
<td>有</td>
<td><div class="first last line-block">
<div class="line"><strong>进行语音合成</strong></div>
<div class="line"><br /></div>
<div class="line">arg1表示控制语音合成命令<ul class="simple"></ul></div>
<div class="line">params包含合成参数</div><br />
<div class="line">使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-23/">云端TTS</a>。
</div>
</div>
</td>
</tr>

</tbody>
</table>

## 2. AIUIEvent
通过AIUIEvent解析，获取AIUI SDK交互或其他状态信息回调结果。

<tr class="row-odd"><td>eventType(事件类型)</td>
<td>取值</td>
<td><div class="first last line-block">
<div class="line">说明</div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_RESULT</td>
<td>1</td>
<td><div class="first last line-block">
<div class="line"><strong>结果事件</strong></div>
<div class="line"><br /></div>
<div class="line">解析参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-16/">结果解析</a>。</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_ERROR</td>
<td>2</td>
<td><div class="first last line-block">
<div class="line"><strong>出错事件</strong></div>
<div class="line"><br /></div>
<div class="line">arg1是错误码，info上错误描述信息。</div>
<div>错误码附录<a href="https://aiui-doc.xf-yun.com/project-1/doc-42/">错误码</a>说明。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_STATE</td>
<td>3</td>
<td><div class="first last line-block">
<div class="line"><strong>服务状态事件</strong></div>
<div class="line"><br /></div>
<div class="line">详细见<a href="https://aiui-doc.xf-yun.com/project-1/doc-15/">SDK状态说明</a>。</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_WAKEUP</td>
<td>4</td>
<td><div class="first last line-block">
<div class="line"><strong>唤醒事件</strong></div>
<div class="line"><br /></div>
<div class="line">arg1字段取值：</div>
<div class="line-block">
<div class="line">0 （语音唤醒）</div>
<div class="line">1 （发送CMD_WAKEUP手动唤醒）。</div>
<div class="line">info字段为唤醒结果JSON字符串。</div>
</div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_SLEEP</td>
<td>5</td>
<td><div class="first last line-block">
<div class="line"><strong>休眠事件</strong></div>
<div class="line"><br /></div>
<div class="line">arg1字段取值：</div>
<div class="line-block">
<div class="line">0 （交互超时,自动休眠）</div>
<div class="line">1  (发送CMD_RESET_WAKEUP，手动休眠)。</div>
</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_VAD</td>
<td>6</td>
<td><div class="first last line-block">
<div class="line"><strong>VAD事件</strong></div>
<div class="line"><br /></div>
<div class="line">arg1取值:0(vad 开始说话)、1(音量)、2(vad 结束说话)、3（没说话超时）。</div>
<div class="line">当arg1取值为1时，arg2为音量大小。</div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_CMD_RETURN</td>
<td>8</td>
<td><div class="first last line-block">
<div class="line"><strong>某条CMD命令对应的返回事件</strong></div>
<div class="line"><br /></div>
<div class="line">对于除CMD_GET_STATE外的有返回的命令，都会返回该事件，</div>
<div class="line">用arg1标识对应的CMD命令，arg2为返回值，0表示成功，info字段为描述信息。</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_PRE_SLEEP</td>
<td>10</td>
<td><div class="first last line-block">
<div class="line"><strong>准备休眠事件</strong></div>
<div class="line"><br /></div>
<div class="line">若10s内不交互，则休眠。</div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_START_RECORD</td>
<td>11</td>
<td><div class="first last line-block">
<div class="line"><strong>通知外部录音开始，用户可以开始说话</strong></div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_STOP_RECORD</td>
<td>12</td>
<td><div class="first last line-block">
<div class="line"><strong>通知外部录音停止</strong></div>
</div>
</td>
</tr>

<tr class="row-even"><td>EVENT_CONNECTED_TO_SERVER</td>
<td>13</td>
<td><div class="first last line-block">
<div class="line"><strong>与服务端建立连接</strong></div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_SERVER_DISCONNECTED</td>
<td>14</td>
<td><div class="first last line-block">
<div class="line"><strong>与服务端断开连接</strong></div>
<div class="line"><br /></div>
</div>
</td>
</tr>

<tr class="row-odd"><td>EVENT_TTS</td>
<td>15</td>
<td><div class="first last line-block">
<div class="line"><strong>语音合成事件</strong></div>
<div class="line"><br /></div>
<div class="line">合成状态以及合成进度，使用参考<a href="https://aiui-doc.xf-yun.com/project-1/doc-23/">云端TTS</a>。</div>
</div>
</td>
</tr>

</tbody>
</table>