Configuration
Configure global speech options with Speech.configure() and reset them with Speech.reset().
Configuring global speech options
Set global speech options that apply to all speech synthesis calls:
Speech.configure(options: VoiceOptions): voidSpeech.configure({
language: 'en-US',
volume: 1.0,
pitch: 1.2,
rate: 0.8,
ducking: false,
silentMode: 'obey', // iOS only; ignored if ducking is true
});VoiceOptions
| Property | Type | Description | Platform support |
|---|---|---|---|
language | string | Language code or IETF BCP 47 language tag (e.g., 'en-US', 'fr-FR') | Both |
volume | number | Volume level from 0.0 (silent) to 1.0 (maximum) | Both |
voice | string | Specific voice identifier to use (obtained from getAvailableVoices()) | Both |
pitch | number | Pitch multiplier: Android 0.1–2.0, iOS 0.5–2.0 | Both |
rate | number | Speech rate: Android 0.1–2.0, iOS varies based on AVSpeechUtterance limits | Both |
ducking | boolean | If true, temporarily lowers audio from other apps while speech is active. Defaults to false | Both |
silentMode | 'obey' | 'respect' | 'ignore' | Controls how speech interacts with the device's silent switch. Ignored if ducking is true | iOS only |
Silent mode (iOS only)
obey(default): does not change the app's audio session. Speech follows the system default behavior.respect: speech will be silenced by the ringer switch. Use for non-critical audio content.ignore: speech will play even if the ringer is off. Use for critical audio when ducking is not desired.
ducking is intended for critical announcements (for example, navigation) and takes priority over silentMode on iOS.
Resetting speech options
Reset all global speech options to their default values:
Speech.reset(): voidSpeech.reset();Per-utterance options
Individual speak() calls can override the global options — see Playback controls.