{"_id":"@cantoo/text-to-speech","_rev":"6-ff49ea3a19e35ad768edcaa9d38883a7","name":"@cantoo/text-to-speech","dist-tags":{"latest":"7.0.1"},"versions":{"5.1.2":{"name":"@cantoo/text-to-speech","version":"5.1.2","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@cantoo/text-to-speech@5.1.2","maintainers":[{"name":"sharcoux","email":"f.billioud@gmail.com"},{"name":"ribeirofmatheus","email":"matheus_f.ribeiro@hotmail.com"},{"name":"matheusrdsantos","email":"matheus.r.d.s10@hotmail.com"},{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},{"name":"nicodemos234","email":"nicodemos54324@gmail.com"}],"homepage":"https://github.com/capacitor-community/text-to-speech#readme","bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"dist":{"shasum":"c573c99b0210197218334fb36491cd78718a7221","tarball":"https://registry.npmjs.org/@cantoo/text-to-speech/-/text-to-speech-5.1.2.tgz","fileCount":29,"integrity":"sha512-YrpiLGwBRcq+Xqc45bpLiXRA4mSc02xgZR4ZT2v87eEDJLnFBHrZHzGD7YgZISl1jFeo6Sxgbj5X9m/dtGlY/g==","signatures":[{"sig":"MEUCIQD1fHeL1Z4afYQmCy8ixbfRo1eKw9eIbBXIFgw33KHezgIgYgsFSQ9Q58DyBN36rk0Dm9i+4OPDh9NZVZeCAYHovZk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":92734},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"71d7ad2cc1f3fc8cb2a8ccec9040a86c67ece6c4","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api TextToSpeechPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"standard-version","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"sharcoux","email":"f.billioud@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"_npmVersion":"10.8.2","description":"Capacitor plugin for synthesizing speech from text.","directories":{},"_nodeVersion":"20.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"3.0.2","rollup":"2.77.2","prettier":"2.3.2","swiftlint":"1.0.1","typescript":"4.1.5","@capacitor/cli":"6.0.0","@capacitor/ios":"6.0.0","@capacitor/core":"6.0.0","standard-version":"9.5.0","@capacitor/docgen":"0.2.0","@capacitor/android":"6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"1.0.2","@ionic/prettier-config":"1.0.1","@ionic/swiftlint-config":"1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/text-to-speech_5.1.2_1741701214989_0.1323491448157148","host":"s3://npm-registry-packages-npm-production"}},"5.1.3":{"name":"@cantoo/text-to-speech","version":"5.1.3","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@cantoo/text-to-speech@5.1.3","maintainers":[{"name":"sharcoux","email":"f.billioud@gmail.com"},{"name":"ribeirofmatheus","email":"matheus_f.ribeiro@hotmail.com"},{"name":"matheusrdsantos","email":"matheus.r.d.s10@hotmail.com"},{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},{"name":"nicodemos234","email":"nicodemos54324@gmail.com"}],"homepage":"https://github.com/capacitor-community/text-to-speech#readme","bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"dist":{"shasum":"7712274532321ffb78bd0761eeeaecc60975d1be","tarball":"https://registry.npmjs.org/@cantoo/text-to-speech/-/text-to-speech-5.1.3.tgz","fileCount":28,"integrity":"sha512-h03qVUX1hWFARydrJNeSxnlYah8cJJE4LgfCmaIDt0OS8XiGvght2xxKSSoyHYp5Y60kqmW+umBYq8F+KsYFMg==","signatures":[{"sig":"MEUCIQCXlUZyKM75BLTpio5XzmWrKev87zyWrpNDxF6Fi/LNGAIgKG+o0zWkDgv75+Gk8gj3snQJy2ywYKsMxmy1+5MIoqY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":92162},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"3852cd5bfa44aba0a85814670152b3bc574cc997","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api TextToSpeechPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"standard-version","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"sharcoux","email":"f.billioud@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"_npmVersion":"10.8.2","description":"Capacitor plugin for synthesizing speech from text.","directories":{},"_nodeVersion":"20.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"3.0.2","rollup":"2.77.2","prettier":"2.3.2","swiftlint":"1.0.1","typescript":"4.1.5","@capacitor/cli":"6.0.0","@capacitor/ios":"6.0.0","@capacitor/core":"6.0.0","standard-version":"9.5.0","@capacitor/docgen":"0.2.0","@capacitor/android":"6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"1.0.2","@ionic/prettier-config":"1.0.1","@ionic/swiftlint-config":"1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/text-to-speech_5.1.3_1741702513288_0.12706478613522054","host":"s3://npm-registry-packages-npm-production"}},"5.1.4":{"name":"@cantoo/text-to-speech","version":"5.1.4","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@cantoo/text-to-speech@5.1.4","maintainers":[{"name":"sharcoux","email":"f.billioud@gmail.com"},{"name":"ribeirofmatheus","email":"matheus_f.ribeiro@hotmail.com"},{"name":"matheusrdsantos","email":"matheus.r.d.s10@hotmail.com"},{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},{"name":"nicodemos234","email":"nicodemos54324@gmail.com"}],"homepage":"https://github.com/capacitor-community/text-to-speech#readme","bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"dist":{"shasum":"9a8322fdd1e81424ab628706dcaf5acaec7094d4","tarball":"https://registry.npmjs.org/@cantoo/text-to-speech/-/text-to-speech-5.1.4.tgz","fileCount":29,"integrity":"sha512-xgIoArjPRMbU5g3iP1l6Dd8Yn/2kmLib7Jft4OKG2Pkax2gYPKWyfkpKMp+u0QARnHCYE6/Z43IhkJHU3HaAag==","signatures":[{"sig":"MEUCIA406xnWJ/nzkdVpjpSqzB91ZdDODVigyRJtdLdOUySCAiEA+tYjfhooYdVlKcfzJmvOJXbm23KlyadB+NAnMuGaGAY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":92710},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"5c704007e3df9726345d75a3340ec0e44403a0e1","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api TextToSpeechPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"standard-version","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"sharcoux","email":"f.billioud@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"_npmVersion":"10.8.2","description":"Capacitor plugin for synthesizing speech from text.","directories":{},"_nodeVersion":"20.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"3.0.2","rollup":"2.77.2","prettier":"2.3.2","swiftlint":"1.0.1","typescript":"4.1.5","@capacitor/cli":"6.0.0","@capacitor/ios":"6.0.0","@capacitor/core":"6.0.0","standard-version":"9.5.0","@capacitor/docgen":"0.2.0","@capacitor/android":"6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"1.0.2","@ionic/prettier-config":"1.0.1","@ionic/swiftlint-config":"1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/text-to-speech_5.1.4_1741702929135_0.8247033274330917","host":"s3://npm-registry-packages-npm-production"}},"7.0.0":{"name":"@cantoo/text-to-speech","version":"7.0.0","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@cantoo/text-to-speech@7.0.0","maintainers":[{"name":"sharcoux","email":"f.billioud@gmail.com"},{"name":"ribeirofmatheus","email":"matheus_f.ribeiro@hotmail.com"},{"name":"matheusrdsantos","email":"matheus.r.d.s10@hotmail.com"},{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},{"name":"nicodemos234","email":"nicodemos54324@gmail.com"}],"contributors":[{"url":"https://cantoo.fr","name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/capacitor-community/text-to-speech#readme","bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"dist":{"shasum":"15682ad100d4ba7d6646917d0020169775b30738","tarball":"https://registry.npmjs.org/@cantoo/text-to-speech/-/text-to-speech-7.0.0.tgz","fileCount":28,"integrity":"sha512-Tn1PJkAk8E+OYKtw5uiKfz+Pg9+9NInTbDUVjsQeBTOwapteIsRuHIlU6qKupro+k1GlZVXMKQZx+UFb8w0xmA==","signatures":[{"sig":"MEUCIEZOLai/6wI5dy+suxZpCmXQVm4OO3TrzvCrNtAY8YezAiEA/N8qmCZbh8yEJ1VpJ0P3xDyEvx1IDFzHpeC9lVaXzCQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":90948},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"76adf87cf25ed8dd495a7f271af3bdaa10ce5a7b","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api TextToSpeechPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"standard-version","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"_npmVersion":"9.5.1","description":"Capacitor plugin for synthesizing speech from text.","directories":{},"_nodeVersion":"24.5.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","standard-version":"9.5.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.6","@ionic/prettier-config":"4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/text-to-speech_7.0.0_1761316423139_0.9825595122489004","host":"s3://npm-registry-packages-npm-production"}},"7.0.1":{"name":"@cantoo/text-to-speech","version":"7.0.1","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@cantoo/text-to-speech@7.0.1","maintainers":[{"name":"sharcoux","email":"f.billioud@gmail.com"},{"name":"ribeirofmatheus","email":"matheus_f.ribeiro@hotmail.com"},{"name":"matheusrdsantos","email":"matheus.r.d.s10@hotmail.com"},{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},{"name":"nicodemos234","email":"nicodemos54324@gmail.com"}],"contributors":[{"url":"https://cantoo.fr","name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/capacitor-community/text-to-speech#readme","bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"dist":{"shasum":"b95a52ccca97831af0819c303bf77d0bdc4cc6fb","tarball":"https://registry.npmjs.org/@cantoo/text-to-speech/-/text-to-speech-7.0.1.tgz","fileCount":29,"integrity":"sha512-v+EuMY845tVZb9dr7sPpT9Gn0KSqBli0ypUM7eG0WI2BW6iEzy0J77gqTZEh9ZIFd0Tb0YnstWU4PTHO0yvYFw==","signatures":[{"sig":"MEQCIGNiZzOkU0pY1B+ATn4jwRPBQfZeoXMtygb8JjJWlj7PAiBubwfWaK1su8wFVE67BZMptANgZx03YG4941/AIpxzmg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":91484},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"f984fb6d627109d82c2829b42a12c80211378b05","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api TextToSpeechPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"standard-version","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"gabrielnsd","email":"gabrielnsdantas@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"_npmVersion":"9.5.1","description":"Capacitor plugin for synthesizing speech from text.","directories":{},"_nodeVersion":"24.5.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","standard-version":"9.5.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.6","@ionic/prettier-config":"4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/text-to-speech_7.0.1_1761317558681_0.388592653214874","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-03-11T13:53:34.890Z","modified":"2026-05-05T16:34:10.109Z","5.1.2":"2025-03-11T13:53:35.164Z","5.1.3":"2025-03-11T14:15:13.480Z","5.1.4":"2025-03-11T14:22:09.299Z","7.0.0":"2025-10-24T14:33:43.385Z","7.0.1":"2025-10-24T14:52:38.877Z"},"bugs":{"url":"https://github.com/capacitor-community/text-to-speech/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","homepage":"https://github.com/capacitor-community/text-to-speech#readme","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/capacitor-community/text-to-speech.git","type":"git"},"description":"Capacitor plugin for synthesizing speech from text.","contributors":[{"url":"https://cantoo.fr","name":"Cantoo","email":"dev@cantoo.fr"}],"maintainers":[{"email":"f.billioud@gmail.com","name":"sharcoux"},{"email":"matheus_f.ribeiro@hotmail.com","name":"ribeirofmatheus"},{"email":"matheus.r.d.s10@hotmail.com","name":"matheusrdsantos"},{"email":"gabrielnsdantas@gmail.com","name":"gabrielnsd"},{"email":"felipe@cantoo.fr","name":"felipecantoo"},{"email":"nicodemos54324@gmail.com","name":"nicodemos234"}],"readme":"<p align=\"center\"><br><img src=\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\" width=\"128\" height=\"128\" /></p>\n<h3 align=\"center\">Text to Speech</h3>\n<p align=\"center\"><strong><code>@capacitor-community/text-to-speech</code></strong></p>\n<p align=\"center\">\n  Capacitor community plugin for synthesizing speech from text.\n</p>\n\n<p align=\"center\">\n  <img src=\"https://img.shields.io/maintenance/yes/2025?style=flat-square\" />\n  <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>\n  <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>\n<br>\n  <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>\n  <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>\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n<a href=\"#contributors-\"><img src=\"https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square\" /></a>\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n</p>\n\n## Maintainers\n\n| Maintainer | GitHub                                    | Social                                        |\n| ---------- | ----------------------------------------- | --------------------------------------------- |\n| Robin Genz | [robingenz](https://github.com/robingenz) | [@robin_genz](https://twitter.com/robin_genz) |\n\n## Installation\n\n```\nnpm install @capacitor-community/text-to-speech\nnpx cap sync\n```\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Demo\n\nA working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)\n\n## Usage\n\n```typescript\nimport { TextToSpeech } from '@capacitor-community/text-to-speech';\n\nconst speak = async () => {\n  await TextToSpeech.speak({\n    text: 'This is a sample text.',\n    lang: 'en-US',\n    rate: 1.0,\n    pitch: 1.0,\n    volume: 1.0,\n    category: 'ambient',\n    queueStrategy: 1\n  });\n};\n\nconst stop = async () => {\n  await TextToSpeech.stop();\n};\n\nconst getSupportedLanguages = async () => {\n  const languages = await TextToSpeech.getSupportedLanguages();\n};\n\nconst getSupportedVoices = async () => {\n  const voices = await TextToSpeech.getSupportedVoices();\n};\n\nconst isLanguageSupported = async (lang: string) => {\n  const isSupported = await TextToSpeech.isLanguageSupported({ lang });\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`speak(...)`](#speak)\n* [`stop()`](#stop)\n* [`getSupportedLanguages()`](#getsupportedlanguages)\n* [`getSupportedVoices()`](#getsupportedvoices)\n* [`isLanguageSupported(...)`](#islanguagesupported)\n* [`openInstall()`](#openinstall)\n* [`addListener('onRangeStart', ...)`](#addlisteneronrangestart-)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### speak(...)\n\n```typescript\nspeak(options: TTSOptions) => Promise<void>\n```\n\nStarts the TTS engine and plays the desired text.\n\n| Param         | Type                                              |\n| ------------- | ------------------------------------------------- |\n| **`options`** | <code><a href=\"#ttsoptions\">TTSOptions</a></code> |\n\n--------------------\n\n\n### stop()\n\n```typescript\nstop() => Promise<void>\n```\n\nStops the TTS engine.\n\n--------------------\n\n\n### getSupportedLanguages()\n\n```typescript\ngetSupportedLanguages() => Promise<{ languages: string[]; }>\n```\n\nReturns a list of supported BCP 47 language tags.\n\n**Returns:** <code>Promise&lt;{ languages: string[]; }&gt;</code>\n\n--------------------\n\n\n### getSupportedVoices()\n\n```typescript\ngetSupportedVoices() => Promise<{ voices: SpeechSynthesisVoice[]; }>\n```\n\nReturns a list of supported voices.\n\n**Returns:** <code>Promise&lt;{ voices: SpeechSynthesisVoice[]; }&gt;</code>\n\n--------------------\n\n\n### isLanguageSupported(...)\n\n```typescript\nisLanguageSupported(options: { lang: string; }) => Promise<{ supported: boolean; }>\n```\n\nChecks if a specific BCP 47 language tag is supported.\n\n| Param         | Type                           |\n| ------------- | ------------------------------ |\n| **`options`** | <code>{ lang: string; }</code> |\n\n**Returns:** <code>Promise&lt;{ supported: boolean; }&gt;</code>\n\n--------------------\n\n\n### openInstall()\n\n```typescript\nopenInstall() => Promise<void>\n```\n\nVerifies proper installation and availability of resource files on the system.\n\nOnly available for Android.\n\n--------------------\n\n\n### addListener('onRangeStart', ...)\n\n```typescript\naddListener(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>\n```\n\n| Param              | Type                                                                                |\n| ------------------ | ----------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'onRangeStart'</code>                                                         |\n| **`listenerFunc`** | <code>(info: { start: number; end: number; spokenWord: string; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n--------------------\n\n\n### Interfaces\n\n\n#### TTSOptions\n\n| Prop                | Type                                                    | Description                                                                                                                                                                    | Default                          | Since |\n| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | ----- |\n| **`text`**          | <code>string</code>                                     | The text that will be synthesised when the utterance is spoken.                                                                                                                |                                  |       |\n| **`lang`**          | <code>string</code>                                     | The language of the utterance. Possible languages can be queried using `getSupportedLanguages`.                                                                                | <code>\"en-US\"</code>             |       |\n| **`rate`**          | <code>number</code>                                     | The speed at which the utterance will be spoken at.                                                                                                                            | <code>1.0</code>                 |       |\n| **`pitch`**         | <code>number</code>                                     | The pitch at which the utterance will be spoken at.                                                                                                                            | <code>1.0</code>                 |       |\n| **`volume`**        | <code>number</code>                                     | The volume that the utterance will be spoken at.                                                                                                                               | <code>1.0</code>                 |       |\n| **`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`.                                           |                                  |       |\n| **`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>           |       |\n| **`queueStrategy`** | <code><a href=\"#queuestrategy\">QueueStrategy</a></code> | Select the strategy to adopt when several requests to speak overlap.                                                                                                           | <code>QueueStrategy.Flush</code> | 5.1.0 |\n\n\n#### SpeechSynthesisVoice\n\nThe <a href=\"#speechsynthesisvoice\">SpeechSynthesisVoice</a> interface represents a voice that the system supports.\n\n| Prop               | Type                 | Description                                                                                                 |\n| ------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------- |\n| **`default`**      | <code>boolean</code> | Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).             |\n| **`lang`**         | <code>string</code>  | BCP 47 language tag indicating the language of the voice.                                                   |\n| **`localService`** | <code>boolean</code> | Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service. |\n| **`name`**         | <code>string</code>  | Human-readable name that represents the voice.                                                              |\n| **`voiceURI`**     | <code>string</code>  | Type of URI and location of the speech synthesis service for this voice.                                    |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n### Enums\n\n\n#### QueueStrategy\n\n| Members     | Value          | Description                                                                                                          |\n| ----------- | -------------- | -------------------------------------------------------------------------------------------------------------------- |\n| **`Flush`** | <code>0</code> | Use `Flush` to stop the current request when a new request is sent.                                                  |\n| **`Add`**   | <code>1</code> | Use `Add` to buffer the speech request. The request will be executed when all previous requests have been completed. |\n\n</docgen-api>\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capacitor-community/text-to-speech/blob/master/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capacitor-community/text-to-speech/blob/master/LICENSE).\n","readmeFilename":"README.md"}