@capacitor-community/text-to-speech 1.1.1 → 1.1.3-dev.690a781.1659193180

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

@@ -1,162 +1,162 @@
-package com.getcapacitor.community.tts;
-
-import android.content.Context;
-import android.content.Intent;
-import android.content.pm.PackageManager;
-import android.content.pm.ResolveInfo;
-import android.os.Build;
-import android.os.Bundle;
-import android.speech.tts.UtteranceProgressListener;
-import android.speech.tts.Voice;
-import android.util.Log;
-import com.getcapacitor.JSArray;
-import com.getcapacitor.JSObject;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.Locale;
-import java.util.Set;
-
-public class TextToSpeech implements android.speech.tts.TextToSpeech.OnInitListener {
-
-    public static final String LOG_TAG = "TextToSpeech";
-
-    private Context context;
-    private android.speech.tts.TextToSpeech tts = null;
-    private int initializationStatus;
-    private JSObject[] supportedVoices = null;
-
-    TextToSpeech(Context context) {
-        this.context = context;
-        try {
-            tts = new android.speech.tts.TextToSpeech(context, this);
-        } catch (Exception ex) {
-            Log.d(LOG_TAG, ex.getLocalizedMessage());
-        }
-    }
-
-    @Override
-    public void onInit(int status) {
-        this.initializationStatus = status;
-    }
-
-    public void speak(
-        String text,
-        String lang,
-        float rate,
-        float pitch,
-        float volume,
-        String callbackId,
-        SpeakResultCallback resultCallback
-    ) {
-        tts.stop();
-        tts.setOnUtteranceProgressListener(
-            new UtteranceProgressListener() {
-                @Override
-                public void onStart(String utteranceId) {}
-
-                @Override
-                public void onDone(String utteranceId) {
-                    resultCallback.onDone();
-                }
-
-                @Override
-                public void onError(String utteranceId) {
-                    resultCallback.onError();
-                }
-            }
-        );
-
-        Locale locale = Locale.forLanguageTag(lang);
-
-        if (Build.VERSION.SDK_INT >= 21) {
-            Bundle ttsParams = new Bundle();
-            ttsParams.putSerializable(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_UTTERANCE_ID, callbackId);
-            ttsParams.putSerializable(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_VOLUME, volume);
-
-            tts.setLanguage(locale);
-            tts.setSpeechRate(rate);
-            tts.setPitch(pitch);
-            tts.speak(text, android.speech.tts.TextToSpeech.QUEUE_FLUSH, ttsParams, callbackId);
-        } else {
-            HashMap<String, String> ttsParams = new HashMap<>();
-            ttsParams.put(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_UTTERANCE_ID, callbackId);
-            ttsParams.put(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_VOLUME, Float.toString(volume));
-
-            tts.setLanguage(locale);
-            tts.setSpeechRate(rate);
-            tts.setPitch(pitch);
-            tts.speak(text, android.speech.tts.TextToSpeech.QUEUE_FLUSH, ttsParams);
-        }
-    }
-
-    public void stop() {
-        tts.stop();
-    }
-
-    public JSArray getSupportedLanguages() {
-        ArrayList<String> languages = new ArrayList<>();
-        Set<Locale> supportedLocales = tts.getAvailableLanguages();
-        for (Locale supportedLocale : supportedLocales) {
-            String tag = supportedLocale.toLanguageTag();
-            languages.add(tag);
-        }
-        JSArray result = JSArray.from(languages.toArray());
-        return result;
-    }
-
-    public JSArray getSupportedVoices() {
-        ArrayList<JSObject> voices = new ArrayList<>();
-        Set<Voice> supportedVoices = tts.getVoices();
-        for (Voice supportedVoice : supportedVoices) {
-            JSObject obj = this.convertVoiceToJSObject(supportedVoice);
-            voices.add(obj);
-        }
-        JSArray result = JSArray.from(voices.toArray());
-        return result;
-    }
-
-    public void openInstall() {
-        PackageManager packageManager = context.getPackageManager();
-        Intent installIntent = new Intent();
-        installIntent.setAction(android.speech.tts.TextToSpeech.Engine.ACTION_CHECK_TTS_DATA);
-
-        ResolveInfo resolveInfo = packageManager.resolveActivity(installIntent, PackageManager.MATCH_DEFAULT_ONLY);
-
-        if (resolveInfo != null) {
-            installIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-            context.startActivity(installIntent);
-        }
-    }
-
-    public boolean isAvailable() {
-        if (tts != null && initializationStatus == android.speech.tts.TextToSpeech.SUCCESS) {
-            return true;
-        }
-        return false;
-    }
-
-    public boolean isLanguageSupported(String lang) {
-        Locale locale = Locale.forLanguageTag(lang);
-        int result = tts.isLanguageAvailable(locale);
-        return result == tts.LANG_AVAILABLE || result == tts.LANG_COUNTRY_AVAILABLE || result == tts.LANG_COUNTRY_VAR_AVAILABLE;
-    }
-
-    public void onDestroy() {
-        if (tts == null) {
-            return;
-        }
-        tts.stop();
-        tts.shutdown();
-    }
-
-    private JSObject convertVoiceToJSObject(Voice voice) {
-        Locale locale = voice.getLocale();
-        JSObject obj = new JSObject();
-        obj.put("voiceURI", voice.getName());
-        obj.put("name", locale.getDisplayLanguage() + " " + locale.getDisplayCountry());
-        obj.put("lang", locale.toLanguageTag());
-        obj.put("localService", !voice.isNetworkConnectionRequired());
-        obj.put("default", false);
-        return obj;
-    }
-}
+package com.getcapacitor.community.tts;
+
+import android.content.Context;
+import android.content.Intent;
+import android.content.pm.PackageManager;
+import android.content.pm.ResolveInfo;
+import android.os.Build;
+import android.os.Bundle;
+import android.speech.tts.UtteranceProgressListener;
+import android.speech.tts.Voice;
+import android.util.Log;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Set;
+
+public class TextToSpeech implements android.speech.tts.TextToSpeech.OnInitListener {
+
+    public static final String LOG_TAG = "TextToSpeech";
+
+    private Context context;
+    private android.speech.tts.TextToSpeech tts = null;
+    private int initializationStatus;
+    private JSObject[] supportedVoices = null;
+
+    TextToSpeech(Context context) {
+        this.context = context;
+        try {
+            tts = new android.speech.tts.TextToSpeech(context, this);
+        } catch (Exception ex) {
+            Log.d(LOG_TAG, ex.getLocalizedMessage());
+        }
+    }
+
+    @Override
+    public void onInit(int status) {
+        this.initializationStatus = status;
+    }
+
+    public void speak(
+        String text,
+        String lang,
+        float rate,
+        float pitch,
+        float volume,
+        String callbackId,
+        SpeakResultCallback resultCallback
+    ) {
+        tts.stop();
+        tts.setOnUtteranceProgressListener(
+            new UtteranceProgressListener() {
+                @Override
+                public void onStart(String utteranceId) {}
+
+                @Override
+                public void onDone(String utteranceId) {
+                    resultCallback.onDone();
+                }
+
+                @Override
+                public void onError(String utteranceId) {
+                    resultCallback.onError();
+                }
+            }
+        );
+
+        Locale locale = Locale.forLanguageTag(lang);
+
+        if (Build.VERSION.SDK_INT >= 21) {
+            Bundle ttsParams = new Bundle();
+            ttsParams.putSerializable(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_UTTERANCE_ID, callbackId);
+            ttsParams.putSerializable(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_VOLUME, volume);
+
+            tts.setLanguage(locale);
+            tts.setSpeechRate(rate);
+            tts.setPitch(pitch);
+            tts.speak(text, android.speech.tts.TextToSpeech.QUEUE_FLUSH, ttsParams, callbackId);
+        } else {
+            HashMap<String, String> ttsParams = new HashMap<>();
+            ttsParams.put(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_UTTERANCE_ID, callbackId);
+            ttsParams.put(android.speech.tts.TextToSpeech.Engine.KEY_PARAM_VOLUME, Float.toString(volume));
+
+            tts.setLanguage(locale);
+            tts.setSpeechRate(rate);
+            tts.setPitch(pitch);
+            tts.speak(text, android.speech.tts.TextToSpeech.QUEUE_FLUSH, ttsParams);
+        }
+    }
+
+    public void stop() {
+        tts.stop();
+    }
+
+    public JSArray getSupportedLanguages() {
+        ArrayList<String> languages = new ArrayList<>();
+        Set<Locale> supportedLocales = tts.getAvailableLanguages();
+        for (Locale supportedLocale : supportedLocales) {
+            String tag = supportedLocale.toLanguageTag();
+            languages.add(tag);
+        }
+        JSArray result = JSArray.from(languages.toArray());
+        return result;
+    }
+
+    public JSArray getSupportedVoices() {
+        ArrayList<JSObject> voices = new ArrayList<>();
+        Set<Voice> supportedVoices = tts.getVoices();
+        for (Voice supportedVoice : supportedVoices) {
+            JSObject obj = this.convertVoiceToJSObject(supportedVoice);
+            voices.add(obj);
+        }
+        JSArray result = JSArray.from(voices.toArray());
+        return result;
+    }
+
+    public void openInstall() {
+        PackageManager packageManager = context.getPackageManager();
+        Intent installIntent = new Intent();
+        installIntent.setAction(android.speech.tts.TextToSpeech.Engine.ACTION_CHECK_TTS_DATA);
+
+        ResolveInfo resolveInfo = packageManager.resolveActivity(installIntent, PackageManager.MATCH_DEFAULT_ONLY);
+
+        if (resolveInfo != null) {
+            installIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            context.startActivity(installIntent);
+        }
+    }
+
+    public boolean isAvailable() {
+        if (tts != null && initializationStatus == android.speech.tts.TextToSpeech.SUCCESS) {
+            return true;
+        }
+        return false;
+    }
+
+    public boolean isLanguageSupported(String lang) {
+        Locale locale = Locale.forLanguageTag(lang);
+        int result = tts.isLanguageAvailable(locale);
+        return result == tts.LANG_AVAILABLE || result == tts.LANG_COUNTRY_AVAILABLE || result == tts.LANG_COUNTRY_VAR_AVAILABLE;
+    }
+
+    public void onDestroy() {
+        if (tts == null) {
+            return;
+        }
+        tts.stop();
+        tts.shutdown();
+    }
+
+    private JSObject convertVoiceToJSObject(Voice voice) {
+        Locale locale = voice.getLocale();
+        JSObject obj = new JSObject();
+        obj.put("voiceURI", voice.getName());
+        obj.put("name", locale.getDisplayLanguage() + " " + locale.getDisplayCountry());
+        obj.put("lang", locale.toLanguageTag());
+        obj.put("localService", !voice.isNetworkConnectionRequired());
+        obj.put("default", false);
+        return obj;
+    }
+}

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

@@ -1,130 +1,130 @@
-package com.getcapacitor.community.tts;
-
-import com.getcapacitor.JSArray;
-import com.getcapacitor.JSObject;
-import com.getcapacitor.Plugin;
-import com.getcapacitor.PluginCall;
-import com.getcapacitor.PluginMethod;
-import com.getcapacitor.annotation.CapacitorPlugin;
-
-@CapacitorPlugin(name = "TextToSpeech")
-public class TextToSpeechPlugin extends Plugin {
-
-    public static final String LOG_TAG = "TextToSpeechPlugin";
-
-    public static final String ERROR_UTTERANCE = "Failed to read text.";
-    public static final String ERROR_UNSUPPORTED_LANGUAGE = "This language is not supported.";
-
-    private TextToSpeech implementation;
-
-    @Override
-    public void load() {
-        implementation = new TextToSpeech(getContext());
-    }
-
-    @PluginMethod
-    public void speak(PluginCall call) {
-        boolean isAvailable = implementation.isAvailable();
-        if (!isAvailable) {
-            call.unavailable("Not yet initialized or not available on this device.");
-            return;
-        }
-
-        String text = call.getString("text", "");
-        String lang = call.getString("lang", "en-US");
-        float rate = call.getFloat("rate", 1.0f);
-        float pitch = call.getFloat("pitch", 1.0f);
-        float volume = call.getFloat("volume", 1.0f);
-
-        boolean isLanguageSupported = implementation.isLanguageSupported(lang);
-        if (!isLanguageSupported) {
-            call.reject(ERROR_UNSUPPORTED_LANGUAGE);
-            return;
-        }
-
-        SpeakResultCallback resultCallback = new SpeakResultCallback() {
-            @Override
-            public void onDone() {
-                call.resolve();
-            }
-
-            @Override
-            public void onError() {
-                call.reject(ERROR_UTTERANCE);
-            }
-        };
-
-        try {
-            implementation.speak(text, lang, rate, pitch, volume, call.getCallbackId(), resultCallback);
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @PluginMethod
-    public void stop(PluginCall call) {
-        boolean isAvailable = implementation.isAvailable();
-        if (!isAvailable) {
-            call.unavailable("Not yet initialized or not available on this device.");
-            return;
-        }
-        try {
-            implementation.stop();
-            call.resolve();
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @PluginMethod
-    public void getSupportedLanguages(PluginCall call) {
-        try {
-            JSArray languages = implementation.getSupportedLanguages();
-            JSObject ret = new JSObject();
-            ret.put("languages", languages);
-            call.resolve(ret);
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @PluginMethod
-    public void getSupportedVoices(PluginCall call) {
-        try {
-            JSArray voices = implementation.getSupportedVoices();
-            JSObject ret = new JSObject();
-            ret.put("voices", voices);
-            call.resolve(ret);
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @PluginMethod
-    public void isLanguageSupported(PluginCall call) {
-        String lang = call.getString("lang", "");
-        try {
-            boolean isLanguageSupported = implementation.isLanguageSupported(lang);
-            JSObject ret = new JSObject();
-            ret.put("supported", isLanguageSupported);
-            call.resolve(ret);
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @PluginMethod
-    public void openInstall(PluginCall call) {
-        try {
-            implementation.openInstall();
-            call.resolve();
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage());
-        }
-    }
-
-    @Override
-    protected void handleOnDestroy() {
-        implementation.onDestroy();
-    }
-}
+package com.getcapacitor.community.tts;
+
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "TextToSpeech")
+public class TextToSpeechPlugin extends Plugin {
+
+    public static final String LOG_TAG = "TextToSpeechPlugin";
+
+    public static final String ERROR_UTTERANCE = "Failed to read text.";
+    public static final String ERROR_UNSUPPORTED_LANGUAGE = "This language is not supported.";
+
+    private TextToSpeech implementation;
+
+    @Override
+    public void load() {
+        implementation = new TextToSpeech(getContext());
+    }
+
+    @PluginMethod
+    public void speak(PluginCall call) {
+        boolean isAvailable = implementation.isAvailable();
+        if (!isAvailable) {
+            call.unavailable("Not yet initialized or not available on this device.");
+            return;
+        }
+
+        String text = call.getString("text", "");
+        String lang = call.getString("lang", "en-US");
+        float rate = call.getFloat("rate", 1.0f);
+        float pitch = call.getFloat("pitch", 1.0f);
+        float volume = call.getFloat("volume", 1.0f);
+
+        boolean isLanguageSupported = implementation.isLanguageSupported(lang);
+        if (!isLanguageSupported) {
+            call.reject(ERROR_UNSUPPORTED_LANGUAGE);
+            return;
+        }
+
+        SpeakResultCallback resultCallback = new SpeakResultCallback() {
+            @Override
+            public void onDone() {
+                call.resolve();
+            }
+
+            @Override
+            public void onError() {
+                call.reject(ERROR_UTTERANCE);
+            }
+        };
+
+        try {
+            implementation.speak(text, lang, rate, pitch, volume, call.getCallbackId(), resultCallback);
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void stop(PluginCall call) {
+        boolean isAvailable = implementation.isAvailable();
+        if (!isAvailable) {
+            call.unavailable("Not yet initialized or not available on this device.");
+            return;
+        }
+        try {
+            implementation.stop();
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getSupportedLanguages(PluginCall call) {
+        try {
+            JSArray languages = implementation.getSupportedLanguages();
+            JSObject ret = new JSObject();
+            ret.put("languages", languages);
+            call.resolve(ret);
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getSupportedVoices(PluginCall call) {
+        try {
+            JSArray voices = implementation.getSupportedVoices();
+            JSObject ret = new JSObject();
+            ret.put("voices", voices);
+            call.resolve(ret);
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void isLanguageSupported(PluginCall call) {
+        String lang = call.getString("lang", "");
+        try {
+            boolean isLanguageSupported = implementation.isLanguageSupported(lang);
+            JSObject ret = new JSObject();
+            ret.put("supported", isLanguageSupported);
+            call.resolve(ret);
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void openInstall(PluginCall call) {
+        try {
+            implementation.openInstall();
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        implementation.onDestroy();
+    }
+}

package/dist/docs.json

@@ -77,7 +77,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Verifies proper installation and availability of resource files on the system.\r\n\r\nOnly available for Android.",
+        "docs": "Verifies proper installation and availability of resource files on the system.\n\nOnly available for Android.",
         "complexTypes": [],
         "slug": "openinstall"
       }
@@ -102,42 +102,42 @@
         {
           "name": "lang",
           "tags": [],
-          "docs": "The language of the utterance.\r\nPossible languages can be queried using `getSupportedLanguages`.\r\n\r\nDefault: `en-US`.",
+          "docs": "The language of the utterance.\nPossible languages can be queried using `getSupportedLanguages`.\n\nDefault: `en-US`.",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "rate",
           "tags": [],
-          "docs": "The speed at which the utterance will be spoken at.\r\n\r\nDefault: `1.0`.",
+          "docs": "The speed at which the utterance will be spoken at.\n\nDefault: `1.0`.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "pitch",
           "tags": [],
-          "docs": "The pitch at which the utterance will be spoken at.\r\n\r\nDefault: `1.0`.",
+          "docs": "The pitch at which the utterance will be spoken at.\n\nDefault: `1.0`.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "volume",
           "tags": [],
-          "docs": "The volume that the utterance will be spoken at.\r\n\r\nDefault: `1.0`.",
+          "docs": "The volume that the utterance will be spoken at.\n\nDefault: `1.0`.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "voice",
           "tags": [],
-          "docs": "The index of the selected voice that will be used to speak the utterance.\r\nPossible voices can be queried using `getSupportedVoices`.\r\n\r\nOnly available for Web.",
+          "docs": "The index of the selected voice that will be used to speak the utterance.\nPossible voices can be queried using `getSupportedVoices`.\n\nOnly available for Web.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "category",
           "tags": [],
-          "docs": "Select the iOS Audio session category.\r\nPossible values: `ambient` and `playback`.\r\nUse `playback` to play audio even when the app is in the background.\r\n\r\nOnly available for iOS.\r\n\r\nDefault: `ambient`.",
+          "docs": "Select the iOS Audio session category.\nPossible values: `ambient` and `playback`.\nUse `playback` to play audio even when the app is in the background.\n\nOnly available for iOS.\n\nDefault: `ambient`.",
           "complexTypes": [],
           "type": "string | undefined"
         }
@@ -160,7 +160,7 @@
         {
           "name": "lang",
           "tags": [],
-          "docs": "BCP 47 language tag indicating the language of the voice.\r\nExample: `en-US`.",
+          "docs": "BCP 47 language tag indicating the language of the voice.\nExample: `en-US`.",
           "complexTypes": [],
           "type": "string"
         },
@@ -174,14 +174,14 @@
         {
           "name": "name",
           "tags": [],
-          "docs": "Human-readable name that represents the voice.\r\nExample: `Microsoft Zira Desktop - English (United States)`.",
+          "docs": "Human-readable name that represents the voice.\nExample: `Microsoft Zira Desktop - English (United States)`.",
           "complexTypes": [],
           "type": "string"
         },
         {
           "name": "voiceURI",
           "tags": [],
-          "docs": "Type of URI and location of the speech synthesis service for this voice.\r\nExample: `urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US`.",
+          "docs": "Type of URI and location of the speech synthesis service for this voice.\nExample: `urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US`.",
           "complexTypes": [],
           "type": "string"
         }