Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wxxxcxx authored Oct 6, 2023
1 parent a23a58b commit 2509311
Showing 1 changed file with 20 additions and 31 deletions.
51 changes: 20 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,3 @@
# ms-ra-forwarder

创建这个项目的初衷是为了能够在[阅读(legado)](https://github.com/gedoor/legado)中听“晓晓”念书。由于其中的脚本引擎不支持 WebSocket ,所以包装了一下微软 Edge 浏览器“大声朗读”的接口。

如果你的项目可以使用 WebSocket ,请直接在项目中调用原接口。具体代码可以参考 [ra/index.ts](ra/index.ts)

## 重要更改

**2023-04-19:Azure 下线了演示页面的试用功能,导致 Azure 版接口无法使用了,请各位迁移到 Edge 浏览器的接口吧。**

2022-11-18:添加词典文件支持,词典文件格式参考 https://github.com/wxxxcxx/azure-tts-lexicon-cn/blob/main/lexicon.xml

2022-09-10:修改 docker 仓库地址,后面构建的 docker 镜像会迁移到 wxxxcxx/ms-ra-forwarder(原仓库旧版本镜像依然有效)。

2022-09-01:Azure TTS API 好像又改了,旧版用户可能会无法正常使用,请更新到最新版。

2022-07-17:添加 Azure TTS API 支持(没怎么测试,不知道用起来稳不稳定)。因为调用 Azure TTS API 需要获取授权码。其它方式只需要或取一次就可以使用一段时间,而 Vercel 每次调用 API 都需要重新获取授权码。容易超时不说,也加剧了微软服务器的负担,所以不是很推荐部署在 Vercel 的用户使用(虽然也不是不能用~但是万一微软被薅痛了,又改接口就不好了😂)。

2022-07-02:Edge 版本的 API 目前测试还支持的格式有 `webm-24khz-16bit-mono-opu``audio-24khz-48kbitrate-mono-mp3``audio-24khz-96kbitrate-mono-mp3`。另外今天下午开始,使用不在下拉列表中声音会出现类似 “Unsupported voice zh-CN-YunyeNeural.” 错误,后续可能也会被砍掉。且用且珍惜吧!

2022-07-01:~~部署在中国大陆以外服务器上的服务目前只能选择 `webm-24khz-16bit-mono-opus` 格式的音频了!~~ 所以使用 Vercel 的用户需要重新部署一下。

2022-06-16:Edge 浏览器提供的接口现在已经不能设置讲话风格了,若发现不能正常使用,请参考 [#12](https://github.com/wxxxcxx/ms-ra-forwarder/issues/12#issuecomment-1157271193) 获取更新。


## 部署

请参考下列部署方式。
Expand Down Expand Up @@ -107,7 +82,7 @@ npm run start

### 手动调用

接口地址为 `api/azure` 或 `api/ra`。格式为:
接口地址为`api/ra`。格式为:
```
POST /api/ra
FORMAT: audio-16khz-128kbitrate-mono-mp3
Expand Down Expand Up @@ -136,11 +111,6 @@ Content-Type: text/plain
如果需要防止他人滥用你的部署的服务,可以在应用的环境变量中添加 `TOKEN`,然后在请求头中添加 `Authorization: Bearer <TOKEN>`访问。
## 相关项目
- [ag2s20150909/TTS](https://github.com/ag2s20150909/TTS):安卓版,可代替系统自带的TTS。
- [litcc/tts-server](https://github.com/litcc/tts-server):Rust 版本。
## 其他说明
- 微软官方的 Azure TTS 服务目前拥有一定的免费额度,如果免费额度对你来说够用的话,请支持官方的服务。
Expand All @@ -151,6 +121,25 @@ Content-Type: text/plain
- **本项目仅供学习和参考,请勿商用。**
## 重要更改
**2023-04-19:Azure 下线了演示页面的试用功能,导致 Azure 版接口无法使用了,请各位迁移到 Edge 浏览器的接口吧。**
2022-11-18:添加词典文件支持,词典文件格式参考 https://github.com/wxxxcxx/azure-tts-lexicon-cn/blob/main/lexicon.xml 。
2022-09-10:修改 docker 仓库地址,后面构建的 docker 镜像会迁移到 wxxxcxx/ms-ra-forwarder(原仓库旧版本镜像依然有效)。
2022-09-01:Azure TTS API 好像又改了,旧版用户可能会无法正常使用,请更新到最新版。
2022-07-17:添加 Azure TTS API 支持(没怎么测试,不知道用起来稳不稳定)。因为调用 Azure TTS API 需要获取授权码。其它方式只需要或取一次就可以使用一段时间,而 Vercel 每次调用 API 都需要重新获取授权码。容易超时不说,也加剧了微软服务器的负担,所以不是很推荐部署在 Vercel 的用户使用(虽然也不是不能用~但是万一微软被薅痛了,又改接口就不好了😂)。
2022-07-02:Edge 版本的 API 目前测试还支持的格式有 `webm-24khz-16bit-mono-opu`、`audio-24khz-48kbitrate-mono-mp3`、`audio-24khz-96kbitrate-mono-mp3`。另外今天下午开始,使用不在下拉列表中声音会出现类似 “Unsupported voice zh-CN-YunyeNeural.” 错误,后续可能也会被砍掉。且用且珍惜吧!
2022-07-01:~~部署在中国大陆以外服务器上的服务目前只能选择 `webm-24khz-16bit-mono-opus` 格式的音频了!~~ 所以使用 Vercel 的用户需要重新部署一下。
2022-06-16:Edge 浏览器提供的接口现在已经不能设置讲话风格了,若发现不能正常使用,请参考 [#12](https://github.com/wxxxcxx/ms-ra-forwarder/issues/12#issuecomment-1157271193) 获取更新。
感谢以下组织或个人对本项目的支持
<img width="80" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" />

1 comment on commit 2509311

@vercel
Copy link

@vercel vercel bot commented on 2509311 Oct 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ms-ra-forwarder – ./

ms-ra-forwarder-git-master-wxxxcxx.vercel.app
ms-ra-forwarder-wxxxcxx.vercel.app
ms-ra-forwarder.vercel.app

Please sign in to comment.