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-09-30","Desc":"PluginOK中间件之上跨浏览器的微软语音引擎小程序，可在Chrome、Edge、Firefox、IE、Opera、360、QQ、搜狗等的浏览器最新版中实现朗读指定文字功能","DownAddr":"http://local.zorrosoft.com/Files/Plugin/WrlSpVoice.pid","MD5":"2C8038870924BDB36678A3E6D1C07BE1","Version":"1.5.2.1","Size":458752,"HideIns":0,"Type":1,"Cookie":"","Auth":"","TK":"7C95349FA375FE73AFF6B8FF1817F7AA318001A564E4730B8C2312FBFFB726C3141544DDC8A9846C74918FF01DA7946D731D89173780C2A4615EC0C2A94A61600D87904AE1CC46A6741854025DF3164FF363AE1953F0748528A14216A7A9B554C56AA3A0AD9EE81C246DAB34785F8CC146BEC939FBFF8D8450A380627BC4BF6A9D45048B814C7D4AD4C8F4F5DD3E9C9E852491C9227FC1AE4717B6B8424432F137FB0B5A6322DB738FD81627F190CF36E06CFA77A3C4ACB6BBC2AE0045E316C03AC98F2F273F7007065DC7821F0601A12957CF5E40F6CEC686DC7C7409B480A46593E08208DAEC2626CA1439BBAB5F02B9A7C75F9EB03F506FA06A38253BE599"}}

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

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

以上安装和升级的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