@xeyqe/capacitor-tts

capacitor-tts

Capacitor tts plugin for Android.

Install

npm install capacitor-tts
npx cap sync

API

• speak(...)
• read(...)
• stop()
• getSupportedLanguages()
• getSupportedVoices()
• getSupportedEngines()
• switchEngine(...)
• getMaxSpeechInputLength()
• getDefaults()
• openInstall()
• addListener('progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent', ...)
• requestFocus()
• abandonFocus()
• Interfaces

speak(...)

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

Param	Type
options	TTSOptions

---

read(...)

read(options: TTSReadOptions) => Promise<void>

Param	Type
options	TTSReadOptions

---

stop()

stop() => Promise<void>

---

getSupportedLanguages()

getSupportedLanguages() => Promise<{ languages: string[]; }>

Returns: Promise<{ languages: string[]; }>

---

getSupportedVoices()

getSupportedVoices() => Promise<{ voices: SpeechSynthesisVoice[]; }>

Returns: Promise<{ voices: SpeechSynthesisVoice[]; }>

---

getSupportedEngines()

getSupportedEngines() => Promise<{ engines: SpeechSynthesisEngine[]; }>

Returns: Promise<{ engines: SpeechSynthesisEngine[]; }>

---

switchEngine(...)

switchEngine(engineName: { engineName: string; }) => Promise<void>

Param	Type
engineName	{ engineName: string; }

---

getMaxSpeechInputLength()

getMaxSpeechInputLength() => Promise<{ maxSpeechInputLength: number; }>

Returns: Promise<{ maxSpeechInputLength: number; }>

---

getDefaults()

getDefaults() => Promise<{ audioStreamType: 'DEFAULT_STREAM_TYPE'; engine: string; language: string; pan: number; pitch: number; rate: number; voiceURI: string; volume: number; }>

Returns: Promise<{ audioStreamType: 'DEFAULT_STREAM_TYPE'; engine: string; language: string; pan: number; pitch: number; rate: number; voiceURI: string; volume: number; }>

---

openInstall()

openInstall() => Promise<void>

---

addListener('progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent', ...)

addListener(eventName: 'progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent', listenerFunc: (obj: { utteranceId?: string; start?: number; end?: number; frame?: number; progress?: number; type?: 'AUDIOFOCUS_GAIN' | 'AUDIOFOCUS_LOSS' | 'AUDIOFOCUS_LOSS_TRANSIENT' | 'AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK'; }) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent'
listenerFunc	(obj: { utteranceId?: string; start?: number; end?: number; frame?: number; progress?: number; type?: 'AUDIOFOCUS_GAIN' | 'AUDIOFOCUS_LOSS' | 'AUDIOFOCUS_LOSS_TRANSIENT' | 'AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK'; }) => void

Returns: Promise<PluginListenerHandle>

---

requestFocus()

requestFocus() => Promise<void>

---

abandonFocus()

abandonFocus() => Promise<void>

---

Interfaces

TTSOptions

Prop	Type	Description	Default
text	string	The text that will be synthesised when the utterance is spoken.
rate	number	The speed at which the utterance will be spoken at.	1.0
pitch	number	The pitch at which the utterance will be spoken at.	1.0
volume	number	The volume that the utterance will be spoken at.	1.0
pan	number	Parameter key to specify how the speech is panned from left to right when speaking text. Pan is specified as a float ranging from -1 to +1 where -1 maps to a hard-left pan, 0 to center (the default behavior), and +1 to hard-right.	0.0
voiceURI	number	The index of the selected voice that will be used to speak the utterance. Possible voices can be queried using getSupportedVoices.
streamType	'STREAM_ALARM' | 'STREAM_DTMF' | 'STREAM_MUSIC' | 'STREAM_NOTIFICATION' | 'STREAM_RING' | 'STREAM_SYSTEM' | 'STREAM_VOICE_CALL'	Parameter key to specify the audio stream type to be used when speaking text or playing back a file. The value should be one of the STREAM_ constants defined in AudioManager.

TTSReadOptions

Prop	Type	Description	Default
texts	string[]	The text that will be synthesised when the utterance is spoken.
progress	number
rate	number	The speed at which the utterance will be spoken at.	1.0
pitch	number	The pitch at which the utterance will be spoken at.	1.0
volume	number	The volume that the utterance will be spoken at.	1.0
pan	number	Parameter key to specify how the speech is panned from left to right when speaking text. Pan is specified as a float ranging from -1 to +1 where -1 maps to a hard-left pan, 0 to center (the default behavior), and +1 to hard-right.	0.0
voiceURI	number	The index of the selected voice that will be used to speak the utterance. Possible voices can be queried using getSupportedVoices.
streamType	'STREAM_ALARM' | 'STREAM_DTMF' | 'STREAM_MUSIC' | 'STREAM_NOTIFICATION' | 'STREAM_RING' | 'STREAM_SYSTEM' | 'STREAM_VOICE_CALL'	Parameter key to specify the audio stream type to be used when speaking text or playing back a file. The value should be one of the STREAM_ constants defined in AudioManager.
bookId	number	for my app only

SpeechSynthesisVoice

Prop	Type	Description
default	boolean	Specifies whether the voice is the default voice for the current app (true) or not (false).
lang	string	BCP 47 language tag indicating the language of the voice.
localService	boolean	Specifies whether the voice is supplied by a local (true) or remote (false) speech synthesizer service.
name	string	Human-readable name that represents the voice.
voiceURI	string	Type of URI and location of the speech synthesis service for this voice.

SpeechSynthesisEngine

Prop	Type
icon	number
label	string
name	string

PluginListenerHandle

Prop	Type
remove	() => Promise<void>