@capacitor/screen-reader

Screen Reader API 提供对 TalkBack/VoiceOver 等的访问，并为视觉无障碍提供简单的文本转语音功能。

安装

npm install @capacitor/screen-reader
npx cap sync

示例

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

ScreenReader.addListener('stateChange', ({ value }) => {
  console.log(`Screen reader is now ${value ? 'on' : 'off'}`);
});

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

  console.log('Voice over enabled? ' + value);
};

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

API 参考

• isEnabled()
• speak(...)
• addListener('stateChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

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 插件。

Param	Type
options	SpeakOptions

自版本： 1.0.0

---

addListener('stateChange', ...)

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

添加屏幕阅读器开启或关闭时的监听器。

此事件以前命名为 'accessibilityScreenReaderStateChange'。

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

Param	Type
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