speech_to_text

pub package build status

A library that exposes device specific text to speech recognition capability.

This plugin contains a set of classes that make it easy to use the speech recognition capabilities of the mobile device in Flutter. It supports both Android and iOS.

Recent Updates

The 0.8.0 version exposes a list of possible speech transcriptions instead of just the transcription with the highest confidence. The functionality should be backwards compatible, to find out more have a look at the details of SpeechRecognitionResult and SpeechRecognitionWords.

The 0.7.2 version uses Swift 5, which is the default for new Flutter projects. If you are using the plugin with an older project you will need to upgrade it before you can use the 0.7.2 version of the plugin.

The 0.7.0 version adds the ability to select the recognition language using the localeId parameter on the listen method. It also has a new locales method that returns a list of supported locales for speech on the device.

Note: This plugin is solidifying, feedback from any test devices is welcome.

Using

To recognize text from the microphone import the package and call the plugin, like so:

import 'package:speech_to_text/speech_to_text.dart' as stt;

    stt.SpeechToText speech = stt.SpeechToText();
    bool available = await speech.initialize( onStatus: statusListener, onError: errorListener );
    if ( available ) {
        speech.listen( onResult: resultListener );
    }
    else {
        print("The user has denied the use of speech recognition.");
    }
    // some time later...
    speech.stop()

Permissions

Applications using this plugin require user permissions.

iOS

Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:

  • NSSpeechRecognitionUsageDescription - describe why your app uses speech recognition. This is called Privacy - Speech Recognition Usage Description in the visual editor.
  • NSMicrophoneUsageDescription - describe why your app needs access to the microphone. This is called Privacy - Microphone Usage Description in the visual editor.

Android

Add the record audio permission to your AndroidManifest.xml file, located in <project root>/android/app/src/main/AndroidManifest.xml.

  • android.permission.RECORD_AUDIO - this permission is required for microphone access.
  • android.permission.INTERNET - this permission is required because speech recognition may use remote services.

Adding Sounds for iOS (optional)

Android automatically plays system sounds when speech listening starts or stops but iOS does not. This plugin supports playing sounds to indicate listening status on iOS if sound files are available as assets in the application. To enable sounds in an application using this plugin add the sound files to the project and reference them in the assets section of the application pubspec.yaml. The location and filenames of the sound files must exactly match or they will not be found. The example application for the plugin shows the usage.

  assets:
  - assets/sounds/speech_to_text_listening.m4r
  - assets/sounds/speech_to_text_cancel.m4r
  - assets/sounds/speech_to_text_stop.m4r
  • speech_to_text_listening.m4r - played when the listen method is called.
  • speech_to_text_cancel.m4r - played when the cancel method is called.
  • speech_to_text_stop.m4r - played when the stop method is called.

Libraries

speech_recognition_error
speech_recognition_result
speech_to_text