SApiApplet .txt

微软语音引擎小程序，基于跨浏览器的小程序系统-PluginOK(牛插)中间件(https://github.com/wangzuohuai/WebRunLocal)开发，提供文本朗读等服务。最低可用在Chrome 41、Firefox 52、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":"2020-12-18","Desc":"PluginOK中间件之上跨浏览器的微软语音引擎小程序，可在Chrome、Edge、Firefox、IE、Opera、360、QQ、搜狗等的浏览器最新版中实现朗读指定文字功能","DownAddr":"http://local.zorrosoft.com/Files/Plugin/WrlSpVoice.pid","MD5":"3A3F91ED95C7EBC8D07F4DA03EA069EE","Version":"2.0.3.11","Size":458752,"HideIns":0,"Type":1,"Cookie":"","Auth":"","TK":"AFE0F076A6C0E2B2F5B1FFA26B18658B4DB1528EBDD3339C68A2BC3A7DC7F93928B68111405DF90505B30F91276145B24241D5651EA18E95FDA7BA2DAE177994C65DAC5605345575556658B4BCE618E3D2800BB25AE5481E493B53428968512E4618C70B854D62EAA184F7D4BF33C4853311E66C5F9D58591894B9CCEEBA49161CEB7917D10081F43C1635A9C6C27B0569AF8EBD2EAEE98E88F6D3988F10062068E8B77BBD602D8F89A16D4141D68785E5E1B2634F51FFE4B6DF426B7A78492BBA85C6FFB0E5BDFA3CB47FA924649C228744DA785AD2F0B2A0FFC0F536953055A89E8D2CE9A0126087152A645404813BE64CED46A00F5C98C1843A42ECFD663F"}}

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

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

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

4、连接请求微软语音引擎小程序服务：
说明：以下功能请通过Web Socket连接后可执行，如默认侦听端口不是80(关于如何配置侦听端口，请参考SDK包中的文档“PluginOK开发者手册.doc”)，请在连接地址中指定端口号进行连接。
HTTP网页在线测试：http://local.zorrosoft.com  HTTPS网页在线测试：https://local.zorrosoft.com
打开测试网页，输入地址：ws://localhost?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