@capacitor/screen-reader

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

安装

npm install @capacitor/screen-reader
npx cap sync

示例

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

ScreenReader.addListener('screenReaderStateChange', ({ value }) => {
  console.log(`屏幕阅读器现在已${value ? '开启' : '关闭'}`);
});

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

  console.log('VoiceOver 已启用？' + value);
};

const sayHello = async () => {
  await ScreenReader.speak({ value: 'Hello World!' });
};

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 plugin（Capacitor 社区文本转语音插件）。

参数	类型
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

---

接口

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

类型别名

StateChangeListener

(state: ScreenReaderState): void