Awesome

<img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /> <h3 align="center">Text to Speech</h3> <code>@capacitor-community/text-to-speech</code> Capacitor community plugin for synthesizing speech from text. <img src="https://img.shields.io/maintenance/yes/2024?style=flat-square" /> <a href="https://github.com/capacitor-community/text-to-speech/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/actions/workflow/status/capacitor-community/text-to-speech/ci.yml?branch=master&style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capacitor-community/text-to-speech"><img src="https://img.shields.io/npm/l/@capacitor-community/text-to-speech?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capacitor-community/text-to-speech"><img src="https://img.shields.io/npm/dw/@capacitor-community/text-to-speech?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capacitor-community/text-to-speech"><img src="https://img.shields.io/npm/v/@capacitor-community/text-to-speech?style=flat-square" /></a>  <a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square" /></a>

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Installation

npm install @capacitor-community/text-to-speech
npx cap sync

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

import { TextToSpeech } from '@capacitor-community/text-to-speech';

const speak = async () => {
  await TextToSpeech.speak({
    text: 'This is a sample text.',
    lang: 'en-US',
    rate: 1.0,
    pitch: 1.0,
    volume: 1.0,
    category: 'ambient',
    queueStrategy: 1
  });
};

const stop = async () => {
  await TextToSpeech.stop();
};

const getSupportedLanguages = async () => {
  const languages = await TextToSpeech.getSupportedLanguages();
};

const getSupportedVoices = async () => {
  const voices = await TextToSpeech.getSupportedVoices();
};

const isLanguageSupported = async (lang: string) => {
  const isSupported = await TextToSpeech.isLanguageSupported({ lang });
};

API

<docgen-index>

speak(...)
stop()
getSupportedLanguages()
getSupportedVoices()
isLanguageSupported(...)
openInstall()
addListener('onRangeStart', ...)
Interfaces
Enums

</docgen-index> <docgen-api>

speak(...)

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

Starts the TTS engine and plays the desired text.

Param	Type
`options`	<code><a href="#ttsoptions">TTSOptions</a></code>

stop()

stop() => Promise<void>

Stops the TTS engine.

getSupportedLanguages()

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

Returns a list of supported BCP 47 language tags.

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

getSupportedVoices()

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

Returns a list of supported voices.

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

isLanguageSupported(...)

isLanguageSupported(options: { lang: string; }) => Promise<{ supported: boolean; }>

Checks if a specific BCP 47 language tag is supported.

Param	Type
`options`	<code>{ lang: string; }</code>

Returns: <code>Promise<{ supported: boolean; }></code>

openInstall()

openInstall() => Promise<void>

Verifies proper installation and availability of resource files on the system.

Only available for Android.

addListener('onRangeStart', ...)

addListener(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>

Param	Type
`eventName`	<code>'onRangeStart'</code>
`listenerFunc`	<code>(info: { start: number; end: number; spokenWord: string; }) => void</code>

Returns: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>

Interfaces

TTSOptions

Prop	Type	Description	Default
`text`	<code>string</code>	The text that will be synthesised when the utterance is spoken.
`lang`	<code>string</code>	The language of the utterance. Possible languages can be queried using `getSupportedLanguages`.	<code>"en-US"</code>
`rate`	<code>number</code>	The speed at which the utterance will be spoken at.	<code>1.0</code>
`pitch`	<code>number</code>	The pitch at which the utterance will be spoken at.	<code>1.0</code>
`volume`	<code>number</code>	The volume that the utterance will be spoken at.	<code>1.0</code>
`voice`	<code>number</code>	The index of the selected voice that will be used to speak the utterance. Possible voices can be queried using `getSupportedVoices`.
`category`	<code>string</code>	Select the iOS Audio session category. Possible values: `ambient` and `playback`. Use `playback` to play audio even when the app is in the background. Only available for iOS.	<code>"ambient"</code>
`queueStrategy`	<code><a href="#queuestrategy">QueueStrategy</a></code>	Select the strategy to adopt when several requests to speak overlap.	<code>QueueStrategy.Flush</code>

SpeechSynthesisVoice

The <a href="#speechsynthesisvoice">SpeechSynthesisVoice</a> interface represents a voice that the system supports.

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

PluginListenerHandle

Prop	Type
`remove`	<code>() => Promise<void></code>

Enums

QueueStrategy

Members	Value	Description
`Flush`	<code>0</code>	Use `Flush` to stop the current request when a new request is sent.
`Add`	<code>1</code>	Use `Add` to buffer the speech request. The request will be executed when all previous requests have been completed.

</docgen-api>

Changelog

See CHANGELOG.md.

License

See LICENSE.