@capacitor/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(`屏幕阅读器现在${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()
• Interfaces
• Type Aliases

isEnabled()

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

屏幕阅读器当前是否活动。

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

Returns: Promise<{ value: boolean; }>

Since: 1.0.0

---

speak(...)

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

文本转语音功能。

此功能仅在屏幕阅读器当前活动时才有效。

在 Web 上,浏览器必须支持 SpeechSynthesis API,否则此方法将抛出错误。

有关更多文本转语音功能,请参阅 Capacitor Community Text-to-Speech plugin。

Param	Type
options	SpeakOptions

Since: 1.0.0

---

addListener('stateChange', ...)

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

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

此事件以前名为 'accessibilityScreenReaderStateChange'。

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

Param	Type
eventName	'stateChange'
listener	StateChangeListener

Returns:

Promise<PluginListenerHandle>

Since: 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

删除附加到此插件的所有监听器。

Since: 1.0.0

---

Interfaces

SpeakOptions

Prop	Type	Description	Since
value	string	要朗读的文本。	1.0.0
language	string	朗读文本的语言,使用其 ISO 639-1 代码(例如："en")。此选项仅在 Android 上支持。	1.0.0

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

ScreenReaderState

Prop	Type	Description	Since
value	boolean	屏幕阅读器当前是否活动。	1.0.0

Type Aliases

StateChangeListener

(state: ScreenReaderState): void