MSTTSApp.txt

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

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

2、安装升级测试：
1、安装MSTTSApp小程序
请在测试网页输入框中，分别输入如下请求，然后点击发送，完成安装：

{"req":"Plugin_Install","rid":1,"para":{"Name":"MSTTSApp","PID":"MSTTSApp","Date":"2023-09-26","Desc":"MSTTS applet for PluginOK","DownAddr":"http://local.zorrosoft.com/Files/Net/MSTTSApp.pid","MD5":"0C05B9D88522B1506946711B89DDA49E","Version":"2.2.11.1","Size":491520,"HideIns":0,"Type":2,"Cookie":"","Auth":"","TK":"8779BD9B06AFA15CC2DFBFE69E10922BC14046BBD302BA1B1A4AA69930D725F389A8DD865443376FF1FD969F391F075C43D99A075AFDED1FDB8C457EE972A44F0BDC2CAFC77667F15ACE93384EE9B8591479BCE918D449440CFAA3455CB577BF3BE90C55FA17C2D9B20BE586E1039B8FFB612649CAE0DA221E2CFA132A87EFDB4974041A80A00312B5FC32EFB826D9CB12F981325B20A51DB9D077BCD7CC90C636868B691BF64AFE83038FF9EB4FB86267D5FB3ED270D9F05DE78006651E47205635FA6547E8FB62CECE495A2E4AA9A32138406579E3EAC483261A65CE8108C001E4CA897C9AC6797E0596F01DF76BEF58E89B7EBDFCB17B2B7010146746625D"}}

3、请求升级MSTTSApp小程序：

{"req":"Plugin_Update","rid":1,"para":{"Name":"MSTTSApp","PID":"MSTTSApp","Date":"2023-09-26","Desc":"MSTTS applet for PluginOK","DownAddr":"http://local.zorrosoft.com/Files/Net/MSTTSApp_Update.pid","MD5":"4FAAA61171F53503753169E431B48E2A","Version":"2.2.11.1","Size":491520,"HideIns":0,"Type":2,"Cookie":"","Auth":"","TK":"67FC4E1678961302466E475AF2B67E062E636A9F11D8A82C603EBD181019428454394BE3980C499ABFDB049B293B1A2F9439CA21295D317701EA387AC9A32AD90EF19053DFC5CCE2B0D73FAC2B0350A0618CAFCA61AEA66A8819AA0A6F106D2A79CE802454CE4203DED1CDE5929B280EC41DB3098EDF8075916BA6EC2A6A75B905E736ED827A98A4FFE4E495213208FE3B6FDED5DB61B50EA8EEC76C7D52B0E13B68C151B5CBE2F8CA0D8B8A18A648420B609D5D738E3E3A636D10C94A89B0AA654354E5E47819A02F3838A446C428C19F03D37405A34D59FD4D5D8CB3F0FBE4655DBFDEC394F5E0A625494A0597209498C99F83E90116C535BF03AC61590AB3"}}

4、卸载小程序：
正式版需要添加TK校验，具体规则请参考SDK包中文档“中间件安全解决方案.pdf”，可在SDK包中的打包程序ZbaPackage.exe的中间件维护生成带TK的请求。
举例：
{"req":"Plugin_Remove","rid":50,"para":{"PID":"MSTTSApp","Type":2}}

5、前端请求卸载中间件：
正式版需要添加TK校验，具体规则请参考SDK包中文档“中间件安全解决方案.pdf”，可在SDK包中的打包程序ZbaPackage.exe的中间件维护生成带TK的请求。
举例：
{"req":"Wrl_Remove","rid":22,"para":{}}
说明：连接主服务后可执行；

6、PluginOK中间件升级：

{"req":"Wrl_Update","rid":1,"para":{"Name":"PluginOK中间件网络版升级包","Date":"2023-04-11","Desc":" 1、改进中间件对高级版内嵌网页小程序全屏显示及恢复处理效果；2、改进中间件高级版内嵌网页小程序中再次嵌入其它EXE执行程序窗口运行效果；3、改进中间件网络版与授权服务器通信处理机制；4、中间件针对Office网页组件OLE嵌入提供代理进程支持，提升其运行性能及实现多文档操作；5、优化RTSP多引擎网页播放器对VLC4的兼容性...","DownAddr":"http://local.zorrosoft.com/Files/Update/Zba_Update.pid","MD5":"FBF726F5DBC868AA16F4401B9DA35802","Version":"2.2.11.1","Size":13238272,"HideIns":0,"Cookie":"","Auth":"","Open":"","TK":"45E66BEB187A03E4390918CEC92E3D8A48FE04CE03B6942DA0EC0153B30E7430C211686E3F66D93DEADEBF41EC3A1433A72B7CB0D67315B58D9E36BB14A8E1067F5A34B3AD17664A2CDB98C147F8153885C3E329B3B2631990E97EC77E157C07EAADAA6DEBD127224331A82FA674C99113ACBBACC9ED3D124635528A5A718EF2B742912F44AE5DD1938D7556A74D03D52D98092BDC29E3CEA23CC12BFA9DCFC2CA1BEB5F107A64BBF84AE3D6B9BBFBDC9FC4453CEF157CA493618803BC6F6EAE0BC249AF3190F08E378DA77161B6A44EA87D97D59771BCA58190339DF19FBF9C1023CE0504B202C13648D7CB1D3D7D07319C32F2FB58BD7FB782477419E49E34"}}

7、连接请求微软语音引擎小程序服务：
说明：以下功能请通过Web Socket连接后可执行，如默认侦听端口不是80(关于如何配置侦听端口，请参考SDK包中的文档“PluginOK开发者手册.pdf”)，请在连接地址中指定端口号进行连接。

HTTP网页在线测试：http://local.zorrosoft.com   HTTPS网页在线测试：https://local.zorrosoft.com
打开测试网页，输入地址：ws://localhost:83?sid=112&pid=MSTTSApp&flag=1 点击连接；

支持的协议功能如下：
A、朗读指定文本
Text为朗读内容，也可以是实际的WAV文件来播放 
Type为朗读类型(1异步，0同步)，仅对朗读文字有效，播放WAV是同步方式
指定OutFile参数时代表朗读文字时自动录音保存到wav文件中
Text及OutFile需要先做UrlEncode编码
{"req":"SAPI_Speak","rid":1,"para":{"Text":"hello!","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":"你好"}}支持的协议功能如下：
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":"你好"}} 

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