争渡读屏API(ZDSRAPI)是争渡读屏提供的一组接口。
- 32位接口
ZDSRAPI.dll - 64位接口
ZDSRAPI_x64.dll - 用户自定义参数配置文件
ZDSRAPI.ini
上述三个文件位于争渡读屏安装目录下,通常位于: C:\Program Files(x86)\zdsr\zdsr 内。
应用程序可以直接调用争渡读屏安装目录下的相应 dll 文件,或者直接把 dll 复制到指定的目录调用均可。
注: 争渡读屏 26.6 dll 文件有更新,在此之前,如果你的应用程序自带了 ZDSRAPI.dll 或 ZDSRAPI_x64.dll 就需要重新复制新的 dll 文件。另外建议直接读取争渡读屏安装目录下的 dll 文件,尽量不要复制到自己程序目录。
ZDSRAPI.ini 的参数设定优先级高于程序调用。该文件可以放置在调用进程目录下或者 zdsrapi.dll所在目录下。
- 名称: 争渡读屏API(ZDSRAPI)
- 版本: 1
1 初始化语音接口
int WINAPI InitTTS(int type, const WCHAR* channelName, BOOL bKeyDownInterrupt)
参数:
[in] int type: 0 读屏通道; 1 独立通道
[in] const WCHAR* channelName: type为0时忽略,传入NULL; type为1时:独立通道名称, NULL或空字符串时,将使用默认名称"API"
[in] BOOL bKeyDownInterrupt: TRUE 按键打断; FALSE 按键不打断
返回值:
0:成功
1:版本不匹配
备注:
该函数可被重复调用,如需更改朗读通道及打断策略参数,可直接使用新的参数重复调用。
2 朗读文本
int WINAPI Speak(const WCHAR* text, BOOL bInterrupt)
参数:
[in] const WCHAR* text: 要朗读的文本,Unicode
[in] BOOL bInterrupt: TRUE:清空排队,立刻打断朗读, FALSE:等待空闲时朗读
返回值:
0: 成功
1: 版本不匹配
2: 争渡读屏没有运行或没有授权
8: 命令没有成功送达
9: 独立通道尚未就绪
3 获取朗读状态
int WINAPI GetSpeakState()
返回值:
1: 版本不匹配
2: 争渡读屏没有运行或没有授权
3: 正在朗读
4: 没有朗读
8: 命令没有成功送达
9: 独立通道尚未就绪
4 停止朗读
void WINAPI StopSpeak()
返回值:
void
5 点显器输出盲文
int WINAPI Braille(const WCHAR* text, BOOL bFlashMessage)
参数:
[in] const WCHAR* text: 要显示的文本,Unicode
[in] BOOL bFlashMessage: TRUE:闪屏消息(超时后自动恢复到之前状态), FALSE:普通文本
返回值:
0: 成功
1: 版本不匹配
2: 争渡读屏没有运行或没有授权
3: 没有连接点显器设备
8: 命令没有成功送达