猿大师中间件微软语音引擎小程序开发文档

猿大师中间件微软语音引擎小程序开发原理：

猿大师中间件微软语音引擎小程序是基于猿大师中间件网络版开发，提供文本朗读等服务。最低可用在Chrome 41、Firefox 50、Edge 80(Chromium内核)、360极速/安全、IE 8、Oprea 36、QQ、搜狗等浏览器，也兼容运行于这些浏览器的最新版本。

1.猿大师中间件的安装步骤：
 

1)、如果是exe的安装程序，请直接运行安装；

2)、如果是绿色版的程序包，请解压到磁盘某个目录后，双击“InstallWrl.bat”进行安装；

3)、安装完成时会启动PluginOK中间件服务，在安装目录下的Data子目录有ZbaService.txt日志文件输出运行情况；

4)、此小程序不能运行在系统服务下，需要修改ZbaConfig.json里的NoService为1后安装，如已生成data目录下的此配置文件，需要同步修改。

 

2.猿大师中间件微软语音引擎小程序安装步骤：

 

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

 

3、猿大师中间件微软语音引擎小程序的更新升级：

 

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

 

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

 

4、连接请求微软语音引擎小程序服务：
 

说明：以下功能请通过Web Socket连接后可执行，如默认侦听端口不是80(关于如何配置侦听端口，请参考SDK包中的文档“PluginOK开发者手册.doc”)，请在连接地址中指定端口号进行连接。

 

HTTP网页在线测试：http://test.yuanmaster.com   
HTTPS网页在线测试：https://test.yuanmaster.com

打开测试网页，输入地址：ws://localhost:83?sid=112&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":"你好"}}支持的协议功能如下：

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包中的“猿大师开发者手册.doc”及“猿大师中间件安全解决方案”。

如还有疑问请直接联系客服。