Skip to content
An Android library module to Mozilla's Speech-To-Text services
C Java Objective-C Makefile C++
Branch: master
Clone or download
Pull request Compare This branch is even with mozilla:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
gradle/wrapper
mozillaspeechlibrary
.gitignore
CODE_OF_CONDUCT.md
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

androidspeech

This is an Android library containing an API to Mozilla's speech recognition services.

Installation

dependencies { 
      implementation 'com.github.mozilla:mozillaspeechlibrary:1.0.7'
}

Demo app

Just run the demo application inside the folder app

Usage

The API encapsulates the microphone capture, audio encoding, voice activity detection and network communication. So for this reason its integration is very simple: just call start() and handle the events in your frontend.

First define a listener to capture the events:

ISpeechRecognitionListener mVoiceSearchListener = new ISpeechRecognitionListener() {
      public void onSpeechStatusChanged(final MozillaSpeechService.SpeechState aState, final Object aPayload){
          runOnUiThread(new Runnable() {
              @Override
              public void run() {
                  switch (aState) {
                      case DECODING:
                          // Handle when the speech object changes to decoding state
                          break;
                      case MIC_ACTIVITY:
                          // Captures the activity from the microphone
                          double db = (double)aPayload * -1;
                          break;
                      case STT_RESULT:
                          // When the api finished processing and returned a hypothesis 
                          string transcription = ((STTResult)aPayload).mTranscription;
                          float confidence = ((STTResult)aPayload).mConfidence;
                          break;
                      case START_LISTEN:
                          // Handle when the api successfully opened the microphone and started listening
                          break;
                      case NO_VOICE:
                          // Handle when the api didn't detect any voice
                          break;
                      case CANCELED:
                          // Handle when a cancelation was fully executed
                          break;
                      case ERROR:
                          // Handle when any error occurred
                          string error = aPayload;
                          break;
                      default:
                          break;
                  }
              }
          });
      }
  };

Then start it:

        mMozillaSpeechService = MozillaSpeechService.getInstance();
        mMozillaSpeechService.setLanguage("en-US");
        mMozillaSpeechService.addListener(mVoiceSearchListener);
        mMozillaSpeechService.start(getApplicationContext());

In the case you want to cancel a progressing operation:

        mMozillaSpeechService.cancel();

To remove a listener:

        mMozillaSpeechService.removeListener(aListener);

Note: Your app will need RECORD_AUDIO, WRITE_EXTERNAL_STORAGE and READ_EXTERNAL_STORAGE permissions to be set in AndroidManifest.xml manifest and requested at runtime.

You can’t perform that action at this time.