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、请求安装微软语音引擎小程序：

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

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

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

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