Permalink
Browse files

Merge pull request #402 from poiuytrez/master

Speech to text - Get Supported languages method
  • Loading branch information...
2 parents 9e2c0fc + a6fb892 commit f577e1705499f52a59bc2d074d30f076325e0524 @macdonst macdonst committed Mar 21, 2012
@@ -7,57 +7,94 @@ A collection of possible matches (strings) are returned to your app.
Of course this plugin requires [Android PhoneGap](http://github.com/phonegap/phonegap-android).
-1. To install the plugin, copy SpeechRecognizer.js to your project's www folder.
-2. Add SpeechRecognizer.js to your html file, eg: `<script type="text/javascript" charset="utf-8" src="SpeechRecognizer.js"></script>`
+1. To install the plugin, copy speechrecognizer.js to your project's www folder.
+2. Add speechrecognizer.js to your html file, eg: `<script type="text/javascript" charset="utf-8" src="speechrecognizer.js"></script>`
3. Create an 'com/urbtek/phonegap' path under 'src' and add the SpeechRecognizer.java file to it
4. Add the plugin to the 'res/xml/plugins.xml' file. eg: `<plugin name="SpeechRecognizer" value="com.urbtek.phonegap.SpeechRecognizer"/>`
### Example
-```javascript
-function onDeviceReady()
-{
- window.plugins.speechrecognizer.init(speechInitOk, speechInitFail);
- // etc.
-}
-
-function speechInitOk() {
- // we're good
-}
-function speechInitFail(m) {
- // recognizer not present?
-}
-
-function recognizeSpeech() {
- var requestCode = 1234;
- var maxMatches = 5;
- var promptString = "Please say a command";
- window.plugins.speechrecognizer.startRecognize(speechOk, speechFail, requestCode, maxMatches, promptString);
-}
-
-function speechOk(result) {
- var match, respObj, requestCode;
- if (result) {
- respObj = JSON.parse(result);
- if (respObj) {
- // This is the code that was sent with the original request
- requestCode = respObj.speechMatches.requestCode;
-
- for (match in respObj.speechMatches.speechMatch) {
- console.log("possible match: " + respObj.speechMatches.speechMatch[match]);
- // regex comes in handy for dealing with these match strings
- }
- }
- }
-}
-
-function speechFail(m) {
- console.log("speechFail: " + m.toString());
-}
-
+```html
+<!DOCTYPE HTML>
+<html>
+ <head>
+ <title>PhoneGap</title>
+ <script type="text/javascript" charset="utf-8" src="phonegap.js"></script>
+ <script type="text/javascript" charset="utf-8" src="speechrecognizer.js"></script>
+ <script type="text/javascript" charset="utf-8">
+ function onLoad(){
+ document.addEventListener("deviceready", onDeviceReady, true);
+ }
+ function onDeviceReady()
+ {
+ window.plugins.speechrecognizer.init(speechInitOk, speechInitFail);
+ // etc.
+ }
+
+ function speechInitOk() {
+ alert("we are good");
+ supportedLanguages();
+ recognizeSpeech();
+ }
+ function speechInitFail(m) {
+ alert(m);
+ }
+
+ // Show the list of the supported languages
+ function supportedLanguages() {
+ window.plugins.speechrecognizer.getSupportedLanguages(function(languages){
+ // display the json array
+ alert(languages);
+ }, function(error){
+ alert("Could not retrieve the supported languages");
+ });
+ }
+
+ function recognizeSpeech() {
+ var requestCode = 1234;
+ var maxMatches = 5;
+ var promptString = "Please say a command"; // optional
+ var language = "en-US"; // optional
+ window.plugins.speechrecognizer.startRecognize(speechOk, speechFail, requestCode, maxMatches, promptString, language);
+ }
+
+ function speechOk(result) {
+ var respObj, requestCode, matches;
+ if (result) {
+ respObj = JSON.parse(result);
+ if (respObj) {
+ var matches = respObj.speechMatches.speechMatch;
+
+ for (x in matches) {
+ alert("possible match: " + matches[x]);
+ // regex comes in handy for dealing with these match strings
+ }
+ }
+ }
+ }
+
+ function speechFail(message) {
+ console.log("speechFail: " + message);
+ }
+ </script>
+ </head>
+ <body onload="onLoad();">
+ <h1>Welcome to PhoneGap</h1>
+ <h2>Edit assets/www/index.html</h2>
+ </body>
+</html>
```
## RELEASE NOTES ##
+### November 23, 2011 ###
+
+* Java code to java convention (functions starts with a lowercase characater)
+* New getSupportedLanguages method
+* Java file warnings removed
+* Better error handling
+* New language parameter
+* SpeechOk demo code fixed (show the recognized text instead of the id)
+
### September 16, 2011 ###
* Initial release
@@ -66,7 +103,10 @@ function speechFail(m) {
The MIT License
-Copyright (c) 2011 Colin Turner (github.com/koolspin)
+Copyright (c) 2011
+Colin Turner (github.com/koolspin)
+Guillaume Charhon (github/poiuytrez)
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
@@ -3,8 +3,9 @@
* Speech Recognition PhoneGap plugin (Android)
*
* @author Colin Turner
+ * @author Guillaume Charhon
*
- * Copyright (c) 2011, Colin Turner
+ * Copyright (c) 2011, Colin Turner, Guillaume Charhon
*
* MIT Licensed
*/
@@ -23,20 +24,53 @@
import android.util.Log;
import android.app.Activity;
+import android.content.BroadcastReceiver;
+import android.content.Context;
import android.content.Intent;
import android.content.pm.PackageManager;
+import android.content.pm.ResolveInfo;
import android.speech.RecognizerIntent;
+class HintReceiver extends BroadcastReceiver {
+ com.urbtek.phonegap.SpeechRecognizer speechRecognizer;
+ String callBackId = "";
+ @Override
+ public void onReceive(Context context, Intent intent) {
+
+ if (getResultCode() != Activity.RESULT_OK) {
+ return;
+ }
+ // the list of supported languages.
+ ArrayList<CharSequence> hints = getResultExtras(true).getCharSequenceArrayList(RecognizerIntent.EXTRA_SUPPORTED_LANGUAGES);
+
+ // Convert the map to json
+ JSONArray languageArray = new JSONArray(hints);
+ PluginResult result = new PluginResult(PluginResult.Status.OK, languageArray);
+ result.setKeepCallback(false);
+ //speechRecognizer.callbackId = "";
+ speechRecognizer.success(result, "");
+ }
+
+ public void setSpeechRecognizer(SpeechRecognizer speechRecognizer){
+ this.speechRecognizer = speechRecognizer;
+ }
+
+ public void setCallBackId(String id){
+ this.callBackId = id;
+ }
+}
+
/**
* Style and such borrowed from the TTS and PhoneListener plugins
*/
+
public class SpeechRecognizer extends Plugin {
private static final String LOG_TAG = SpeechRecognizer.class.getSimpleName();
public static final String ACTION_INIT = "init";
public static final String ACTION_SPEECH_RECOGNIZE = "startRecognize";
public static final String NOT_PRESENT_MESSAGE = "Speech recognition is not present or enabled";
- private String speechRecognizerCallbackId = "";
+ public String callbackId = "";
private boolean recognizerPresent = false;
/* (non-Javadoc)
@@ -47,7 +81,7 @@ public PluginResult execute(String action, JSONArray args, String callbackId) {
// Dispatcher
if (ACTION_INIT.equals(action)) {
// init
- if (DoInit())
+ if (doInit())
return new PluginResult(Status.OK);
else
return new PluginResult(Status.ERROR, NOT_PRESENT_MESSAGE);
@@ -57,16 +91,27 @@ else if (ACTION_SPEECH_RECOGNIZE.equals(action)) {
if (!recognizerPresent) {
return new PluginResult(PluginResult.Status.ERROR, NOT_PRESENT_MESSAGE);
}
- if (!(this.speechRecognizerCallbackId.length() == 0)) {
+
+ if (!this.callbackId.isEmpty()) {
return new PluginResult(PluginResult.Status.ERROR, "Speech recognition is in progress.");
}
- this.speechRecognizerCallbackId = callbackId;
+ this.callbackId = callbackId;
startSpeechRecognitionActivity(args);
PluginResult res = new PluginResult(Status.NO_RESULT);
res.setKeepCallback(true);
return res;
}
+ else if("getSupportedLanguages".equals(action)){
+ // save the call back id
+ //this.callbackId = callbackId;
+ // Get the list of supported languages
+ getSupportedLanguages();
+ // wait for the intent callback
+ PluginResult res = new PluginResult(Status.NO_RESULT);
+ res.setKeepCallback(true);
+ return res;
+ }
else {
// Invalid action
String res = "Unknown action: " + action;
@@ -75,31 +120,47 @@ else if (ACTION_SPEECH_RECOGNIZE.equals(action)) {
}
/**
+ * Request the supported languages
+ */
+ private void getSupportedLanguages() {
+ // Create and launch get languages intent
+ Intent intent = new Intent(RecognizerIntent.ACTION_GET_LANGUAGE_DETAILS);
+ HintReceiver hintReceiver = new HintReceiver();
+ hintReceiver.setSpeechRecognizer(this);
+ //hintReceiver.setCallBackId(this.callbackId);
+ ctx.getApplicationContext().sendOrderedBroadcast(intent, null, hintReceiver, null, Activity.RESULT_OK, null, null);
+ }
+
+ /**
* Initialize the speech recognizer by checking if one exists.
*/
- private boolean DoInit() {
- this.recognizerPresent = IsSpeechRecognizerPresent();
+ private boolean doInit() {
+ this.recognizerPresent = isSpeechRecognizerPresent();
return this.recognizerPresent;
}
/**
* Checks if a recognizer is present on this device
*/
- private boolean IsSpeechRecognizerPresent() {
+ private boolean isSpeechRecognizerPresent() {
PackageManager pm = ctx.getPackageManager();
- List activities = pm.queryIntentActivities(new Intent(RecognizerIntent.ACTION_RECOGNIZE_SPEECH), 0);
+ List<ResolveInfo> activities = pm.queryIntentActivities(new Intent(RecognizerIntent.ACTION_RECOGNIZE_SPEECH), 0);
return !activities.isEmpty();
}
+
+
/**
* Fire an intent to start the speech recognition activity.
*
* @param args Argument array with the following string args: [req code][number of matches][prompt string]
*/
+
private void startSpeechRecognitionActivity(JSONArray args) {
int reqCode = 42; //Hitchhiker?
int maxMatches = 0;
String prompt = "";
+ String language = "";
try {
if (args.length() > 0) {
@@ -116,13 +177,22 @@ private void startSpeechRecognitionActivity(JSONArray args) {
// Optional text prompt
prompt = args.getString(2);
}
+ if (args.length() > 3){
+ // Optional language specified
+ language = args.getString(3);
+ }
}
catch (Exception e) {
Log.e(LOG_TAG, String.format("startSpeechRecognitionActivity exception: %s", e.toString()));
}
Intent intent = new Intent(RecognizerIntent.ACTION_RECOGNIZE_SPEECH);
intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE_MODEL, RecognizerIntent.LANGUAGE_MODEL_FREE_FORM);
+ // If specific language
+ if(!language.equals("")){
+ intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE, language);
+ }
+
if (maxMatches > 0)
intent.putExtra(RecognizerIntent.EXTRA_MAX_RESULTS, maxMatches);
if (!(prompt.length() == 0))
@@ -138,17 +208,20 @@ public void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == Activity.RESULT_OK) {
// Fill the list view with the strings the recognizer thought it could have heard
ArrayList<String> matches = data.getStringArrayListExtra(RecognizerIntent.EXTRA_RESULTS);
- ReturnSpeechResults(requestCode, matches);
+ speechResults(requestCode, matches);
+
}
- else {
- // Failure - Let the caller know
- ReturnSpeechFailure(resultCode);
+ else if(resultCode == Activity.RESULT_CANCELED){
+ // cancelled by user
+ speechFailure("Cancelled");
+ } else {
+ speechFailure("Unknown error");
}
super.onActivityResult(requestCode, resultCode, data);
}
- private void ReturnSpeechResults(int requestCode, ArrayList<String> matches) {
+ private void speechResults(int requestCode, ArrayList<String> matches) {
boolean firstValue = true;
StringBuilder sb = new StringBuilder();
sb.append("{\"speechMatches\": {");
@@ -169,14 +242,14 @@ private void ReturnSpeechResults(int requestCode, ArrayList<String> matches) {
PluginResult result = new PluginResult(PluginResult.Status.OK, sb.toString());
result.setKeepCallback(false);
- this.success(result, this.speechRecognizerCallbackId);
- this.speechRecognizerCallbackId = "";
+ this.success(result, this.callbackId);
+ this.callbackId = "";
}
- private void ReturnSpeechFailure(int resultCode) {
- PluginResult result = new PluginResult(PluginResult.Status.ERROR, Integer.toString(resultCode));
+ private void speechFailure(String message) {
+ PluginResult result = new PluginResult(PluginResult.Status.ERROR, message);
result.setKeepCallback(false);
- this.error(result, this.speechRecognizerCallbackId);
- this.speechRecognizerCallbackId = "";
+ this.error(result, this.callbackId);
+ this.callbackId = "";
}
}
Oops, something went wrong.

0 comments on commit f577e17

Please sign in to comment.