Skip to content

Latest commit

 

History

History
127 lines (91 loc) · 3.99 KB

README.md

File metadata and controls

127 lines (91 loc) · 3.99 KB
Raw

expo-stt

Unofficial Speech To Text module for Expo which supported iOS and Android

So sorry that I am unemployed and don't have much money to spend more time to make this module work also for web.

If you still want to support web platform, please follow this article https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API/Using_the_Web_Speech_API

Demo speech to text

API documentation

Installation in managed Expo projects

For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release. If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.

Installation in bare React Native projects

For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

Add the package to your npm dependencies

npm install expo-stt
or
yarn add expo-stt

Remember, this module doesn't support Expo Go. So for Expo project, you will need to generates native code (Bare React Native project can skip this step)

npx expo prebuild --clean

Configure for iOS (Bare React Native project only)

Run npx pod-install after installing the npm package.

Add missing permissions for iOS

Add following key to plugins of app.json in Expo project This is an optional, just use in case you want to customize the permission string

  "plugins": [
    [
      "expo-stt",
      {
        "microphonePermission": "Allow $(PRODUCT_NAME) to access your microphone",
        "speechRecognitionPermission": "Allow $(PRODUCT_NAME) to access your speech recognition"
      }
    ]
  ]

For Bare React Native project, you need to add these key to Info.plist in ios directory

  <key>NSMicrophoneUsageDescription</key>
  <string>Allow $(PRODUCT_NAME) to access your microphone</string>
  <key>NSSpeechRecognitionUsageDescription</key>
  <string>Allow $(PRODUCT_NAME) to access your speech recognition</string>

Usage

Register some listeners

  import * as ExpoStt from 'expo-stt';

  useEffect(() => {
    const onSpeechStart = ExpoStt.addOnSpeechStartListener(() => {
      setSpokenText("");
      setError(undefined);
      setRecognizing(true);
    });

    const onSpeechResult = ExpoStt.addOnSpeechResultListener(({ value }) => {
      setSpokenText(value.join());
    });

    const onSpeechCancelled = ExpoStt.addOnSpeechCancelledListener(() => {
      setRecognizing(false);
    });

    const onSpeechError = ExpoStt.addOnSpeechErrorListener(({ cause }) => {
      setError(cause);
      setRecognizing(false);
    });

    const onSpeechEnd = ExpoStt.addOnSpeechEndListener(() => {
      setRecognizing(false);
    });

    return () => {
      onSpeechStart.remove();
      onSpeechResult.remove();
      onSpeechCancelled.remove();
      onSpeechError.remove();
      onSpeechEnd.remove();
    };
  }, []);

There are some functions available to call such as:

  • ExpoStt.startSpeech()
  • ExpoStt.stopSpeech()
  • ExpoStt.cancelSpeech()
  • ExpoStt.destroySpeech()
  • ExpoStt.requestRecognitionPermission()
  • ExpoStt.checkRecognitionPermission()

Take a look into example/App.tsx for completed example

Contributing

Contributions are very welcome! Please refer to guidelines described in the contributing guide.

Author

I am looking for a job as a React native developer, remote work is preferred.

Check out my CV: https://anhtuank7c.github.io