AtHeartEngineer/phonegap-plugins
1
1
Fork 0
mirror of https://github.com/purplecabbage/phonegap-plugins.git synced 2026-01-09 15:48:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1178 from poiuytrez/SpeechRecognizerMove2

Browse Source 
SpeechRecognizer moved to new repository.

Lemme know when you begin work on the new plugin. I'm planning on doing a shim for the web speech API and we may be able to collaborate on it.
This commit is contained in:
macdonst
2013-06-10 20:14:07 -07:00
parent d085827db3 3d9ca62865
commit 1705b08d8c
7 changed files with 23 additions and 944 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
Android/SpeechRecognizer/README.md
View File

@@ -1,118 +1,29 @@
# Android SpeechRecognizer plugin for Phonegap #
SpeechRecognizer Plugin
----------------
Maintained by Guillaume Charhon - Smart Mobile Software
This plugin will recognize commands, phrases, etc as spoken by the user.
A collection of possible matches (strings) are returned to your app.
The repository for this plugin is located at https://github.com/poiuytrez/SpeechRecognizer
## Adding the Plugin to your project ##
MIT License
----------------
Of course this plugin requires [Android PhoneGap](http://github.com/phonegap/phonegap-android).
Copyright (c) 2011-2013 Guillaume Charhon (github.com/poiuytrez)
Copyright (c) 2011-2013 Colin Turner (github.com/koolspin)
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.
3.a on version 2.0.x, this plugin has been update to the new Plugin architecture (Cordova 2.2.0+)
Create a 'com/phonegap/plugins/speech' folder 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"/>`
4.a On 2.0.x, `<plugin name="SpeechRecognizer" value="com.phonegap.plugins.xpeech.SpeechRecognizer"/>`
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:
### Example
```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.
}
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
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
## License
The MIT License
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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

255
Android/SpeechRecognizer/v1.8.1/SpeechRecognizer.java
View File

@@ -1,255 +0,0 @@
/**
* SpeechRecognizer.java
* Speech Recognition PhoneGap plugin (Android)
*
* @author Colin Turner
* @author Guillaume Charhon
*
* Copyright (c) 2011, Colin Turner, Guillaume Charhon
*
* MIT Licensed
*/
package com.urbtek.phonegap;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.json.JSONArray;
import org.json.JSONObject;
import com.phonegap.api.Plugin;
import com.phonegap.api.PluginResult;
import com.phonegap.api.PluginResult.Status;
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";
public String callbackId = "";
private boolean recognizerPresent = false;
/* (non-Javadoc)
* @see com.phonegap.api.Plugin#execute(java.lang.String, org.json.JSONArray, java.lang.String)
*/
@Override
public PluginResult execute(String action, JSONArray args, String callbackId) {
// Dispatcher
if (ACTION_INIT.equals(action)) {
// init
if (doInit())
return new PluginResult(Status.OK);
else
return new PluginResult(Status.ERROR, NOT_PRESENT_MESSAGE);
}
else if (ACTION_SPEECH_RECOGNIZE.equals(action)) {
// recognize speech
if (!recognizerPresent) {
return new PluginResult(PluginResult.Status.ERROR, NOT_PRESENT_MESSAGE);
}
if (!this.callbackId.isEmpty()) {
return new PluginResult(PluginResult.Status.ERROR, "Speech recognition is in progress.");
}
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;
return new PluginResult(PluginResult.Status.INVALID_ACTION, res);
}
}
/**
* 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();
return this.recognizerPresent;
}
/**
* Checks if a recognizer is present on this device
*/
private boolean isSpeechRecognizerPresent() {
PackageManager pm = ctx.getPackageManager();
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) {
// Request code - passed back to the caller on a successful operation
String temp = args.getString(0);
reqCode = Integer.parseInt(temp);
}
if (args.length() > 1) {
// Maximum number of matches, 0 means the recognizer decides
String temp = args.getString(1);
maxMatches = Integer.parseInt(temp);
}
if (args.length() > 2) {
// 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))
intent.putExtra(RecognizerIntent.EXTRA_PROMPT, prompt);
ctx.startActivityForResult(this, intent, reqCode);
}
/**
* Handle the results from the recognition activity.
*/
@Override
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);
speechResults(requestCode, matches);
}
else if(resultCode == Activity.RESULT_CANCELED){
// cancelled by user
speechFailure("Cancelled");
} else {
speechFailure("Unknown error");
}
super.onActivityResult(requestCode, resultCode, data);
}
private void speechResults(int requestCode, ArrayList<String> matches) {
boolean firstValue = true;
StringBuilder sb = new StringBuilder();
sb.append("{\"speechMatches\": {");
sb.append("\"requestCode\": ");
sb.append(Integer.toString(requestCode));
sb.append(", \"speechMatch\": [");
Iterator<String> iterator = matches.iterator();
while(iterator.hasNext()) {
String match = iterator.next();
if (firstValue == false)
sb.append(", ");
firstValue = false;
sb.append(JSONObject.quote(match));
}
sb.append("]}}");
PluginResult result = new PluginResult(PluginResult.Status.OK, sb.toString());
result.setKeepCallback(false);
this.success(result, this.callbackId);
this.callbackId = "";
}
private void speechFailure(String message) {
PluginResult result = new PluginResult(PluginResult.Status.ERROR, message);
result.setKeepCallback(false);
this.error(result, this.callbackId);
this.callbackId = "";
}
}

59
Android/SpeechRecognizer/v1.8.1/SpeechRecognizer.js
View File

@@ -1,59 +0,0 @@
/**
* SpeechRecognizer.js
* Speech Recognizer PhoneGap plugin (Android)
*
* @author Colin Turner
* @author Guillaume Charhon
* MIT Licensed
*/
/**
* c'tor
*/
function SpeechRecognizer() {
}
/**
* Initialize
*
* @param successCallback
* @param errorCallback
*/
SpeechRecognizer.prototype.init = function(successCallback, errorCallback) {
return PhoneGap.exec(successCallback, errorCallback, "SpeechRecognizer", "init", []);
};
/**
* Recognize speech and return a list of matches
*
* @param successCallback
* @param errorCallback
* @param reqCode User-defined integer request code which will be returned when recognition is complete
* @param maxMatches The maximum number of matches to return. 0 means the service decides how many to return.
* @param promptString An optional string to prompt the user during recognition
* @param language is an optional string to pass a language name in IETF BCP 47. If nothing is specified, the currrent phone language is used
*/
SpeechRecognizer.prototype.startRecognize = function(successCallback, errorCallback, reqCode, maxMatches, promptString, language) {
return PhoneGap.exec(successCallback, errorCallback, "SpeechRecognizer", "startRecognize", [reqCode, maxMatches, promptString, language]);
};
/**
* Get the list of the supported languages in IETF BCP 47 format
*
* @param successCallback
* @param errorCallback
*
* Returns an array of codes in the success callback
*/
SpeechRecognizer.prototype.getSupportedLanguages = function(successCallback, errorCallback) {
return PhoneGap.exec(successCallback, errorCallback, "SpeechRecognizer", "getSupportedLanguages", []);
};
/**
* Load
*/
PhoneGap.addConstructor(function() {
PhoneGap.addPlugin("speechrecognizer", new SpeechRecognizer());
});

199
Android/SpeechRecognizer/v2.0.0/SpeechRecognizer.java
View File

@@ -1,199 +0,0 @@
/**
* SpeechRecognizer.java
* Speech Recognition PhoneGap plugin (Android)
*
* @author Colin Turner
*
* Copyright (c) 2011, Colin Turner
*
* MIT Licensed
*/
package com.urbtek.phonegap;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import org.json.JSONArray;
import org.json.JSONObject;
import org.apache.cordova.api.Plugin;
import org.apache.cordova.api.PluginResult;
import org.apache.cordova.api.PluginResult.Status;
import android.util.Log;
import android.app.Activity;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.speech.RecognizerIntent;
/**
* 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 = "";
private boolean recognizerPresent = false;
/* (non-Javadoc)
* @see com.phonegap.api.Plugin#execute(java.lang.String, org.json.JSONArray, java.lang.String)
*/
@Override
public PluginResult execute(String action, JSONArray args, String callbackId) {
// Dispatcher
if (ACTION_INIT.equals(action)) {
// init
if (DoInit())
return new PluginResult(Status.OK);
else
return new PluginResult(Status.ERROR, NOT_PRESENT_MESSAGE);
}
else if (ACTION_SPEECH_RECOGNIZE.equals(action)) {
// recognize speech
if (!recognizerPresent) {
return new PluginResult(PluginResult.Status.ERROR, NOT_PRESENT_MESSAGE);
}
if (!this.speechRecognizerCallbackId.equals("")) {
return new PluginResult(PluginResult.Status.ERROR, "Speech recognition is in progress.");
}
this.speechRecognizerCallbackId = callbackId;
startSpeechRecognitionActivity(args);
PluginResult res = new PluginResult(Status.NO_RESULT);
res.setKeepCallback(true);
return res;
}
else {
// Invalid action
String res = "Unknown action: " + action;
return new PluginResult(PluginResult.Status.INVALID_ACTION, res);
}
}
/**
* Initialize the speech recognizer by checking if one exists.
*/
private boolean DoInit() {
this.recognizerPresent = IsSpeechRecognizerPresent();
return this.recognizerPresent;
}
/**
* Checks if a recognizer is present on this device
*/
private boolean IsSpeechRecognizerPresent() {
PackageManager pm = cordova.getActivity().getPackageManager();
List 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 = "";
try {
if (args.length() > 0) {
// Request code - passed back to the caller on a successful operation
String temp = args.getString(0);
reqCode = Integer.parseInt(temp);
}
if (args.length() > 1) {
// Maximum number of matches, 0 means the recognizer decides
String temp = args.getString(1);
maxMatches = Integer.parseInt(temp);
}
if (args.length() > 2) {
// Optional text prompt
prompt = args.getString(2);
}
}
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);
intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE, Locale.ENGLISH);
if (maxMatches > 0)
intent.putExtra(RecognizerIntent.EXTRA_MAX_RESULTS, maxMatches);
if (!prompt.equals(""))
intent.putExtra(RecognizerIntent.EXTRA_PROMPT, prompt);
cordova.startActivityForResult(this, intent, reqCode);
}
/**
* Handle the results from the recognition activity.
*/
@Override
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);
float[] confidence = data.getFloatArrayExtra(RecognizerIntent.EXTRA_CONFIDENCE_SCORES);
if (confidence != null) {
Log.d(LOG_TAG, "confidence length "+ confidence.length);
Iterator<String> iterator = matches.iterator();
int i = 0;
while(iterator.hasNext()) {
Log.d(LOG_TAG, "Match = " + iterator.next() + " confidence = " + confidence[i]);
i++;
}
} else {
Log.d(LOG_TAG, "No confidence" +
"");
}
ReturnSpeechResults(requestCode, matches);
}
else {
// Failure - Let the caller know
ReturnSpeechFailure(resultCode);
}
super.onActivityResult(requestCode, resultCode, data);
}
private void ReturnSpeechResults(int requestCode, ArrayList<String> matches) {
boolean firstValue = true;
StringBuilder sb = new StringBuilder();
sb.append("{\"speechMatches\": {");
sb.append("\"requestCode\": ");
sb.append(Integer.toString(requestCode));
sb.append(", \"speechMatch\": [");
Iterator<String> iterator = matches.iterator();
while(iterator.hasNext()) {
String match = iterator.next();
if (firstValue == false)
sb.append(", ");
firstValue = false;
sb.append(JSONObject.quote(match));
}
sb.append("]}}");
PluginResult result = new PluginResult(PluginResult.Status.OK, sb.toString());
result.setKeepCallback(false);
this.success(result, this.speechRecognizerCallbackId);
this.speechRecognizerCallbackId = "";
}
private void ReturnSpeechFailure(int resultCode) {
PluginResult result = new PluginResult(PluginResult.Status.ERROR, Integer.toString(resultCode));
result.setKeepCallback(false);
this.error(result, this.speechRecognizerCallbackId);
this.speechRecognizerCallbackId = "";
}
}

60
Android/SpeechRecognizer/v2.0.0/SpeechRecognizer.js
View File

@@ -1,60 +0,0 @@
/**
* SpeechRecognizer.js
* Speech Recognizer cordova plugin (Android)
*
* @author Colin Turner
*
* MIT Licensed
*/
/**
* c'tor
*/
function SpeechRecognizer() {
}
/**
* Initialize
*
* @param successCallback
* @param errorCallback
*/
SpeechRecognizer.prototype.init = function(successCallback, errorCallback) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "init", []);
};
/**
* Recognize speech and return a list of matches
*
* @param successCallback
* @param errorCallback
* @param reqCode User-defined integer request code which will be returned when recognition is complete
* @param maxMatches The maximum number of matches to return. 0 means the service decides how many to return.
* @param promptString An optional string to prompt the user during recognition
*/
SpeechRecognizer.prototype.startRecognize = function(successCallback, errorCallback, reqCode, maxMatches, promptString) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "startRecognize", [reqCode, maxMatches, promptString]);
};
/**
* Get the list of the supported languages in IETF BCP 47 format
*
* @param successCallback
* @param errorCallback
*
* Returns an array of codes in the success callback
*/
SpeechRecognizer.prototype.getSupportedLanguages = function(successCallback, errorCallback) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "getSupportedLanguages", []);
};
/**
* Load
*/
if(!window.plugins) {
window.plugins = {};
}
if (!window.plugins.speechrecognizer) {
window.plugins.speechrecognizer = new SpeechRecognizer();
}

199
Android/SpeechRecognizer/v2.5.0/SpeechRecognizer.java
View File

@@ -1,199 +0,0 @@
/**
* SpeechRecognizer.java
* Speech Recognition PhoneGap plugin (Android)
*
* @author Colin Turner
*
* Copyright (c) 2011, Colin Turner
*
* MIT Licensed
*/
package com.phonegap.plugins.speech;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import org.json.JSONArray;
import org.json.JSONObject;
import org.apache.cordova.api.CordovaPlugin;
import org.apache.cordova.api.CallbackContext;
//import org.apache.cordova.api.PluginResult.Status;
import android.util.Log;
import android.app.Activity;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.speech.RecognizerIntent;
/**
* Style and such borrowed from the TTS and PhoneListener plugins
*/
public class SpeechRecognizer extends CordovaPlugin {
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 CallbackContext cbContext;
public String callback;
private String speechRecognizerCallbackId = "";
private boolean recognizerPresent = false;
/* (non-Javadoc)
* @see com.phonegap.api.Plugin#execute(java.lang.String, org.json.JSONArray, java.lang.String)
*/
//@Override
public boolean execute(String action, JSONArray args, CallbackContext callbackContext) {
this.cbContext= callbackContext;
// Dispatcher
if (ACTION_INIT.equals(action)) {
if (DoInit())
return true;
else
this.cbContext.error("Speech Not Initialized or Unavailable");
return false;
}
else if (ACTION_SPEECH_RECOGNIZE.equals(action)) {
// recognize speech
if (!recognizerPresent) {
callbackContext.error(NOT_PRESENT_MESSAGE);
return false;
}
if (!this.speechRecognizerCallbackId.equals("")) {
callbackContext.error("Speech recognition is in progress.");
return false;
}
startSpeechRecognitionActivity(args);
}
else {
// Invalid action
this.cbContext.error("Unknown action: " + action);
return false;
}
return true;
}
/**
* Initialize the speech recognizer by checking if one exists.
*/
private boolean DoInit() {
this.recognizerPresent = IsSpeechRecognizerPresent();
return this.recognizerPresent;
}
/**
* Checks if a recognizer is present on this device
*/
private boolean IsSpeechRecognizerPresent() {
PackageManager pm = cordova.getActivity().getPackageManager();
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 = "";
try {
if (args.length() > 0) {
// Request code - passed back to the caller on a successful operation
String temp = args.getString(0);
reqCode = Integer.parseInt(temp);
}
if (args.length() > 1) {
// Maximum number of matches, 0 means the recognizer decides
String temp = args.getString(1);
maxMatches = Integer.parseInt(temp);
}
if (args.length() > 2) {
// Optional text prompt
prompt = args.getString(2);
}
}
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);
intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE, Locale.ENGLISH);
if (maxMatches > 0)
intent.putExtra(RecognizerIntent.EXTRA_MAX_RESULTS, maxMatches);
if (!prompt.equals(""))
intent.putExtra(RecognizerIntent.EXTRA_PROMPT, prompt);
cordova.startActivityForResult(this, intent, reqCode);
}
/**
* Handle the results from the recognition activity.
*/
@Override
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);
float[] confidence = data.getFloatArrayExtra(RecognizerIntent.EXTRA_CONFIDENCE_SCORES);
if (confidence != null) {
Log.d(LOG_TAG, "confidence length "+ confidence.length);
Iterator<String> iterator = matches.iterator();
int i = 0;
while(iterator.hasNext()) {
Log.d(LOG_TAG, "Match = " + iterator.next() + " confidence = " + confidence[i]);
i++;
}
} else {
Log.d(LOG_TAG, "No confidence" +
"");
}
ReturnSpeechResults(requestCode, matches);
}
else {
// Failure - Let the caller know
this.cbContext.error(Integer.toString(resultCode));
}
super.onActivityResult(requestCode, resultCode, data);
}
private void ReturnSpeechResults(int requestCode, ArrayList<String> matches) {
boolean firstValue = true;
StringBuilder sb = new StringBuilder();
sb.append("{\"speechMatches\": {");
sb.append("\"requestCode\": ");
sb.append(Integer.toString(requestCode));
sb.append(", \"speechMatch\": [");
Iterator<String> iterator = matches.iterator();
while(iterator.hasNext()) {
String match = iterator.next();
if (firstValue == false)
sb.append(", ");
firstValue = false;
sb.append(JSONObject.quote(match));
}
sb.append("]}}");
this.cbContext.success(sb.toString());
}
}

60
Android/SpeechRecognizer/v2.5.0/SpeechRecognizer.js
View File

@@ -1,60 +0,0 @@
/**
* SpeechRecognizer.js
* Speech Recognizer cordova plugin (Android)
*
* @author Colin Turner
*
* MIT Licensed
*/
/**
* c'tor
*/
function SpeechRecognizer() {
}
/**
* Initialize
*
* @param successCallback
* @param errorCallback
*/
SpeechRecognizer.prototype.init = function(successCallback, errorCallback) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "init", []);
};
/**
* Recognize speech and return a list of matches
*
* @param successCallback
* @param errorCallback
* @param reqCode User-defined integer request code which will be returned when recognition is complete
* @param maxMatches The maximum number of matches to return. 0 means the service decides how many to return.
* @param promptString An optional string to prompt the user during recognition
*/
SpeechRecognizer.prototype.startRecognize = function(successCallback, errorCallback, reqCode, maxMatches, promptString) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "startRecognize", [reqCode, maxMatches, promptString]);
};
/**
* Get the list of the supported languages in IETF BCP 47 format
*
* @param successCallback
* @param errorCallback
*
* Returns an array of codes in the success callback
*/
SpeechRecognizer.prototype.getSupportedLanguages = function(successCallback, errorCallback) {
return cordova.exec(successCallback, errorCallback, "SpeechRecognizer", "getSupportedLanguages", []);
};
/**
* Load
*/
if(!window.plugins) {
window.plugins = {};
}
if (!window.plugins.speechrecognizer) {
window.plugins.speechrecognizer = new SpeechRecognizer();
}