speech_to_text

• Updates minimum supported SDK version to Flutter 3.44/Dart 3.12.
• Migrates to built-in Kotlin

New

• Android now respects the pauseFor value

Fix

• Fixed Swift concurrency error with captured variables in Task closure on iOS - resolves build failure with "Reference to captured var 'localeStr' in concurrently-executing code"
• Fixed communication threading issue for Windows version of the plugin
• Fixed conditional compilation for Windows version of the plugin

New

• Partial Windows speech support thanks to @asherchok for the PR. This is the first draft. version of Windows support and is not yet working properly. However it should now be possible to build for Windows without even if speech recognition does not work properly.

Fix

• Issue with numeric conversion for Web thanks to @uniqdev-id for the PR.
• iOS now performs speech work on a separate thread to avoid UI pauses

New

• Updated to latest build configuration for Android
• Updated to use Swift packages instead of pods

Fix

• Address incorrect language tag format on Android

New

• support for web search recognition type on Android thanks to @vongrad for the PR
• example app improvements to expose more options, provide help, and improve behaviour on smaller devices.

Fix

• on iOS there is a new bug in their speech recognition that resets the transcription after a pause in the users' speech. This version attempts a mitigation by using meta information from the recognizer to concatenate subsequent transcriptions so the whole is not lost. There are problems with this approach, notably extra capitalization and possibly incorrects spaces being added. The concatenated transcription is added as the first result but all other results are still the same. See issue #552 for details.

New

• support for speech recognition on MacOS
• supports WASM compliation for web

Fix

• Remove support for deprecated v1 Android registration #545
• Update deprecated Android build settings
• Improves handling of possible duplicates from the locales() method to ensure they are removed
• Language codes are properly handled for on device recognition on Android

New

• on iOS now mixes audio with other uses to allow multiple audio plugins to coexist

Fix

• Second iOS listen now starts faster

New

• More detailed error returns on iOS
• Updated JS dependency to 0.7.1 (would it kill you to release a 1.0 version?)

New

• listen now has a new SpeechListenOptions listenOptions parameter to specify the recognizer options for the listen session. Some of the separate parameters have been deprecated as a result. See the listen method for documentation.
• SpeechListenOptions.enableHapticFeedback is a new option which allows haptic feedback during speech recognition on iOS. Usually haptics are disabled to avoid interfering with the microphone.
• SpeechListenOptions.autoPunctuation is a new option which turns on automatic punction inference during speech recognition on iOS.

What's Changed

• Add setPauseFor method for late setup by @JekaNS in #403
• Improved documentation by @Bungeefan in #406
• Fix crash for some android device when completeInitialize() in for below Android 31 Device by @haresh-v521 in #409
• Update speech_to_text_provider.dart by @BrianKolowitz in #444
• Update build.gradle by @m-derakhshi in #422
• Remove init checks for locales by @figengungor in #344

New Contributors

• @JekaNS made their first contribution in #403
• @Bungeefan made their first contribution in #406
• @haresh-v521 made their first contribution in #409
• @BrianKolowitz made their first contribution in #444
• @m-derakhshi made their first contribution in #422
• @figengungor made their first contribution in #344

Full Changelog: v6.2.0...v6.5.1

Fix

• Removed BLUETOOTH_CONNECT permission from the plugin Android manifest, should be in apps

New

• SpeechToText.webDoNotAggregate option for use in the option parameter of the initialize method. This can be used to change the behaviour on some browsers that implement the speech API differently. Test the user agent to decided whether to set this option. Currently it seems to be required on mobile Android to prevent duplicate results.

Fix

• Removed incorrect MODIFY_PHONE_STATE permission from Android manifest

Fix

• Fix web handling of alternates and multiple phrases was incorrect. Before this change multiple phrases were being seen as alternates. This properly combines those phrases into a single set of recognized words and produces alternates as appropriate.

• Android 33+ now returns a valid list from locales. It returns the supported on device languages. This is (probably) smaller than the full list of online languages but better than the current list that only has the default language in it. It also seems to be the only option that's available.

New

• New changePauseFor method allows the pause duration to be modified during a listen session.

Fix

• Documentation cleanup and improvements, thanks @Bungeefan
• Crash on Android versions 11 and below

New

• Upgrades and fixes for Flutter 3.0

Fix

• Error status is cleared on each listen call.

Fix

• Bluetooth permission check no longer crashes on some Android devices

New

• Updated to the latest Kotlin version to meet newer build requirements

New

• Now has minimal support for Mac apps where it will always report speech as unavailable. This allows the plugin to be used in apps where speech is an optional capability without blocking the deploy to the Mac platform.

Fix

• Cleanup BT code on Android for clarity

Fix

• Bluetooth permission not granted no longer crashes on Android

New

• Rejecting Bluetooth permission no longer blocks subsequent recognition using non-bluetooth inputs.

Fix

• onDevice recognition for Android should handle switching from onDevice between recognition sessions.

New

• initialize method on the SpeechToTextProvider adds the finalTimeout and options parameters that match the same parameters on SpeechToText
• onDevice support added for Android
• example app now supports pauseFor and waitFor parameters

Fix

• example app updated for new Android build requirements
• Result method signature fixed in Android override

New

• new Android option androidNoBluetooth can be used in initialize to disable Bluetooth support on Android devices which removes the need for Bluetooth permission.

New

• Now asks for Bluetooth permission on SDK 31 and above. When upgrading an already installed app the permission will not be requested. Users will have to manually set the permission or clear their app cache to force a re-request. See this issue

New

• Android permission documentation

New

• Support for bluetooth headsets in Android

New

• Documentation improvements for listen parameters
• iOS error handling improvements

Fix

• lastRecognizedWords now cleared before each listen call
• web issue resolve #242

New

• Requires compileSdkVersion 31 to build, check your build.gradle
• Changed the error_unknown return to error_unknown ({error_code}) so that the native Android error code is visible. This is a potentially breaking change if you behaviour for the error_unkown value.
• Added new SDK 31 error messages for Android
  • error_language_not_supported
  • error_language_unavailable
  • error_server_disconnected
  • error_too_many_requests

Fix

• Fix for Android to handle list end on unrecognized content properly #253

Fix

• Fix for Android compile issue on latest SDK #259

New

• The example app now supports Web as a run target
• Improved the example app and its documentation
• Improved the provider example app
• Android now handles the done condition better, especially in case of error
• Updated the minimal example in the README file

Fix

• Fix for listing available Locales on some Android devices

New

• Bluetooth headsets now supported on iOS
• onStatus now receives the new done status after all listening is complete. This is a potentially breaking change as it adds a new status to handle.
• initialize and hasPermission now checks if speech is supported on web

Fix

• removed duplicate not listening status sent on iOS
• iOS now restores all audio options after listening
• iOS returns speech results faster when also playing a stop sound

Fix

• handle deprecation of setMockMethodHandler #229

Fix

• minor code format issue that lost me 10 points, this shall not stand!

New

• Flutter 2.0 / Dart 2.12 null safety features are now the main release

Fix

• iOS is now faster starting to listen #207
• fix for sample rate issue on iOS #109
• systemLocale now reports the device locale rather than the app locale. Previously it was constrained to only be one of the localized languages of the application. #200

Fix

• Web support has changed to use the Flutter class definitions and now works in release mode
• pauseFor and listenFor accuracy improved

New

• New property finalTimeout on the initialize method to set how long the plugin will wait for a final result from the device before manuafacturing one. This used to be a pre-defined value of 100 ms in earlier releases. The default is now 2 seconds.

New

• Now supports Flutter 2.0 / Dart 2.12 null safety features.
• Now supports the web platform

New

• New property finalTimeout on the initialize method to set how long the plugin will wait for a final result from the device before manuafacturing one. This used to be a pre-defined value of 100 ms in earlier releases. The default is now 2 seconds.

New

• now compatible with Android SDK 30
• initialize now supports the options parameter to supply platform specific options during initialization.
• SpeechToText.androidAlwaysStop supported as an option. Forces the plugin to use the speech recognizer stop method even on SDK versions where that might fail. See https://github.com/csdcorp/speech_to_text/issues/150
• SpeechToText.androidIntentLookup looks up the intent name instead of using the default. This can work around some issues with security exceptions when trying to use the default. See https://github.com/csdcorp/speech_to_text/issues/153

Fix

• Phones that don't report extra languages no longer hang on locales call

Fix

• Minor static code analysis improvements (addicted to pub points)

New

• Now using a platform interface to prepare for web support. Although this should not cause any functional changes it is a major refactoring.

Fix

• Android stop now completes even if not initialized
• iOS onDevice initialization is more reliable
• No longer crashes on iOS version < 10

New

• the example had onDevice true which is a rarely used flag and was causing confusion
• the partialResults option for the SpeechToTextProvider.listen was defaulted to false which is a less common usage and didn't match the default for SpeechToText.listen so it has been changed to true

New

• new parameter onDevice on the SpeechToTextProvider listen method supports forcing offline recognition.
• Added a new Tips section to the README doc to answer some common questions.

Fix

• Android now correctly returns multiple possible matches with confidence
• Android now supports the onDevice flag properly, note that at least some Android devices need an offline language pack installed for each target language to enable offline recognition.

New

• new parameter localeId on the SpeechToTextProvider listen method supports selecting a non default languge for the recognizer when using the provider.

Fix

• A work around for a bug in Android 10(29) that made stop and cancel not work. The plugin now calls destroy on the Android SpeechRecognizer which terminates the listen session immediately. There is a downside to this approach in that it does not always report results that were in process when destroy was called, however it does mean that stop works.
• The example for SpeechToTextProvider, provider_example.dart had an error that made it always use the default language and ignore the drop-down selection. This has been corrected.