@xeyqe/capacitor-tts NPM

capacitor-tts

Capacitor tts plugin for Android.

Install

npm install capacitor-tts
npx cap sync

API

speak(...)

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

Param	Type
`options`	TTSOptions

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', ...)

addListener(eventName: 'progressEvent', listenerFunc: (obj: { utteranceId: string; start: number; end: number; frame: number; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	'progressEvent'
`listenerFunc`	(obj: { utteranceId: string; start: number; end: number; frame: number; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

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.

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>

capacitor plugin native

acorn acorn-jsx ajv ansi-colors ansi-regex ansi-styles argparse array-buffer-byte-length array-includes array-union array.prototype.findlastindex array.prototype.flat array.prototype.flatmap arraybuffer.prototype.slice astral-regex at-least-node available-typed-arrays balanced-match brace-expansion braces call-bind callsites chalk chevrotain color-convert color-name colorette concat-map cosmiconfig cross-spawn debug deep-is define-data-property define-properties dir-glob doctrine emoji-regex enquirer error-ex es-abstract es-set-tostringtag es-shim-unscopables es-to-primitive escape-string-regexp eslint-config-prettier eslint-import-resolver-node eslint-module-utils eslint-plugin-import eslint-scope eslint-utils eslint-visitor-keys espree esprima esquery esrecurse estraverse esutils fast-deep-equal fast-glob fast-json-stable-stringify fast-levenshtein fastq file-entry-cache fill-range flat-cache flatted for-each fs-extra fs.realpath function-bind function.prototype.name functional-red-black-tree functions-have-names get-intrinsic get-stdin get-symbol-description github-slugger glob glob-parent globals globalthis globby gopd graceful-fs has has-bigints has-flag has-property-descriptors has-proto has-symbols has-tostringtag ignore import-fresh imurmurhash inflight inherits internal-slot is-array-buffer is-arrayish is-bigint is-boolean-object is-callable is-core-module is-date-object is-extglob is-fullwidth-code-point is-glob is-negative-zero is-number is-number-object is-regex is-shared-array-buffer is-string is-symbol is-typed-array is-weakref isarray isexe java-parser js-tokens js-yaml json-buffer json-parse-even-better-errors json-schema-traverse json-stable-stringify-without-jsonify json5 jsonfile keyv levn lines-and-columns lodash lodash.merge lodash.truncate lru-cache merge2 micromatch minimatch minimist ms natural-compare object-inspect object-keys object.assign object.fromentries object.groupby object.values once optionator parent-module parse-json path-is-absolute path-key path-parse path-type picomatch prelude-ls progress punycode queue-microtask regexp-to-ast regexp.prototype.flags regexpp require-from-string resolve resolve-from reusify run-parallel safe-array-concat safe-regex-test semver set-function-name shebang-command shebang-regex side-channel signal-exit slash slice-ansi sprintf-js string-width string.prototype.trim string.prototype.trimend string.prototype.trimstart strip-ansi strip-bom strip-json-comments supports-color supports-preserve-symlinks-flag table text-table to-regex-range tree-kill tsconfig-paths tslib tsutils type-check type-fest typed-array-buffer typed-array-byte-length typed-array-byte-offset typed-array-length unbox-primitive universalify untildify uri-js v8-compile-cache which which-boxed-primitive which-typed-array wrap-ansi wrappy yallist yaml

@everything-registry/sub-chunk-1028

0.0.1

7 months ago