争渡读屏 Web API 是以 HTTP 请求方式提供的一组接口。目前主要用于调用读屏的语音引擎进行朗读和点显器进行输出盲文。
1. 基础信息
- GET / POST URI:
http://127.0.0.1:26516/api - WebSocket URI:
ws://127.0.0.1:26516/api
2. 通用参数
所有请求均需包含 action 参数，用于指定操作类型。可选值如下：
Speak：语音朗读Braille：点显器输出GetSpeakState：获取朗读状态Stop：停止朗读
3. 接口详情
3.1 Speak (语音朗读)
请求参数：
| 参数名 | 说明 |
|---|---|
channel | 通道选择：0 读屏通道1 独立通道 |
text | 需要朗读的文本内容 |
interrupt | 朗读策略：0 排队1 打断 |
返回值：
| 返回值 | 说明 |
|---|---|
0 | 成功 |
2 | 没有授权 |
9 | 独立通道尚未就绪 |
3.2 Braille (点显器输出)
请求参数：
| 参数名 | 说明 |
|---|---|
text | 需要输出的文本内容 |
FlashMessage | 消息类型：0 普通消息1 闪屏消息 |
返回值：
| 返回值 | 说明 |
|---|---|
0 | 成功 |
2 | 没有授权 |
3 | 没有连接点显器 |
3.3 GetSpeakState (获取朗读状态)
请求参数：
| 参数名 | 说明 |
|---|---|
channel | 通道选择：0 读屏通道1 独立通道 |
返回值：
| 返回值 | 说明 |
|---|---|
2 | 没有授权 |
3 | 正在朗读 |
4 | 没有朗读 |
9 | 独立通道尚未就绪 |
3.4 Stop (停止朗读)
请求参数：
| 参数名 | 说明 |
|---|---|
channel | 通道选择：0 读屏通道1 独立通道 |
返回值： 无
4. 请求示例
GET 请求示例
http://127.0.0.1:26516/api?action=speak&text=%E4%BD%A0%E5%A5%BD&channel=1&interrupt=1
WebSocket 请求示例
{
"action": "speak",
"text": "你好",
"channel": "1",
"interrupt": "1"
}