@capacitor/screen-reader

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

安装

npm install @capacitor/screen-reader@latest-7
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: '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 插件。

参数	类型
options	SpeakOptions

自： 1.0.0

---

addListener('stateChange', ...)

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

添加监听器，用于监听屏幕阅读器的开启或关闭事件。

此事件曾命名为 'accessibilityScreenReaderStateChange'。

此方法在 Web 平台上不受支持（无法检测到屏幕阅读器）。

参数	类型
eventName	'stateChange'
listener	StateChangeListener

返回值：

Promise<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