SApiApplet.txt

微软语音引擎小程序，基于跨浏览器的小程序系统-PluginOK(牛插)中间件(https://github.com/wangzuohuai/WebRunLocal)单机标准版开发，提供文本朗读等服务。最低可用在Chrome 41、Firefox 50、Edge 80(Chromium内核)、360极速/安全、IE 8、Oprea 36、QQ、搜狗等浏览器，也兼容运行于这些浏览器的最新版本。

1、PluginOK(牛插)中间件的安装：
1)、如果是exe的安装程序，请直接运行安装；
2)、如果是绿色版的程序包，请解压到磁盘某个目录后，双击“InstallWrl.bat”进行安装；
3)、安装完成时会启动PluginOK中间件服务，在安装目录下的Data子目录有WrlService.txt日志文件输出运行情况；
4)、此小程序不能运行在系统服务下，需要修改WrlConfig.json里的NoService为1后安装，如已生成data目录下的此配置文件，需要同步修改。

2、请求安装微软语音引擎小程序，在测试页面上输入 ws://localhost:80?sid=123&flag=1 先连接上中间件服务，然后输入以下内容点击发送：

{"req":"Plugin_Install","rid":1,"para":{"Name":"微软语音引擎小程序","PID":"AE023C55-E408-45DB-BF58-8B11C4E8D945","Date":"2021-05-06","Desc":"PluginOK中间件之上跨浏览器的微软语音引擎小程序，可在Chrome、Edge、Firefox、IE、Opera、360、QQ、搜狗等的浏览器最新版中实现朗读指定文字功能","DownAddr":"http://local.zorrosoft.com/Files/Plugin/WrlSpVoice.pid","MD5":"A10A1DA6A24587AF30817DFC831851BC","Version":"1.3.3.2","Size":458752,"HideIns":0,"Type":1,"Cookie":"","Auth":"","TK":"3E9D5046FE3DF61340F0FC8B500010D5FD36D9A4AC6C1A1222A302386C18160D3414C034DE09638E2D6EC058C9707B03BC3E3860EF41B45ED198CFB72D1B1EF8DE3CED5E840F7D445E8B05E038A8A38B02816365DF9669D1432A149F06B5EC8C2AA8925039E41170FE633608D7DA12E94B0EB610FE68F55B3EA2897AF0D35647D48258955FDE35FEFCE5FF8C6C07E17DEC436032AF843901272A2AEDCB8ED8B65C7E4974175A46C38F81B50BB191F6D6DF110537696DAABBEBA3386B9AB1BDB647F558401BD6BB29C32FFB24AF82215F3A3A5E01F32AE577E16621C8B82128E08A11363A23616DBDD1D993002B20933E829BCA96C18232F6EA9B7C08345D0460"}}

3、请求更新微软语音引擎小程序：

{"req":"Plugin_Update","rid":1,"para":{"Name":"微软语音引擎小程序","PID":"AE023C55-E408-45DB-BF58-8B11C4E8D945","Date":"2021-05-06","Desc":"PluginOK中间件之上跨浏览器的微软语音引擎小程序，可在Chrome、Edge、Firefox、IE、Opera、360、QQ、搜狗等的浏览器最新版中实现朗读指定文字功能","DownAddr":"http://local.zorrosoft.com/Files/Plugin/WrlSpVoice_Update.pid","MD5":"1471C676677644CD425C0B227C89F364","Version":"1.3.3.2","Size":458752,"HideIns":0,"Type":1,"Cookie":"","Auth":"","TK":"0A6FA085EE14B4288F99774C7B7361BF42A23A29671E22E06D0A5CE1C59DC815B2D3EE58A06F502CE941E8ABFBCED5E9CB2CC674FD28D831AB84FE2E010262092FB46A4735E171398007E72197DD0444A826500014310DF900AD13D43BF0C32A1C26DF0E3325418A61A59176F27A79AE286E5725CEAFA538837F753362A13A084F5640E21A06E50CAE965F227A45DE9C100AD4B92B9D9CE492E9C14597DFC751A3373F813ED605E6E1BE789E79DAA6269C4D90EF55EEC9C985993D66D92BD504A4C6AC51954741D84F8AC6D3F21ED1591D44C717BF2BE6830F4D39F32BBC4EF1FD347B292428A32AB7E83C37158D6C8DE536FDAA0603AD27FD0262BFE9759667"}}

以上安装和升级的JSON请求包，可能因版本升级导致内容不同，如遇安装或升级时报错，请联系客服获取最新的请求包。 

4、连接请求微软语音引擎小程序服务：
说明：以下功能请通过Web Socket连接后可执行，如默认侦听端口不是80(关于如何配置侦听端口，请参考SDK包中的文档“PluginOK开发者手册.doc”)，请在连接地址中指定端口号进行连接。
HTTP网页在线测试：http://local.zorrosoft.com  HTTPS网页在线测试：https://local.zorrosoft.com
打开测试网页，输入地址：ws://localhost:80?sid=111&pid=5DC63C90-904B-445F-BBE0-5518E741783B&flag=1 点击连接；

支持的协议功能如下：
A、朗读指定文本
Text为朗读内容，也可以是实际的WAV声音文件来播放 Type为朗读类型(1异步，0同步)，仅对朗读文字有效，播放WAV是同步方式，指定OutFile参数时代表朗读文字时自动录音保存到wav文件中
{"req":"SAPI_Speak","rid":1,"para":{"Text":"你好","Type":1,"OutFile":"D:/Zorro/test.wav"}}

返回内容 {"ret":0,"rid":1,"data":{"Ret":0}} Ret代表是否成功

B、暂停朗读
{"req":"SAPI_Pause","rid":2,"para":{}}
返回内容 {"ret":0,"rid":2,"data":{"Ret":0}} Ret代表是否成功

C、恢复朗读
{"req":"SAPI_Resume","rid":3,"para":{}}
返回内容 {"ret":0,"rid":3,"data":{"Ret":0}} Ret代表是否成功

D、停止朗读
{"req":"SAPI_Stop","rid":4,"para":{}}
返回内容 {"ret":0,"rid":4,"data":{"Ret":0}} Ret代表是否成功

E、设置朗读音量 范围是 0 - 100 
{"req":"SAPI_SetVolume","rid":5,"para":{"Volume":50}}
返回内容 {"ret":0,"rid":5,"data":{"Ret":0}} Ret代表是否成功

F、获取朗读音量
{"req":"SAPI_GetVolume","rid":6,"para":{}}
返回内容 {"ret":0,"rid":6,"data":{"Volume":50}

G、设置朗读速率 范围是 -10 - 10
{"req":"SAPI_SetRate","rid":7,"para":{"Rate":1}}
返回内容 {"ret":0,"rid":7,"data":{"Ret":0}} Ret代表是否成功

H、获取朗读速率
{"req":"SAPI_GetRate","rid":8,"para":{}}
返回内容 {"ret":0,"rid":8,"data":{"Rate":0}}

I、获取当前语言引擎名称
{"req":"SAPI_GetCurToken","rid":9,"para":{}}
返回内容 {"ret":0,"rid":9,"data":{"TokenID":""}}

J、获取所有可用语言引擎名称
{"req":"SAPI_GetAllToken","rid":10,"para":{}}
返回内容 {"ret":0,"rid":10,"data":["TTS_MS_EN-US_ZIRA_11.0","TTS_MS_ZH-CN_HUIHUI_11.0"]}

K、设置当前语言引擎名称
{"req":"SAPI_SetCurToken","rid":11,"para":{"Token":"TTS_MS_EN-US_ZIRA_11.0"}}
返回内容 {"ret":0,"rid":7,"data":{"Ret":0}} Ret代表是否成功

L、指定WAV声音文件，识别为文字
{"req":"SAPI_GetWavText","rid":12,"para":{"File":"D:/Zorro/test.wav"}}
事件返回，可能多个：{"ret":0,"rid":12,"para":{"Text":"你好"}}

5、其它
请求参数的JSON数据包，请确保是UTF-8无签名的编码。
更多接口请求说明，请参考安装目录中的文档TestWrl.txt、SDK包中的“PluginOK开发者手册.doc”及“PluginOK中间件安全解决方案”。
如还有疑问请直接联系客服 加微信：ZorroSoft，或加QQ群：23126938