{"_id":"@cantoo/speech-recognition","_rev":"5-c61e554add79c8ebdfd978cc97173999","name":"@cantoo/speech-recognition","dist-tags":{"latest":"7.0.4"},"versions":{"7.0.1":{"name":"@cantoo/speech-recognition","version":"7.0.1","keywords":["capacitor","plugin","native"],"author":{"name":"Priyank Patel","email":"priyank.patel@stackspace.ca"},"license":"MIT","_id":"@cantoo/speech-recognition@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":[{"name":"Matteo Padovano","email":"mrbatista@users.noreply.github.com"},{"name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/cantoo-scribe/speech-recognition#readme","bugs":{"url":"https://github.com/cantoo-scribe/speech-recognition/issues"},"dist":{"shasum":"9d0de4604af7e766448a2325dba3607a871660d0","tarball":"https://registry.npmjs.org/@cantoo/speech-recognition/-/speech-recognition-7.0.1.tgz","fileCount":30,"integrity":"sha512-uK/jslhC8owERTupLydW5GBzOgTG3an71Hmg8MZq7271DfNJuk11XySJdLtmUKyA1hHe/l32QaujIJiOCoDbCA==","signatures":[{"sig":"MEYCIQDo0F3JrYlksUQ+HzywzGMG9SMFiocJCnNbEHdMAtsElAIhALmRISbir4HZbq1uWMP6kjDXitYz4NbAviIHqsbPkbQ+","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":79262},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"88856b6424327a1c69ed0f1c393baf3eb2043b24","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 SpeechRecognitionPlugin --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/cantoo-scribe/speech-recognition.git","type":"git"},"_npmVersion":"9.5.1","description":"A native plugin for speech recognition","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/speech-recognition_7.0.1_1762769239790_0.31498450006859113","host":"s3://npm-registry-packages-npm-production"}},"7.0.2":{"name":"@cantoo/speech-recognition","version":"7.0.2","keywords":["capacitor","plugin","native"],"author":{"name":"Priyank Patel","email":"priyank.patel@stackspace.ca"},"license":"MIT","_id":"@cantoo/speech-recognition@7.0.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"}],"contributors":[{"name":"Matteo Padovano","email":"mrbatista@users.noreply.github.com"},{"name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/cantoo-scribe/speech-recognition#readme","bugs":{"url":"https://github.com/cantoo-scribe/speech-recognition/issues"},"dist":{"shasum":"7edbd97d8e28e6480810486ee8bdf01989b36956","tarball":"https://registry.npmjs.org/@cantoo/speech-recognition/-/speech-recognition-7.0.2.tgz","fileCount":30,"integrity":"sha512-Q0veN7WlI1u0i9dsk4Q1N2neIxVtYY+MwyrqvXcfwrHHep4avgPerIIDIMKGZtLtfWveY4895BNlo8Gih9mIdQ==","signatures":[{"sig":"MEYCIQDAXmF/WEN9vSgQuYYOcfa0o5ygvOJHuUPwPd7o1sVPZQIhALyplNjLS2Hn0fe7BijSs/+8YX0pLYsNmBoB85F7027L","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":79848},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"84f243d3ba8a78496f7865df924a33fee88b327e","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 SpeechRecognitionPlugin --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/cantoo-scribe/speech-recognition.git","type":"git"},"_npmVersion":"9.5.1","description":"A native plugin for speech recognition","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/speech-recognition_7.0.2_1762791428621_0.32005192205363797","host":"s3://npm-registry-packages-npm-production"}},"7.0.3":{"name":"@cantoo/speech-recognition","version":"7.0.3","keywords":["capacitor","plugin","native"],"author":{"name":"Priyank Patel","email":"priyank.patel@stackspace.ca"},"license":"MIT","_id":"@cantoo/speech-recognition@7.0.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"}],"contributors":[{"name":"Matteo Padovano","email":"mrbatista@users.noreply.github.com"},{"name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/cantoo-scribe/speech-recognition#readme","bugs":{"url":"https://github.com/cantoo-scribe/speech-recognition/issues"},"dist":{"shasum":"3f204476da3e683b6c58c6138ce10203a8446f4e","tarball":"https://registry.npmjs.org/@cantoo/speech-recognition/-/speech-recognition-7.0.3.tgz","fileCount":31,"integrity":"sha512-QUxpSEbJ1GbrhurI34C7Bkr4l7MQ6B46jd1+uWfeqTYkI5EWYKxtG4d+RIJRl5QPSaFzxXG6U+c26GccvOTyKw==","signatures":[{"sig":"MEUCIB3hd6kJ0vrBYyGql2jV3yUTz/OleOYPbd4Vn+V6YzUsAiEAvHunEkDRpEWSJoUXWL1E5j5RFkRLth8ELXL9AJ1fufs=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":80388},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"84f243d3ba8a78496f7865df924a33fee88b327e","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 SpeechRecognitionPlugin --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/cantoo-scribe/speech-recognition.git","type":"git"},"_npmVersion":"9.5.1","description":"A native plugin for speech recognition","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/speech-recognition_7.0.3_1762795577050_0.2253496894290341","host":"s3://npm-registry-packages-npm-production"}},"7.0.4":{"name":"@cantoo/speech-recognition","version":"7.0.4","keywords":["capacitor","plugin","native"],"author":{"name":"Priyank Patel","email":"priyank.patel@stackspace.ca"},"license":"MIT","_id":"@cantoo/speech-recognition@7.0.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"}],"contributors":[{"name":"Matteo Padovano","email":"mrbatista@users.noreply.github.com"},{"name":"Cantoo","email":"dev@cantoo.fr"}],"homepage":"https://github.com/cantoo-scribe/speech-recognition#readme","bugs":{"url":"https://github.com/cantoo-scribe/speech-recognition/issues"},"dist":{"shasum":"d87e3b616eb457bd69d818657b28b174216adbfb","tarball":"https://registry.npmjs.org/@cantoo/speech-recognition/-/speech-recognition-7.0.4.tgz","fileCount":31,"integrity":"sha512-aqepYvMO5fl6AJVqYGUUlPwAeCHuDn6G2uNcN5w1isMa3auuPfcbSYYOc4jm6xVIfIdVwFEzTVWiZmePYCj6Qw==","signatures":[{"sig":"MEUCIQCxkbV7y9Rl3m5cKiXzw4k5cx/s8+6IPgWwlyLIHnvIhgIgQkN6HR9KGIvWT1PGOVpmeBI63aQjTW0uDYChjEDrVO4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":85150},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"6307b222492ac58f488ffbd4f883ebc18661c76c","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 SpeechRecognitionPlugin --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/cantoo-scribe/speech-recognition.git","type":"git"},"_npmVersion":"9.5.1","description":"A native plugin for speech recognition","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/speech-recognition_7.0.4_1763114329872_0.43920151804409713","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-10T10:07:19.721Z","modified":"2026-05-05T16:34:09.404Z","7.0.1":"2025-11-10T10:07:19.965Z","7.0.2":"2025-11-10T16:17:08.805Z","7.0.3":"2025-11-10T17:26:17.244Z","7.0.4":"2025-11-14T09:58:50.065Z"},"bugs":{"url":"https://github.com/cantoo-scribe/speech-recognition/issues"},"author":{"name":"Priyank Patel","email":"priyank.patel@stackspace.ca"},"license":"MIT","homepage":"https://github.com/cantoo-scribe/speech-recognition#readme","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/cantoo-scribe/speech-recognition.git","type":"git"},"description":"A native plugin for speech recognition","contributors":[{"name":"Matteo Padovano","email":"mrbatista@users.noreply.github.com"},{"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":"# Capacitor Speech Recognition Plugin\n\nCapacitor community plugin for speech recognition.\n\n## Maintainers\n\n| Maintainer      | GitHub                                      | Social                                           |\n| --------------- | ------------------------------------------- | ------------------------------------------------ |\n| Priyank Patel   | [priyankpat](https://github.com/priyankpat) | [@priyankpat\\_](https://twitter.com/priyankpat_) |\n| Matteo Padovano | [mrbatista](https://github.com/mrbatista)   | [@mrba7ista](https://twitter.com/mrba7ista)      |\n\nMaintenance Status: Actively Maintained\n\n## Installation\n\nTo use npm\n\n```bash\nnpm install @capacitor-community/speech-recognition\n```\n\nTo use yarn\n\n```bash\nyarn add @capacitor-community/speech-recognition\n```\n\nSync native files\n\n```bash\nnpx cap sync\n```\n\n## iOS\n\niOS requires the following usage descriptions be added and filled out for your app in `Info.plist`:\n\n- `NSSpeechRecognitionUsageDescription` (`Privacy - Speech Recognition Usage Description`)\n- `NSMicrophoneUsageDescription` (`Privacy - Microphone Usage Description`)\n\n## Android\n\nNo further action required.\n\n## Supported methods\n\n<docgen-index>\n\n* [`available()`](#available)\n* [`start(...)`](#start)\n* [`stop()`](#stop)\n* [`getSupportedLanguages()`](#getsupportedlanguages)\n* [`isListening()`](#islistening)\n* [`checkPermissions()`](#checkpermissions)\n* [`requestPermissions()`](#requestpermissions)\n* [`addListener('endOfSegmentedSession', ...)`](#addlistenerendofsegmentedsession-)\n* [`addListener('segmentResults', ...)`](#addlistenersegmentresults-)\n* [`addListener('partialResults', ...)`](#addlistenerpartialresults-)\n* [`addListener('listeningState', ...)`](#addlistenerlisteningstate-)\n* [`removeAllListeners()`](#removealllisteners)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n## Example\n\n```typescript\nimport { SpeechRecognition } from \"@capacitor-community/speech-recognition\";\n\nSpeechRecognition.available();\n\nSpeechRecognition.start({\n  language: \"en-US\",\n  maxResults: 2,\n  prompt: \"Say something\",\n  partialResults: true,\n  popup: true,\n});\n// listen to partial results\nSpeechRecognition.addListener(\"partialResults\", (data: any) => {\n  console.log(\"partialResults was fired\", data.matches);\n});\n\n// stop listening partial results\nSpeechRecognition.removeAllListeners();\n\nSpeechRecognition.stop();\n\nSpeechRecognition.getSupportedLanguages();\n\nSpeechRecognition.checkPermissions();\n\nSpeechRecognition.requestPermissions();\n\nSpeechRecognition.hasPermission();\n\nSpeechRecognition.requestPermission();\n```\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### available()\n\n```typescript\navailable() => Promise<{ available: boolean; }>\n```\n\nThis method will check if speech recognition feature is available on the device.\n\n**Returns:** <code>Promise&lt;{ available: boolean; }&gt;</code>\n\n--------------------\n\n\n### start(...)\n\n```typescript\nstart(options?: UtteranceOptions | undefined) => Promise<{ matches?: string[]; }>\n```\n\nThis method will start to listen for utterance.\n\nif `partialResults` is `true`, the function respond directly without result and\nevent `partialResults` will be emit for each partial result, until stopped.\n\n| Param         | Type                                                          |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#utteranceoptions\">UtteranceOptions</a></code> |\n\n**Returns:** <code>Promise&lt;{ matches?: string[]; }&gt;</code>\n\n--------------------\n\n\n### stop()\n\n```typescript\nstop() => Promise<void>\n```\n\nThis method will stop listening for utterance\n\n--------------------\n\n\n### getSupportedLanguages()\n\n```typescript\ngetSupportedLanguages() => Promise<{ languages: any[]; }>\n```\n\nThis method will return list of languages supported by the speech recognizer.\n\nIt's not available on Android 13 and newer.\n\n**Returns:** <code>Promise&lt;{ languages: any[]; }&gt;</code>\n\n--------------------\n\n\n### isListening()\n\n```typescript\nisListening() => Promise<{ listening: boolean; }>\n```\n\nThis method will check if speech recognition is listening.\n\n**Returns:** <code>Promise&lt;{ listening: boolean; }&gt;</code>\n\n**Since:** 5.1.0\n\n--------------------\n\n\n### checkPermissions()\n\n```typescript\ncheckPermissions() => Promise<PermissionStatus>\n```\n\nCheck the speech recognition permission.\n\n**Returns:** <code>Promise&lt;<a href=\"#permissionstatus\">PermissionStatus</a>&gt;</code>\n\n**Since:** 5.0.0\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() => Promise<PermissionStatus>\n```\n\nRequest the speech recognition permission.\n\n**Returns:** <code>Promise&lt;<a href=\"#permissionstatus\">PermissionStatus</a>&gt;</code>\n\n**Since:** 5.0.0\n\n--------------------\n\n\n### addListener('endOfSegmentedSession', ...)\n\n```typescript\naddListener(eventName: 'endOfSegmentedSession', listenerFunc: () => void) => Promise<PluginListenerHandle>\n```\n\nCalled when allowForSilence set to &gt; 0 and segmented session has ended. (Android only)\n\nOn Android it doesn't work if popup is true.\n\n| Param              | Type                                 |\n| ------------------ | ------------------------------------ |\n| **`eventName`**    | <code>'endOfSegmentedSession'</code> |\n| **`listenerFunc`** | <code>() =&gt; void</code>           |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 6.0.2\n\n--------------------\n\n\n### addListener('segmentResults', ...)\n\n```typescript\naddListener(eventName: 'segmentResults', listenerFunc: (data: { matches: string[]; }) => void) => Promise<PluginListenerHandle>\n```\n\nCalled when allowForSilence set to &gt; 0 and segment result received. (Android only)\n\nOn Android it doesn't work if popup is true.\n\nProvides segment result.\n\n| Param              | Type                                                   |\n| ------------------ | ------------------------------------------------------ |\n| **`eventName`**    | <code>'segmentResults'</code>                          |\n| **`listenerFunc`** | <code>(data: { matches: string[]; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 6.0.2\n\n--------------------\n\n\n### addListener('partialResults', ...)\n\n```typescript\naddListener(eventName: 'partialResults', listenerFunc: (data: { matches: string[]; }) => void) => Promise<PluginListenerHandle>\n```\n\nCalled when partialResults set to true and result received.\n\nOn Android it doesn't work if popup is true.\n\nProvides partial result.\n\n| Param              | Type                                                   |\n| ------------------ | ------------------------------------------------------ |\n| **`eventName`**    | <code>'partialResults'</code>                          |\n| **`listenerFunc`** | <code>(data: { matches: string[]; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 2.0.2\n\n--------------------\n\n\n### addListener('listeningState', ...)\n\n```typescript\naddListener(eventName: 'listeningState', listenerFunc: (data: { status: 'started' | 'stopped'; }) => void) => Promise<PluginListenerHandle>\n```\n\nCalled when listening state changed.\n\n| Param              | Type                                                                |\n| ------------------ | ------------------------------------------------------------------- |\n| **`eventName`**    | <code>'listeningState'</code>                                       |\n| **`listenerFunc`** | <code>(data: { status: 'started' \\| 'stopped'; }) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 5.1.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promise<void>\n```\n\nRemove all the listeners that are attached to this plugin.\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### UtteranceOptions\n\n| Prop                  | Type                 | Description                                                                                                                                                                                |\n| --------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **`language`**        | <code>string</code>  | key returned from `getSupportedLanguages()`                                                                                                                                                |\n| **`maxResults`**      | <code>number</code>  | maximum number of results to return (5 is max)                                                                                                                                             |\n| **`prompt`**          | <code>string</code>  | prompt message to display on popup (Android only)                                                                                                                                          |\n| **`popup`**           | <code>boolean</code> | display popup window when listening for utterance (Android only)                                                                                                                           |\n| **`partialResults`**  | <code>boolean</code> | return partial results if found                                                                                                                                                            |\n| **`allowForSilence`** | <code>number</code>  | allows milliseconds of silence during recording. Needs number over 0 (Android only) You need to listen to segmentResults to receive the data. On Android it doesn't work if popup is true. |\n\n\n#### PermissionStatus\n\n| Prop                    | Type                                                        | Description                                                                                                                                                                      | Since |\n| ----------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`speechRecognition`** | <code><a href=\"#permissionstate\">PermissionState</a></code> | Permission state for speechRecognition alias. On Android it requests/checks RECORD_AUDIO permission On iOS it requests/checks the speech recognition and microphone permissions. | 5.0.0 |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n### Type Aliases\n\n\n#### PermissionState\n\n<code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>\n\n</docgen-api>\n","readmeFilename":"README.md"}