# @xeyqe/capacitor-tts > Capacitor tts plugin for Android. Latest version **0.0.7** (published 2025-11-10) · MIT license · 0 weekly downloads ## Install ```sh npm install @xeyqe/capacitor-tts pnpm add @xeyqe/capacitor-tts yarn add @xeyqe/capacitor-tts bun add @xeyqe/capacitor-tts ``` ## Health **Score 55/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads; pre 1.0. ## Facts | | | |---|---| | Version | 0.0.7 | | Published | 2025-11-10 | | First published | 2023-10-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 212 | | Unpacked size | 99.9 KB | | Known vulnerabilities | 0 (+4 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | xeyqe | | Maintainers | xeyqe | | Keywords | capacitor, plugin, native | ## Links - npm: https://www.npmjs.com/package/@xeyqe/capacitor-tts - Repository: https://github.com/xeyqe/capacitor-tts - Homepage: https://github.com/xeyqe/capacitor-tts#readme - Issues: https://github.com/xeyqe/capacitor-tts/issues - npm.io page: https://npm.io/package/@xeyqe/capacitor-tts ## Dependencies (212) - [ms](https://npm.io/package/ms.md) ^2.1.3 - [ajv](https://npm.io/package/ajv.md) ^8.17.1 - [has](https://npm.io/package/has.md) ^1.0.4 - [glob](https://npm.io/package/glob.md) ^11.0.1 - [gopd](https://npm.io/package/gopd.md) ^1.2.0 - [keyv](https://npm.io/package/keyv.md) ^5.2.3 - [levn](https://npm.io/package/levn.md) ^0.4.1 - [once](https://npm.io/package/once.md) ^1.4.0 - [yaml](https://npm.io/package/yaml.md) ^2.7.0 - [acorn](https://npm.io/package/acorn.md) 8.15.0 - [chalk](https://npm.io/package/chalk.md) ^5.4.1 - [debug](https://npm.io/package/debug.md) ^4.4.0 - [fastq](https://npm.io/package/fastq.md) ^1.19.1 - [isexe](https://npm.io/package/isexe.md) ^3.1.1 - [json5](https://npm.io/package/json5.md) ^2.2.3 - [slash](https://npm.io/package/slash.md) ^5.1.0 - [table](https://npm.io/package/table.md) ^6.9.0 - [tslib](https://npm.io/package/tslib.md) ^2.8.1 - [which](https://npm.io/package/which.md) ^5.0.0 - [braces](https://npm.io/package/braces.md) ^3.0.3 - [espree](https://npm.io/package/espree.md) ^10.3.0 - [globby](https://npm.io/package/globby.md) ^14.1.0 - [ignore](https://npm.io/package/ignore.md) ^7.0.3 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [merge2](https://npm.io/package/merge2.md) ^1.4.1 - [semver](https://npm.io/package/semver.md) ^7.7.1 - [uri-js](https://npm.io/package/uri-js.md) ^4.4.1 - [wrappy](https://npm.io/package/wrappy.md) ^1.0.2 - [deep-is](https://npm.io/package/deep-is.md) ^0.1.4 - [esprima](https://npm.io/package/esprima.md) ^4.0.1 - [esquery](https://npm.io/package/esquery.md) ^1.6.0 - [esutils](https://npm.io/package/esutils.md) ^2.0.3 - [flatted](https://npm.io/package/flatted.md) ^3.3.3 - [globals](https://npm.io/package/globals.md) ^16.0.0 - [is-glob](https://npm.io/package/is-glob.md) ^4.0.3 - [isarray](https://npm.io/package/isarray.md) ^2.0.5 - [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0 - [regexpp](https://npm.io/package/regexpp.md) ^3.2.0 - [resolve](https://npm.io/package/resolve.md) ^1.22.10 - [reusify](https://npm.io/package/reusify.md) ^1.1.0 - [tsutils](https://npm.io/package/tsutils.md) ^3.21.0 - [yallist](https://npm.io/package/yallist.md) ^5.0.0 - [argparse](https://npm.io/package/argparse.md) ^2.0.1 - [dir-glob](https://npm.io/package/dir-glob.md) ^3.0.1 - [doctrine](https://npm.io/package/doctrine.md) ^3.0.0 - [enquirer](https://npm.io/package/enquirer.md) ^2.4.1 - [error-ex](https://npm.io/package/error-ex.md) ^1.3.2 - [for-each](https://npm.io/package/for-each.md) ^0.3.5 - [fs-extra](https://npm.io/package/fs-extra.md) ^11.3.0 - [has-flag](https://npm.io/package/has-flag.md) ^5.0.1 - [inflight](https://npm.io/package/inflight.md) ^1.0.6 - [inherits](https://npm.io/package/inherits.md) ^2.0.4 - [is-regex](https://npm.io/package/is-regex.md) ^1.2.1 - [jsonfile](https://npm.io/package/jsonfile.md) ^6.1.0 - [minimist](https://npm.io/package/minimist.md) ^1.2.8 - [path-key](https://npm.io/package/path-key.md) ^4.0.0 - [progress](https://npm.io/package/progress.md) ^2.0.3 - [punycode](https://npm.io/package/punycode.md) ^2.3.1 - [acorn-jsx](https://npm.io/package/acorn-jsx.md) ^5.3.2 - [call-bind](https://npm.io/package/call-bind.md) ^1.0.8 - [callsites](https://npm.io/package/callsites.md) ^4.2.0 - [colorette](https://npm.io/package/colorette.md) ^2.0.20 - [esrecurse](https://npm.io/package/esrecurse.md) ^4.3.0 - [fast-glob](https://npm.io/package/fast-glob.md) ^3.3.3 - [get-stdin](https://npm.io/package/get-stdin.md) ^9.0.0 - [has-proto](https://npm.io/package/has-proto.md) ^1.2.0 - [is-bigint](https://npm.io/package/is-bigint.md) ^1.1.0 - [is-number](https://npm.io/package/is-number.md) ^7.0.0 - [is-string](https://npm.io/package/is-string.md) ^1.1.1 - [is-symbol](https://npm.io/package/is-symbol.md) ^1.1.1 - [js-tokens](https://npm.io/package/js-tokens.md) ^9.0.1 - [lru-cache](https://npm.io/package/lru-cache.md) ^11.0.2 - [minimatch](https://npm.io/package/minimatch.md) ^10.0.1 - [path-type](https://npm.io/package/path-type.md) ^6.0.0 - [picomatch](https://npm.io/package/picomatch.md) ^4.0.2 - [strip-bom](https://npm.io/package/strip-bom.md) ^5.0.0 - [tree-kill](https://npm.io/package/tree-kill.md) ^1.2.2 - [type-fest](https://npm.io/package/type-fest.md) ^4.36.0 - [untildify](https://npm.io/package/untildify.md) ^5.0.0 - [wrap-ansi](https://npm.io/package/wrap-ansi.md) ^9.0.0 - [ansi-regex](https://npm.io/package/ansi-regex.md) ^6.1.0 - [chevrotain](https://npm.io/package/chevrotain.md) ^11.0.3 - [color-name](https://npm.io/package/color-name.md) ^2.0.0 - [concat-map](https://npm.io/package/concat-map.md) ^0.0.2 - [estraverse](https://npm.io/package/estraverse.md) ^5.3.0 - [fill-range](https://npm.io/package/fill-range.md) ^7.1.1 - [flat-cache](https://npm.io/package/flat-cache.md) ^6.1.6 - [globalthis](https://npm.io/package/globalthis.md) ^1.0.4 - [is-extglob](https://npm.io/package/is-extglob.md) ^2.1.1 - [is-weakref](https://npm.io/package/is-weakref.md) ^1.1.1 - [micromatch](https://npm.io/package/micromatch.md) ^4.0.8 - [optionator](https://npm.io/package/optionator.md) ^0.9.4 - [parse-json](https://npm.io/package/parse-json.md) ^8.1.0 - [path-parse](https://npm.io/package/path-parse.md) ^1.0.7 - [prelude-ls](https://npm.io/package/prelude-ls.md) ^1.2.1 - [slice-ansi](https://npm.io/package/slice-ansi.md) ^7.1.0 - [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.1.3 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^7.1.0 - [text-table](https://npm.io/package/text-table.md) ^0.2.0 - [type-check](https://npm.io/package/type-check.md) ^0.4.0 - [ansi-colors](https://npm.io/package/ansi-colors.md) ^4.1.3 - [ansi-styles](https://npm.io/package/ansi-styles.md) ^6.2.1 - [array-union](https://npm.io/package/array-union.md) ^3.0.1 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^9.0.0 - [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.6 - [emoji-regex](https://npm.io/package/emoji-regex.md) ^10.4.0 - [es-abstract](https://npm.io/package/es-abstract.md) ^1.23.9 - [fs.realpath](https://npm.io/package/fs.realpath.md) ^1.0.0 - [glob-parent](https://npm.io/package/glob-parent.md) ^6.0.2 - [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.2.11 - [has-bigints](https://npm.io/package/has-bigints.md) ^1.1.0 - [has-symbols](https://npm.io/package/has-symbols.md) ^1.1.0 - [imurmurhash](https://npm.io/package/imurmurhash.md) ^0.1.4 - [is-arrayish](https://npm.io/package/is-arrayish.md) ^0.3.2 - [is-callable](https://npm.io/package/is-callable.md) ^1.2.7 - [java-parser](https://npm.io/package/java-parser.md) ^2.3.3 - [json-buffer](https://npm.io/package/json-buffer.md) ^3.0.1 - [object-keys](https://npm.io/package/object-keys.md) ^1.1.1 - [signal-exit](https://npm.io/package/signal-exit.md) ^4.1.0 - [astral-regex](https://npm.io/package/astral-regex.md) ^2.0.0 - [eslint-scope](https://npm.io/package/eslint-scope.md) ^8.2.0 - [eslint-utils](https://npm.io/package/eslint-utils.md) ^3.0.0 - [import-fresh](https://npm.io/package/import-fresh.md) ^3.3.1 - [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.2 - [resolve-from](https://npm.io/package/resolve-from.md) ^5.0.0 - [run-parallel](https://npm.io/package/run-parallel.md) ^1.2.0 - [side-channel](https://npm.io/package/side-channel.md) ^1.1.0 - [string-width](https://npm.io/package/string-width.md) ^7.2.0 - [universalify](https://npm.io/package/universalify.md) ^2.0.1 - [at-least-node](https://npm.io/package/at-least-node.md) ^1.0.0 - [color-convert](https://npm.io/package/color-convert.md) ^3.0.1 - [function-bind](https://npm.io/package/function-bind.md) ^1.1.2 - [get-intrinsic](https://npm.io/package/get-intrinsic.md) ^1.3.0 - [internal-slot](https://npm.io/package/internal-slot.md) ^1.1.0 - [object.assign](https://npm.io/package/object.assign.md) ^4.1.7 - [object.values](https://npm.io/package/object.values.md) ^1.2.1 - [parent-module](https://npm.io/package/parent-module.md) ^3.1.0 - [regexp-to-ast](https://npm.io/package/regexp-to-ast.md) ^0.5.0 - [shebang-regex](https://npm.io/package/shebang-regex.md) ^4.0.0 - [array-includes](https://npm.io/package/array-includes.md) 3.1.9 - [balanced-match](https://npm.io/package/balanced-match.md) ^3.0.1 - [github-slugger](https://npm.io/package/github-slugger.md) ^2.0.0 - [is-core-module](https://npm.io/package/is-core-module.md) ^2.16.1 - [is-date-object](https://npm.io/package/is-date-object.md) ^1.1.0 - [is-typed-array](https://npm.io/package/is-typed-array.md) ^1.1.15 - [object-inspect](https://npm.io/package/object-inspect.md) ^1.13.4 - [object.groupby](https://npm.io/package/object.groupby.md) ^1.0.3 - [supports-color](https://npm.io/package/supports-color.md) ^10.0.0 - [to-regex-range](https://npm.io/package/to-regex-range.md) ^5.0.1 - [tsconfig-paths](https://npm.io/package/tsconfig-paths.md) ^4.2.0 - [brace-expansion](https://npm.io/package/brace-expansion.md) 4.0.1 - [es-to-primitive](https://npm.io/package/es-to-primitive.md) ^1.3.0 - [fast-deep-equal](https://npm.io/package/fast-deep-equal.md) ^3.1.3 - [has-tostringtag](https://npm.io/package/has-tostringtag.md) ^1.0.2 - [is-array-buffer](https://npm.io/package/is-array-buffer.md) ^3.0.5 - [lodash.truncate](https://npm.io/package/lodash.truncate.md) ^4.4.2 - [natural-compare](https://npm.io/package/natural-compare.md) ^1.4.0 - [queue-microtask](https://npm.io/package/queue-microtask.md) ^1.2.3 - [safe-regex-test](https://npm.io/package/safe-regex-test.md) ^1.1.0 - [shebang-command](https://npm.io/package/shebang-command.md) ^2.0.0 - [unbox-primitive](https://npm.io/package/unbox-primitive.md) ^1.1.0 - [fast-levenshtein](https://npm.io/package/fast-levenshtein.md) ^3.0.0 - [file-entry-cache](https://npm.io/package/file-entry-cache.md) ^10.0.6 - [is-negative-zero](https://npm.io/package/is-negative-zero.md) ^2.0.3 - [is-number-object](https://npm.io/package/is-number-object.md) ^1.1.1 - [path-is-absolute](https://npm.io/package/path-is-absolute.md) ^2.0.0 - [v8-compile-cache](https://npm.io/package/v8-compile-cache.md) ^2.4.0 - [define-properties](https://npm.io/package/define-properties.md) ^1.2.1 - [is-boolean-object](https://npm.io/package/is-boolean-object.md) ^1.2.2 - [lines-and-columns](https://npm.io/package/lines-and-columns.md) ^2.0.4 - [safe-array-concat](https://npm.io/package/safe-array-concat.md) ^1.1.3 - [set-function-name](https://npm.io/package/set-function-name.md) ^2.0.2 - [which-typed-array](https://npm.io/package/which-typed-array.md) ^1.1.18 - [es-set-tostringtag](https://npm.io/package/es-set-tostringtag.md) ^2.1.0 - [object.fromentries](https://npm.io/package/object.fromentries.md) ^2.0.8 - [typed-array-buffer](https://npm.io/package/typed-array-buffer.md) ^1.0.3 - [typed-array-length](https://npm.io/package/typed-array-length.md) ^1.0.7 - [es-shim-unscopables](https://npm.io/package/es-shim-unscopables.md) ^1.1.0 - [eslint-module-utils](https://npm.io/package/eslint-module-utils.md) ^2.12.0 - [eslint-visitor-keys](https://npm.io/package/eslint-visitor-keys.md) ^4.2.0 - [require-from-string](https://npm.io/package/require-from-string.md) ^2.0.2 - [strip-json-comments](https://npm.io/package/strip-json-comments.md) ^5.0.1 - [array.prototype.flat](https://npm.io/package/array.prototype.flat.md) ^1.3.3 - [define-data-property](https://npm.io/package/define-data-property.md) ^1.1.4 - [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^5.0.0 - [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.31.0 - [functions-have-names](https://npm.io/package/functions-have-names.md) ^1.2.3 - [json-schema-traverse](https://npm.io/package/json-schema-traverse.md) ^1.0.0 - [string.prototype.trim](https://npm.io/package/string.prototype.trim.md) ^1.2.10 - [which-boxed-primitive](https://npm.io/package/which-boxed-primitive.md) ^1.1.1 - [available-typed-arrays](https://npm.io/package/available-typed-arrays.md) ^1.0.7 - [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^10.0.2 - [get-symbol-description](https://npm.io/package/get-symbol-description.md) ^1.1.0 - [is-shared-array-buffer](https://npm.io/package/is-shared-array-buffer.md) ^1.0.4 - [regexp.prototype.flags](https://npm.io/package/regexp.prototype.flags.md) ^1.5.4 - [array.prototype.flatmap](https://npm.io/package/array.prototype.flatmap.md) ^1.3.3 - [function.prototype.name](https://npm.io/package/function.prototype.name.md) ^1.1.8 - [is-fullwidth-code-point](https://npm.io/package/is-fullwidth-code-point.md) ^5.0.0 - [typed-array-byte-length](https://npm.io/package/typed-array-byte-length.md) ^1.0.3 - [typed-array-byte-offset](https://npm.io/package/typed-array-byte-offset.md) ^1.0.4 - [array-buffer-byte-length](https://npm.io/package/array-buffer-byte-length.md) ^1.0.2 - [has-property-descriptors](https://npm.io/package/has-property-descriptors.md) ^1.0.2 - [string.prototype.trimend](https://npm.io/package/string.prototype.trimend.md) ^1.0.9 - [functional-red-black-tree](https://npm.io/package/functional-red-black-tree.md) ^1.0.1 - [fast-json-stable-stringify](https://npm.io/package/fast-json-stable-stringify.md) ^2.1.0 - [string.prototype.trimstart](https://npm.io/package/string.prototype.trimstart.md) ^1.0.8 - [arraybuffer.prototype.slice](https://npm.io/package/arraybuffer.prototype.slice.md) ^1.0.4 - [eslint-import-resolver-node](https://npm.io/package/eslint-import-resolver-node.md) ^0.3.9 - [array.prototype.findlastindex](https://npm.io/package/array.prototype.findlastindex.md) 1.2.6 - [json-parse-even-better-errors](https://npm.io/package/json-parse-even-better-errors.md) ^4.0.0 - [supports-preserve-symlinks-flag](https://npm.io/package/supports-preserve-symlinks-flag.md) ^1.0.0 - [json-stable-stringify-without-jsonify](https://npm.io/package/json-stable-stringify-without-jsonify.md) ^1.0.1 ## Recent versions - 0.0.7 (latest) — 2025-11-10 - 0.0.6 — 2025-11-05 - 0.0.5 — 2025-08-28 - 0.0.4 — 2025-07-04 - 0.0.3 — 2025-03-01 - 0.0.2 — 2024-12-25 - 0.0.1 — 2023-10-06 ## README # capacitor-tts Capacitor tts plugin for Android. ## Install ```bash npm install capacitor-tts npx cap sync ``` ## API * [`speak(...)`](#speak) * [`read(...)`](#read) * [`stop()`](#stop) * [`getSupportedLanguages()`](#getsupportedlanguages) * [`getSupportedVoices()`](#getsupportedvoices) * [`getSupportedEngines()`](#getsupportedengines) * [`switchEngine(...)`](#switchengine) * [`getMaxSpeechInputLength()`](#getmaxspeechinputlength) * [`getDefaults()`](#getdefaults) * [`openInstall()`](#openinstall) * [`addListener('progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent', ...)`](#addlistenerprogressevent--progressarrayevent--audiofocuschangeevent-) * [`requestFocus()`](#requestfocus) * [`abandonFocus()`](#abandonfocus) * [Interfaces](#interfaces) ### speak(...) ```typescript speak(options: TTSOptions) => Promise ``` | Param | Type | | ------------- | ------------------------------------------------- | | **`options`** | TTSOptions | -------------------- ### read(...) ```typescript read(options: TTSReadOptions) => Promise ``` | Param | Type | | ------------- | --------------------------------------------------------- | | **`options`** | TTSReadOptions | -------------------- ### stop() ```typescript stop() => Promise ``` -------------------- ### getSupportedLanguages() ```typescript getSupportedLanguages() => Promise<{ languages: string[]; }> ``` **Returns:** Promise<{ languages: string[]; }> -------------------- ### getSupportedVoices() ```typescript getSupportedVoices() => Promise<{ voices: SpeechSynthesisVoice[]; }> ``` **Returns:** Promise<{ voices: SpeechSynthesisVoice[]; }> -------------------- ### getSupportedEngines() ```typescript getSupportedEngines() => Promise<{ engines: SpeechSynthesisEngine[]; }> ``` **Returns:** Promise<{ engines: SpeechSynthesisEngine[]; }> -------------------- ### switchEngine(...) ```typescript switchEngine(engineName: { engineName: string; }) => Promise ``` | Param | Type | | ---------------- | ------------------------------------ | | **`engineName`** | { engineName: string; } | -------------------- ### getMaxSpeechInputLength() ```typescript getMaxSpeechInputLength() => Promise<{ maxSpeechInputLength: number; }> ``` **Returns:** Promise<{ maxSpeechInputLength: number; }> -------------------- ### getDefaults() ```typescript 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() ```typescript openInstall() => Promise ``` -------------------- ### addListener('progressEvent' | 'progressArrayEvent' | 'audioFocusChangeEvent', ...) ```typescript 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 ``` | 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() ```typescript requestFocus() => Promise ``` -------------------- ### abandonFocus() ```typescript abandonFocus() => Promise ``` -------------------- ### 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> | --- _Source: https://npm.io/package/@xeyqe/capacitor-tts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._