added new options to modify language, maxResults, to stop listening, and to display possible errors

Author: EricBatlle

UnitySpeechRecognizer/Assets/Plugins/SpeechRecognizer/Android/UnitySpeechRecognizer.aar

@@ -6,29 +6,56 @@
 public class SpeechRecognizer : MonoBehaviour, ISpeechRecognizerPlugin
 {
     [SerializeField] private Button startListeningBtn = null;
+    [SerializeField] private Button stopListeningBtn = null;
     [SerializeField] private Toggle continuousListeningTgle = null;
+    [SerializeField] private TMP_Dropdown languageDropdown = null;
+    [SerializeField] private TMP_InputField maxResultsInputField = null;
     [SerializeField] private TextMeshProUGUI resultsTxt = null;
+    [SerializeField] private TextMeshProUGUI errorsTxt = null;
 
     private SpeechRecognizerPlugin plugin = null;
 
-    void Start()
+    private void Start()
     {
         plugin = SpeechRecognizerPlugin.GetPlatformPluginVersion(this.gameObject.name);
 
         startListeningBtn.onClick.AddListener(StartListening);
+        stopListeningBtn.onClick.AddListener(StopListening);
         continuousListeningTgle.onValueChanged.AddListener(SetContinuousListening);
+        languageDropdown.onValueChanged.AddListener(SetLanguage);
+        maxResultsInputField.onEndEdit.AddListener(SetMaxResults);
     }
 
     private void StartListening()
     {
         plugin.StartListening();
     }
 
+    private void StopListening()
+    {
+        plugin.StopListening();
+    }
+
     private void SetContinuousListening(bool isContinuous)
     {
         plugin.SetContinuousListening(isContinuous);
     }
 
+    private void SetLanguage(int dropdownValue)
+    {
+        string newLanguage = languageDropdown.options[dropdownValue].text;
+        plugin.SetLanguageForNextRecognition(newLanguage);
+    }
+
+    private void SetMaxResults(string inputValue)
+    {
+        if (string.IsNullOrEmpty(inputValue))
+            return;
+
+        int maxResults = int.Parse(inputValue);
+        plugin.SetMaxResultsForNextRecognition(maxResults);
+    }
+
     public void OnResult(string recognizedResult)
     {
         char[] delimiterChars = { '~' };
@@ -40,4 +67,22 @@ public void OnResult(string recognizedResult)
             resultsTxt.text += result[i] + '\n';
         }
     }
+
+    public void OnError(string recognizedError)
+    {
+        ERROR error = (ERROR)int.Parse(recognizedError);
+        switch (error)
+        {
+            case ERROR.UNKNOWN:
+                Debug.Log("<b>ERROR: </b> Unknown");
+                errorsTxt.text += "Unknown";
+                break;
+            case ERROR.INVALID_LANGUAGE_FORMAT:
+                Debug.Log("<b>ERROR: </b> Language format is not valid");
+                errorsTxt.text += "Language format is not valid";
+                break;
+            default:
+                break;
+        }
+    }
 }

UnitySpeechRecognizer/Assets/Plugins/SpeechRecognizer/Android/UnitySpeechRecognizer.aar.meta

@@ -2,8 +2,11 @@
 
 public abstract class SpeechRecognizerPlugin
 {
+    protected bool isContinuousListening = false;
+    protected string language = "en-US";
+    protected int maxResults = 10;
     protected string gameObjectName = "SpeechRecognizer";
-
+    
     protected SpeechRecognizerPlugin(string gameObjectName = null)
     {
         this.gameObjectName = gameObjectName;
@@ -26,13 +29,22 @@ public static SpeechRecognizerPlugin GetPlatformPluginVersion(string gameObjectN
         }
     }
 
+    public enum ERROR { UNKNOWN, INVALID_LANGUAGE_FORMAT }
     public interface ISpeechRecognizerPlugin
     {
         void OnResult(string recognizedResult);
+        void OnError(string recognizedError);
     }
 
     //Features
     protected abstract void SetUp();
     public abstract void StartListening();
-    public abstract void SetContinuousListening(bool isContinuous);
+    public abstract void StartListening(bool setContinuousListening = false, string language = "en-US", int maxResults = 10);
+    public abstract void StopListening();
+    
+    //Remember that all this modifier-methods will be applied when the last recognition ends...
+    //...so only use them if continuous listening is enabled.
+    public abstract void SetContinuousListening(bool isContinuousListening);
+    public abstract void SetLanguageForNextRecognition(string newLanguage);
+    public abstract void SetMaxResultsForNextRecognition(int newMaxResults);
 }

UnitySpeechRecognizer/Assets/Scripts/SpeechRecognizer.cs

@@ -2,27 +2,50 @@
 
 public class SpeechRecognizerPlugin_Android : SpeechRecognizerPlugin
 {
-    public string javaClassPackageName = "com.example.eric.unityspeechrecognizerplugin.SpeechRecognizerFragment";
+    public SpeechRecognizerPlugin_Android(string gameObjectName) : base(gameObjectName) { }
+
+    private string javaClassPackageName = "com.example.eric.unityspeechrecognizerplugin.SpeechRecognizerFragment";
     private AndroidJavaClass javaClass = null;
-    AndroidJavaObject instance = null;
+    private AndroidJavaObject instance = null;
 
-    public SpeechRecognizerPlugin_Android(string gameObjectName) : base(gameObjectName) { }
+    protected override void SetUp()
+    {
+        Debug.Log("SetUpAndroid " + gameObjectName);
+        javaClass = new AndroidJavaClass(javaClassPackageName);
+        javaClass.CallStatic("SetUp", gameObjectName);
+        instance = javaClass.GetStatic<AndroidJavaObject>("instance");
+    }
 
     public override void StartListening()
     {
-        instance.Call("StartListening");
+        instance.Call("StartListening", this.isContinuousListening, this.language, this.maxResults);
+    }
+
+    public override void StartListening(bool isContinuous = false, string newLanguage = "en-US", int newMaxResults = 10)
+    {
+        instance.Call("StartListening", isContinuous, language, maxResults);
     }
 
+    public override void StopListening()
+    {
+        instance.Call("StopListening");
+    }        
+
     public override void SetContinuousListening(bool isContinuous)
     {
+        this.isContinuousListening = isContinuous;
         instance.Call("SetContinuousListening", isContinuous);
     }
 
-    protected override void SetUp()
+    public override void SetLanguageForNextRecognition(string newLanguage)
     {
-        Debug.Log("SetUpAndroid " + gameObjectName);
-        javaClass = new AndroidJavaClass(javaClassPackageName);
-        javaClass.CallStatic("SetUp", gameObjectName);
-        instance = javaClass.GetStatic<AndroidJavaObject>("instance");
+        this.language = newLanguage;
+        instance.Call("SetLanguage", newLanguage);
     }
+
+    public override void SetMaxResultsForNextRecognition(int newMaxResults)
+    {
+        this.maxResults = newMaxResults;
+        instance.Call("SetMaxResults", newMaxResults);
+    }    
 }

UnitySpeechRecognizer/Assets/Scripts/SpeechRecognizerPlugin.cs

@@ -2,26 +2,48 @@
 
 public class SpeechRecognizerPlugin_Editor : SpeechRecognizerPlugin
 {
-    private bool isContinuous = false;
-
     public SpeechRecognizerPlugin_Editor(string gameObjectName) : base(gameObjectName) { }
 
-    public override void SetContinuousListening(bool isContinuous)
+    private bool isContinuous = false;
+    
+    protected override void SetUp()
     {
-        this.isContinuous = isContinuous;
+        Debug.LogWarning("<b>WARNING</b>: You are running this plugin on Editor mode. Real recognition only works running on mobile device.");
     }
 
     public override void StartListening()
     {
         SpeechRecognizer speechRecognizer = GameObject.FindObjectOfType<SpeechRecognizer>();
-        if(this.isContinuous)
+        if (this.isContinuous)
             speechRecognizer.OnResult("continuous listening test~continuous listening test~continuous listening test");
         else
             speechRecognizer.OnResult("start listening test~start listening test~start listening test");
     }
 
-    protected override void SetUp()
+    public override void StartListening(bool setContinuousListening = false, string newLanguage = "en-US", int newMaxResults = 10)
     {
-        Debug.LogWarning("<b>WARNING</b>: You are running this plugin on Editor mode. Real recognition only works running on mobile device.");
+        StartListening();
+    }        
+    
+    public override void StopListening()
+    {
+        throw new System.NotImplementedException();
+    }
+
+    public override void SetContinuousListening(bool isContinuous)
+    {
+        this.isContinuous = isContinuous;
+    }
+
+    public override void SetLanguageForNextRecognition(string newLanguage)
+    {
+        Debug.Log("Language set: " + newLanguage);
+        this.language = newLanguage;
+    }
+
+    public override void SetMaxResultsForNextRecognition(int newMaxResults)
+    {
+        Debug.Log("Max results set: " + newMaxResults);
+        this.maxResults = newMaxResults;
     }
 }

UnitySpeechRecognizer/Assets/Scripts/SpeechRecognizerPlugin_Android.cs

@@ -44,5 +44,9 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   startListeningBtn: {fileID: 0}
+  stopListeningBtn: {fileID: 0}
   continuousListeningTgle: {fileID: 0}
+  languageDropdown: {fileID: 0}
+  maxResultsInputField: {fileID: 0}
   resultsTxt: {fileID: 0}
+  errorsTxt: {fileID: 0}