メインコンテンツへスキップ
バージョン: v8

@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(`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()​

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 プラグインを参照してください。

パラメータ型
optionsSpeakOptions

開始バージョン 1.0.0

addListener('stateChange', ...)​

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

スクリーンリーダーがオンまたはオフになったときのリスナーを追加します。

このイベントは、以前は'accessibilityScreenReaderStateChange'という名前でした。

このメソッドはWebではサポートされていません（スクリーンリーダーを検出することはできません）。

パラメータ型
イベント名'stateChange'
リスナーStateChangeListener

戻り値: Promise<PluginListenerHandle>

開始バージョン 1.0.0

removeAllListeners()​

removeAllListeners() => Promise<void>

このプラグインにアタッチされているすべてのリスナーを削除します。

開始バージョン 1.0.0

インターフェース​

SpeakOptions​

プロパティ型説明開始バージョン
valuestring読み上げるテキスト。1.0.0
languagestringISO 639-1 コード (例: "en") でテキストを読み上げる言語。このオプションはAndroidでのみサポートされています。1.0.0

PluginListenerHandle​

プロパティ型
remove() => Promise<void>

ScreenReaderState​

プロパティ型説明開始バージョン
valuebooleanスクリーンリーダーが現在アクティブかどうか。1.0.0

型エイリアス​

StateChangeListener​

(state: ScreenReaderState): void

目次

このページを編集