add allowForSilence during recording

README.md

@@ -53,6 +53,8 @@ No further action required.
 * [`isListening()`](#islistening)
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
+* [`addListener('endOfSegmentedSession', ...)`](#addlistenerendofsegmentedsession-)
+* [`addListener('segmentResults', ...)`](#addlistenersegmentresults-)
 * [`addListener('partialResults', ...)`](#addlistenerpartialresults-)
 * [`addListener('listeningState', ...)`](#addlistenerlisteningstate-)
 * [`removeAllListeners()`](#removealllisteners)
@@ -203,6 +205,52 @@ Request the speech recognition permission.
 --------------------
 
 
+### addListener('endOfSegmentedSession', ...)
+
+```typescript
+addListener(eventName: 'endOfSegmentedSession', listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+Called when allowForSilence set to &gt; 0 and segmented session has ended. (Android only)
+
+On Android it doesn't work if popup is true.
+
+| Param              | Type                                 |
+| ------------------ | ------------------------------------ |
+| **`eventName`**    | <code>'endOfSegmentedSession'</code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>           |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 6.0.2
+
+--------------------
+
+
+### addListener('segmentResults', ...)
+
+```typescript
+addListener(eventName: 'segmentResults', listenerFunc: (data: { matches: string[]; }) => void) => Promise<PluginListenerHandle>
+```
+
+Called when allowForSilence set to &gt; 0 and segment result received. (Android only)
+
+On Android it doesn't work if popup is true.
+
+Provides segment result.
+
+| Param              | Type                                                   |
+| ------------------ | ------------------------------------------------------ |
+| **`eventName`**    | <code>'segmentResults'</code>                          |
+| **`listenerFunc`** | <code>(data: { matches: string[]; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 6.0.2
+
+--------------------
+
+
 ### addListener('partialResults', ...)
 
 ```typescript
@@ -265,13 +313,14 @@ Remove all the listeners that are attached to this plugin.
 
 #### UtteranceOptions
 
-| Prop                 | Type                 | Description                                                      |
-| -------------------- | -------------------- | ---------------------------------------------------------------- |
-| **`language`**       | <code>string</code>  | key returned from `getSupportedLanguages()`                      |
-| **`maxResults`**     | <code>number</code>  | maximum number of results to return (5 is max)                   |
-| **`prompt`**         | <code>string</code>  | prompt message to display on popup (Android only)                |
-| **`popup`**          | <code>boolean</code> | display popup window when listening for utterance (Android only) |
-| **`partialResults`** | <code>boolean</code> | return partial results if found                                  |
+| Prop                  | Type                 | Description                                                                                                                                                                                |
+| --------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`language`**        | <code>string</code>  | key returned from `getSupportedLanguages()`                                                                                                                                                |
+| **`maxResults`**      | <code>number</code>  | maximum number of results to return (5 is max)                                                                                                                                             |
+| **`prompt`**          | <code>string</code>  | prompt message to display on popup (Android only)                                                                                                                                          |
+| **`popup`**           | <code>boolean</code> | display popup window when listening for utterance (Android only)                                                                                                                           |
+| **`partialResults`**  | <code>boolean</code> | return partial results if found                                                                                                                                                            |
+| **`allowForSilence`** | <code>number</code>  | allows milliseconds of silence during recording. Needs number over 0 (Android only) You need to listen to segmentResults to receive the data. On Android it doesn't work if popup is true. |
 
 
 #### PermissionStatus

android/src/main/java/com/getcapacitor/community/speechrecognition/SpeechRecognition.java

@@ -83,7 +83,8 @@ public void start(PluginCall call) {
         String prompt = call.getString("prompt", null);
         boolean partialResults = call.getBoolean("partialResults", false);
         boolean popup = call.getBoolean("popup", false);
-        beginListening(language, maxResults, prompt, partialResults, popup, call);
+        int allowForSilence = call.getInt("allowForSilence", 0);
+        beginListening(language, maxResults, prompt, partialResults, popup, call, allowForSilence);
     }
 
     @PluginMethod
@@ -159,7 +160,8 @@ private void beginListening(
         String prompt,
         final boolean partialResults,
         boolean showPopup,
-        PluginCall call
+        PluginCall call,
+        int allowForSilence
     ) {
         Logger.info(getLogTag(), "Beginning to listen for audible speech");
 
@@ -171,6 +173,12 @@ private void beginListening(
         intent.putExtra(RecognizerIntent.EXTRA_PARTIAL_RESULTS, partialResults);
         intent.putExtra("android.speech.extra.DICTATION_MODE", partialResults);
 
+        if (allowForSilence > 0) {
+            intent.putExtra(RecognizerIntent.EXTRA_SEGMENTED_SESSION, RecognizerIntent.EXTRA_SPEECH_INPUT_COMPLETE_SILENCE_LENGTH_MILLIS);
+            intent.putExtra(RecognizerIntent.EXTRA_SPEECH_INPUT_COMPLETE_SILENCE_LENGTH_MILLIS, allowForSilence);
+            intent.putExtra(RecognizerIntent.EXTRA_SPEECH_INPUT_POSSIBLY_COMPLETE_SILENCE_LENGTH_MILLIS, allowForSilence);
+        }
+
         if (prompt != null) {
             intent.putExtra(RecognizerIntent.EXTRA_PROMPT, prompt);
         }
@@ -332,6 +340,33 @@ public void onPartialResults(Bundle partialResults) {
             } catch (Exception ex) {}
         }
 
+        @Override
+        public void onSegmentResults(Bundle results) {
+            ArrayList<String> matches = results.getStringArrayList(SpeechRecognizer.RESULTS_RECOGNITION);
+
+            try {
+                JSArray jsArray = new JSArray(matches);
+
+                if (this.call != null) {
+                    if (!this.partialResults) {
+                        this.call.resolve(new JSObject().put("status", "success").put("matches", jsArray));
+                    } else {
+                        JSObject ret = new JSObject();
+                        ret.put("matches", jsArray);
+                        notifyListeners("segmentResults", ret);
+                    }
+                }
+            } catch (Exception ex) {
+                this.call.resolve(new JSObject().put("status", "error").put("message", ex.getMessage()));
+            }
+        }
+
+        @Override
+        public void onEndOfSegmentedSession() {
+            JSObject ret = new JSObject();
+            notifyListeners("endOfSegmentedSession", ret);
+        }
+
         @Override
         public void onEvent(int eventType, Bundle params) {}
     }

src/definitions.ts

@@ -65,6 +65,30 @@ export interface SpeechRecognitionPlugin {
    * @since 5.0.0
    */
   requestPermissions(): Promise<PermissionStatus>;
+  /**
+   * Called when allowForSilence set to > 0 and segmented session has ended. (Android only)
+   *
+   * On Android it doesn't work if popup is true.
+   *
+   * @since 6.0.2
+   */
+  addListener(
+    eventName: 'endOfSegmentedSession',
+    listenerFunc: () => void,
+  ): Promise<PluginListenerHandle>;
+  /**
+   * Called when allowForSilence set to > 0 and segment result received. (Android only)
+   *
+   * On Android it doesn't work if popup is true.
+   *
+   * Provides segment result.
+   *
+   * @since 6.0.2
+   */
+  addListener(
+    eventName: 'segmentResults',
+    listenerFunc: (data: { matches: string[] }) => void,
+  ): Promise<PluginListenerHandle>;
   /**
    * Called when partialResults set to true and result received.
    *
@@ -78,7 +102,6 @@ export interface SpeechRecognitionPlugin {
     eventName: 'partialResults',
     listenerFunc: (data: { matches: string[] }) => void,
   ): Promise<PluginListenerHandle>;
-
   /**
    * Called when listening state changed.
    *
@@ -117,4 +140,12 @@ export interface UtteranceOptions {
    * return partial results if found
    */
   partialResults?: boolean;
+  /**
+   * allows milliseconds of silence during recording. Needs number over 0 (Android only)
+   *
+   * You need to listen to segmentResults to receive the data.
+   *
+   * On Android it doesn't work if popup is true.
+   */
+  allowForSilence?: number;
 }