@capacitor-community/text-to-speech 4.0.1 → 4.1.0

package/README.md

@@ -30,20 +30,6 @@ npm install @capacitor-community/text-to-speech
 npx cap sync
 ```
 
-### Android
-
-According to the [Android documentation](https://developer.android.com/reference/android/speech/tts/TextToSpeech), apps targeting **Android 11** should declare [TextToSpeech.Engine.INTENT_ACTION_TTS_SERVICE](https://developer.android.com/reference/android/speech/tts/TextToSpeech.Engine#INTENT_ACTION_TTS_SERVICE) in the queries elements of their manifest:
-
-```xml
-<queries>
-  <intent>
-    <action android:name="android.intent.action.TTS_SERVICE" />
-  </intent>
-</queries>
-```
-
-[Here](https://github.com/robingenz/capacitor-plugin-demo/commit/b7dc6c6d6652be9356d354df1faeb6a40e442797) you can find an example commit.
-
 ## Configuration
 
 No configuration required for this plugin.
@@ -95,6 +81,7 @@ const isLanguageSupported = async (lang: string) => {
 * [`getSupportedVoices()`](#getsupportedvoices)
 * [`isLanguageSupported(...)`](#islanguagesupported)
 * [`openInstall()`](#openinstall)
+* [`addListener('onRangeStart', ...)`](#addlisteneronrangestart)
 * [Interfaces](#interfaces)
 
 </docgen-index>
@@ -184,6 +171,22 @@ Only available for Android.
 --------------------
 
 
+### addListener('onRangeStart', ...)
+
+```typescript
+addListener(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                |
+| ------------------ | ----------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'onRangeStart'</code>                                                         |
+| **`listenerFunc`** | <code>(info: { start: number; end: number; spokenWord: string; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -212,6 +215,13 @@ The <a href="#speechsynthesisvoice">SpeechSynthesisVoice</a> interface represent
 | **`name`**         | <code>string</code>  | Human-readable name that represents the voice.                                                              |
 | **`voiceURI`**     | <code>string</code>  | Type of URI and location of the speech synthesis service for this voice.                                    |
 
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
 </docgen-api>
 
 ## Changelog

package/android/src/main/AndroidManifest.xml

@@ -1,2 +1,7 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.TTS_SERVICE" />
+        </intent>
+    </queries>
 </manifest>

package/android/src/main/java/com/getcapacitor/community/tts/SpeakResultCallback.java

@@ -3,4 +3,5 @@ package com.getcapacitor.community.tts;
 public interface SpeakResultCallback {
     void onDone();
     void onError();
+    void onRangeStart(int start, int end, String spokenWord);
 }

package/android/src/main/java/com/getcapacitor/community/tts/TextToSpeech.java

@@ -13,7 +13,6 @@ import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.Comparator;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Set;
@@ -66,6 +65,12 @@ public class TextToSpeech implements android.speech.tts.TextToSpeech.OnInitListe
                 public void onError(String utteranceId) {
                     resultCallback.onError();
                 }
+
+                @Override
+                public void onRangeStart(String utteranceId, int start, int end, int frame) {
+                    String spokenWord = text.substring(start, end);
+                    resultCallback.onRangeStart(start, end, spokenWord);
+                }
             }
         );
 
@@ -116,6 +121,9 @@ public class TextToSpeech implements android.speech.tts.TextToSpeech.OnInitListe
         return result;
     }
 
+    /**
+     * @return Ordered list of voices. The order is guaranteed to remain the same as long as the voices in tts.getVoices() do not change.
+     */
     public ArrayList<Voice> getSupportedVoicesOrdered() {
         Set<Voice> supportedVoices = tts.getVoices();
         ArrayList<Voice> orderedVoices = new ArrayList<Voice>();
@@ -123,7 +131,8 @@ public class TextToSpeech implements android.speech.tts.TextToSpeech.OnInitListe
             orderedVoices.add(supportedVoice);
         }
 
-        Collections.sort(orderedVoices, Comparator.comparing(Voice::hashCode));
+        //voice.getName() is guaranteed to be unique, so will be used for sorting.
+        Collections.sort(orderedVoices, (v1, v2) -> v1.getName().compareTo(v2.getName()));
 
         return orderedVoices;
     }

package/android/src/main/java/com/getcapacitor/community/tts/TextToSpeechPlugin.java

@@ -1,5 +1,6 @@
 package com.getcapacitor.community.tts;
 
+import android.util.Base64;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
 import com.getcapacitor.Plugin;
@@ -53,6 +54,15 @@ public class TextToSpeechPlugin extends Plugin {
             public void onError() {
                 call.reject(ERROR_UTTERANCE);
             }
+
+            @Override
+            public void onRangeStart(int start, int end, String spokenWord) {
+                JSObject ret = new JSObject();
+                ret.put("start", start);
+                ret.put("end", end);
+                ret.put("spokenWord", spokenWord);
+                notifyListeners("onRangeStart", ret);
+            }
         };
 
         try {

package/dist/docs.json

@@ -80,6 +80,29 @@
         "docs": "Verifies proper installation and availability of resource files on the system.\n\nOnly available for Android.",
         "complexTypes": [],
         "slug": "openinstall"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'onRangeStart'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: { start: number; end: number; spokenWord: string; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlisteneronrangestart"
       }
     ],
     "properties": []
@@ -241,6 +264,22 @@
           "type": "string"
         }
       ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/definitions.d.ts

@@ -1,3 +1,4 @@
+import type { PluginListenerHandle } from '@capacitor/core';
 export interface TextToSpeechPlugin {
     /**
      * Starts the TTS engine and plays the desired text.
@@ -33,6 +34,11 @@ export interface TextToSpeechPlugin {
      * Only available for Android.
      */
     openInstall(): Promise<void>;
+    addListener(eventName: 'onRangeStart', listenerFunc: (info: {
+        start: number;
+        end: number;
+        spokenWord: string;
+    }) => void): Promise<PluginListenerHandle>;
 }
 export interface TTSOptions {
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface TextToSpeechPlugin {\n  /**\n   * Starts the TTS engine and plays the desired text.\n   */\n  speak(options: TTSOptions): Promise<void>;\n  /**\n   * Stops the TTS engine.\n   */\n  stop(): Promise<void>;\n  /**\n   * Returns a list of supported BCP 47 language tags.\n   */\n  getSupportedLanguages(): Promise<{ languages: string[] }>;\n  /**\n   * Returns a list of supported voices.\n   */\n  getSupportedVoices(): Promise<{ voices: SpeechSynthesisVoice[] }>;\n  /**\n   * Checks if a specific BCP 47 language tag is supported.\n   */\n  isLanguageSupported(options: {\n    lang: string;\n  }): Promise<{ supported: boolean }>;\n  /**\n   * Verifies proper installation and availability of resource files on the system.\n   *\n   * Only available for Android.\n   */\n  openInstall(): Promise<void>;\n}\n\nexport interface TTSOptions {\n  /**\n   * The text that will be synthesised when the utterance is spoken.\n   *\n   * @example \"Hello world\"\n   */\n  text: string;\n  /**\n   * The language of the utterance.\n   * Possible languages can be queried using `getSupportedLanguages`.\n   *\n   * @default \"en-US\"\n   */\n  lang?: string;\n  /**\n   * The speed at which the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  rate?: number;\n  /**\n   * The pitch at which the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  pitch?: number;\n  /**\n   * The volume that the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  volume?: number;\n  /**\n   * The index of the selected voice that will be used to speak the utterance.\n   * Possible voices can be queried using `getSupportedVoices`.\n   */\n  voice?: number;\n  /**\n   * Select the iOS Audio session category.\n   * Possible values: `ambient` and `playback`.\n   * Use `playback` to play audio even when the app is in the background.\n   *\n   * Only available for iOS.\n   *\n   * @default \"ambient\"\n   */\n  category?: string;\n}\n\n/**\n * The SpeechSynthesisVoice interface represents a voice that the system supports.\n */\nexport interface SpeechSynthesisVoice {\n  /**\n   * Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).\n   *\n   * @example false\n   */\n  default: boolean;\n  /**\n   * BCP 47 language tag indicating the language of the voice.\n   *\n   * @example \"en-US\"\n   */\n  lang: string;\n  /**\n   * Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.\n   *\n   * @example true\n   */\n  localService: boolean;\n  /**\n   * Human-readable name that represents the voice.\n   *\n   * @example \"Microsoft Zira Desktop - English (United States)\"\n   */\n  name: string;\n  /**\n   * Type of URI and location of the speech synthesis service for this voice.\n   *\n   * @example \"urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US\"\n   */\n  voiceURI: string;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface TextToSpeechPlugin {\n  /**\n   * Starts the TTS engine and plays the desired text.\n   */\n  speak(options: TTSOptions): Promise<void>;\n  /**\n   * Stops the TTS engine.\n   */\n  stop(): Promise<void>;\n  /**\n   * Returns a list of supported BCP 47 language tags.\n   */\n  getSupportedLanguages(): Promise<{ languages: string[] }>;\n  /**\n   * Returns a list of supported voices.\n   */\n  getSupportedVoices(): Promise<{ voices: SpeechSynthesisVoice[] }>;\n  /**\n   * Checks if a specific BCP 47 language tag is supported.\n   */\n  isLanguageSupported(options: {\n    lang: string;\n  }): Promise<{ supported: boolean }>;\n  /**\n   * Verifies proper installation and availability of resource files on the system.\n   *\n   * Only available for Android.\n   */\n  openInstall(): Promise<void>;\n\n  addListener(\n    eventName: 'onRangeStart',\n    listenerFunc: (info: {\n      start: number;\n      end: number;\n      spokenWord: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n}\n\nexport interface TTSOptions {\n  /**\n   * The text that will be synthesised when the utterance is spoken.\n   *\n   * @example \"Hello world\"\n   */\n  text: string;\n  /**\n   * The language of the utterance.\n   * Possible languages can be queried using `getSupportedLanguages`.\n   *\n   * @default \"en-US\"\n   */\n  lang?: string;\n  /**\n   * The speed at which the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  rate?: number;\n  /**\n   * The pitch at which the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  pitch?: number;\n  /**\n   * The volume that the utterance will be spoken at.\n   *\n   * @default 1.0\n   */\n  volume?: number;\n  /**\n   * The index of the selected voice that will be used to speak the utterance.\n   * Possible voices can be queried using `getSupportedVoices`.\n   */\n  voice?: number;\n  /**\n   * Select the iOS Audio session category.\n   * Possible values: `ambient` and `playback`.\n   * Use `playback` to play audio even when the app is in the background.\n   *\n   * Only available for iOS.\n   *\n   * @default \"ambient\"\n   */\n  category?: string;\n}\n\n/**\n * The SpeechSynthesisVoice interface represents a voice that the system supports.\n */\nexport interface SpeechSynthesisVoice {\n  /**\n   * Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).\n   *\n   * @example false\n   */\n  default: boolean;\n  /**\n   * BCP 47 language tag indicating the language of the voice.\n   *\n   * @example \"en-US\"\n   */\n  lang: string;\n  /**\n   * Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.\n   *\n   * @example true\n   */\n  localService: boolean;\n  /**\n   * Human-readable name that represents the voice.\n   *\n   * @example \"Microsoft Zira Desktop - English (United States)\"\n   */\n  name: string;\n  /**\n   * Type of URI and location of the speech synthesis service for this voice.\n   *\n   * @example \"urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US\"\n   */\n  voiceURI: string;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/text-to-speech",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Capacitor plugin for synthesizing speech from text.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -31,10 +31,10 @@
     "@capacitor/core": "6.0.0",
     "@capacitor/docgen": "0.2.0",
     "@capacitor/ios": "6.0.0",
-    "@ionic/eslint-config": "0.3.0",
+    "@ionic/eslint-config": "^0.4.0",
     "@ionic/prettier-config": "1.0.1",
     "@ionic/swiftlint-config": "1.1.2",
-    "eslint": "7.32.0",
+    "eslint": "^8.57.0",
     "prettier": "2.3.2",
     "prettier-plugin-java": "1.0.2",
     "rimraf": "3.0.2",