@capacitor/screen-reader

Screen Reader API 提供了对 TalkBack/VoiceOver 等屏幕朗读功能的访问，并为视觉辅助功能提供简单的文本转语音能力。

安装

npm install @capacitor/screen-reader@latest-5
npx cap sync

示例

import { ScreenReader } from '@capacitor/screen-reader';

ScreenReader.addListener('stateChange', ({ value }) => {
  console.log(`屏幕朗读功能当前${value ? '已开启' : '已关闭'}`);
});

const checkScreenReaderEnabled = async () => {
  const { value } = await ScreenReader.isEnabled();

  console.log('语音朗读已启用？' + value);
};

const sayHello = async () => {
  await ScreenReader.speak({ value: '你好世界！' });
};

API

• isEnabled()
• speak(...)
• addListener('stateChange', ...)
• removeAllListeners()
• 接口
• 类型别名

isEnabled()

isEnabled() => Promise<{ value: boolean; }>

检查当前是否有屏幕朗读功能处于活动状态。

此方法在 Web 平台上不受支持（无法检测屏幕朗读功能）。

返回值: Promise<{ value: boolean; }>

自版本: 1.0.0

---

speak(...)

speak(options: SpeakOptions) => Promise<void>

文本转语音功能。

此功能仅在屏幕朗读功能处于活动状态时有效。

在 Web 平台上，浏览器必须支持 SpeechSynthesis API，否则此方法会抛出错误。

如需更强大的文本转语音功能，请参阅 Capacitor Community Text-to-Speech 插件。

参数	类型
options	SpeakOptions

自版本: 1.0.0

---

addListener('stateChange', ...)

addListener(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

添加监听器，用于监听屏幕朗读功能的开关状态变化。

此事件曾命名为 'accessibilityScreenReaderStateChange'。

此方法在 Web 平台上不受支持（无法检测屏幕朗读功能）。

参数	类型
eventName	'stateChange'
listener	StateChangeListener

返回值:

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

移除当前插件附加的所有监听器。

自版本: 1.0.0

---

Interfaces

SpeakOptions

属性	类型	描述	版本
value	string	要朗读的文本。	1.0.0
language	string	朗读文本的语言，使用 ISO 639-1 语言代码（例如："en"）。此选项仅在 Android 平台受支持。	1.0.0

PluginListenerHandle

属性	类型
remove	() => Promise<void>

ScreenReaderState

属性	类型	描述	版本
value	boolean	表示屏幕朗读功能当前是否处于活动状态。	1.0.0

Type Aliases

StateChangeListener

  (state: ScreenReaderState): void