@capacitor-community/text-to-speech 1.0.0 → 1.1.2-dev.aaa3396.1649088226

package/dist/docs.json

@@ -39,7 +39,7 @@
         "parameters": [],
         "returns": "Promise<{ languages: string[]; }>",
         "tags": [],
-        "docs": "Returns a list of supported languages.",
+        "docs": "Returns a list of supported BCP 47 language tags.",
         "complexTypes": [],
         "slug": "getsupportedlanguages"
       },
@@ -55,13 +55,29 @@
         ],
         "slug": "getsupportedvoices"
       },
+      {
+        "name": "isLanguageSupported",
+        "signature": "(options: { lang: string; }) => Promise<{ supported: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ lang: string; }"
+          }
+        ],
+        "returns": "Promise<{ supported: boolean; }>",
+        "tags": [],
+        "docs": "Checks if a specific BCP 47 language tag is supported.",
+        "complexTypes": [],
+        "slug": "islanguagesupported"
+      },
       {
         "name": "openInstall",
         "signature": "() => Promise<void>",
         "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"
       }
@@ -86,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"
         }
@@ -144,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"
         },
@@ -158,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"
         }

package/dist/esm/definitions.d.ts

@@ -1,104 +1,112 @@
-export interface TextToSpeechPlugin {
-    /**
-     * Starts the TTS engine and plays the desired text.
-     */
-    speak(options: TTSOptions): Promise<void>;
-    /**
-     * Stops the TTS engine.
-     */
-    stop(): Promise<void>;
-    /**
-     * Returns a list of supported languages.
-     */
-    getSupportedLanguages(): Promise<{
-        languages: string[];
-    }>;
-    /**
-     * Returns a list of supported voices.
-     */
-    getSupportedVoices(): Promise<{
-        voices: SpeechSynthesisVoice[];
-    }>;
-    /**
-     * Verifies proper installation and availability of resource files on the system.
-     *
-     * Only available for Android.
-     */
-    openInstall(): Promise<void>;
-}
-export interface TTSOptions {
-    /**
-     * The text that will be synthesised when the utterance is spoken.
-     */
-    text: string;
-    /**
-     * The language of the utterance.
-     * Possible languages can be queried using `getSupportedLanguages`.
-     *
-     * Default: `en-US`.
-     */
-    lang?: string;
-    /**
-     * The speed at which the utterance will be spoken at.
-     *
-     * Default: `1.0`.
-     */
-    rate?: number;
-    /**
-     * The pitch at which the utterance will be spoken at.
-     *
-     * Default: `1.0`.
-     */
-    pitch?: number;
-    /**
-     * The volume that the utterance will be spoken at.
-     *
-     * Default: `1.0`.
-     */
-    volume?: number;
-    /**
-     * The index of the selected voice that will be used to speak the utterance.
-     * Possible voices can be queried using `getSupportedVoices`.
-     *
-     * Only available for Web.
-     */
-    voice?: number;
-    /**
-     * Select the iOS Audio session category.
-     * Possible values: `ambient` and `playback`.
-     * Use `playback` to play audio even when the app is in the background.
-     *
-     * Only available for iOS.
-     *
-     * Default: `ambient`.
-     */
-    category?: string;
-}
-/**
- * The SpeechSynthesisVoice interface represents a voice that the system supports.
- */
-export interface SpeechSynthesisVoice {
-    /**
-     * Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).
-     */
-    default: boolean;
-    /**
-     * BCP 47 language tag indicating the language of the voice.
-     * Example: `en-US`.
-     */
-    lang: string;
-    /**
-     * Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.
-     */
-    localService: boolean;
-    /**
-     * Human-readable name that represents the voice.
-     * Example: `Microsoft Zira Desktop - English (United States)`.
-     */
-    name: string;
-    /**
-     * Type of URI and location of the speech synthesis service for this voice.
-     * Example: `urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US`.
-     */
-    voiceURI: string;
-}
+export interface TextToSpeechPlugin {
+    /**
+     * Starts the TTS engine and plays the desired text.
+     */
+    speak(options: TTSOptions): Promise<void>;
+    /**
+     * Stops the TTS engine.
+     */
+    stop(): Promise<void>;
+    /**
+     * Returns a list of supported BCP 47 language tags.
+     */
+    getSupportedLanguages(): Promise<{
+        languages: string[];
+    }>;
+    /**
+     * Returns a list of supported voices.
+     */
+    getSupportedVoices(): Promise<{
+        voices: SpeechSynthesisVoice[];
+    }>;
+    /**
+     * Checks if a specific BCP 47 language tag is supported.
+     */
+    isLanguageSupported(options: {
+        lang: string;
+    }): Promise<{
+        supported: boolean;
+    }>;
+    /**
+     * Verifies proper installation and availability of resource files on the system.
+     *
+     * Only available for Android.
+     */
+    openInstall(): Promise<void>;
+}
+export interface TTSOptions {
+    /**
+     * The text that will be synthesised when the utterance is spoken.
+     */
+    text: string;
+    /**
+     * The language of the utterance.
+     * Possible languages can be queried using `getSupportedLanguages`.
+     *
+     * Default: `en-US`.
+     */
+    lang?: string;
+    /**
+     * The speed at which the utterance will be spoken at.
+     *
+     * Default: `1.0`.
+     */
+    rate?: number;
+    /**
+     * The pitch at which the utterance will be spoken at.
+     *
+     * Default: `1.0`.
+     */
+    pitch?: number;
+    /**
+     * The volume that the utterance will be spoken at.
+     *
+     * Default: `1.0`.
+     */
+    volume?: number;
+    /**
+     * The index of the selected voice that will be used to speak the utterance.
+     * Possible voices can be queried using `getSupportedVoices`.
+     *
+     * Only available for Web.
+     */
+    voice?: number;
+    /**
+     * Select the iOS Audio session category.
+     * Possible values: `ambient` and `playback`.
+     * Use `playback` to play audio even when the app is in the background.
+     *
+     * Only available for iOS.
+     *
+     * Default: `ambient`.
+     */
+    category?: string;
+}
+/**
+ * The SpeechSynthesisVoice interface represents a voice that the system supports.
+ */
+export interface SpeechSynthesisVoice {
+    /**
+     * Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).
+     */
+    default: boolean;
+    /**
+     * BCP 47 language tag indicating the language of the voice.
+     * Example: `en-US`.
+     */
+    lang: string;
+    /**
+     * Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.
+     */
+    localService: boolean;
+    /**
+     * Human-readable name that represents the voice.
+     * Example: `Microsoft Zira Desktop - English (United States)`.
+     */
+    name: string;
+    /**
+     * Type of URI and location of the speech synthesis service for this voice.
+     * Example: `urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US`.
+     */
+    voiceURI: string;
+}

package/dist/esm/definitions.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":""}
+{"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  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   * Only available for Web.\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; // iOS only\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  default: boolean;\n  /**\n   * BCP 47 language tag indicating the language of the voice.\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  localService: boolean;\n  /**\n   * Human-readable name that represents the voice.\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   * Example: `urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US`.\n   */\n  voiceURI: string;\n}\n"]}

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import type { TextToSpeechPlugin } from './definitions';
-declare const TextToSpeech: TextToSpeechPlugin;
-export * from './definitions';
-export { TextToSpeech };
+import type { TextToSpeechPlugin } from './definitions';
+declare const TextToSpeech: TextToSpeechPlugin;
+export * from './definitions';
+export { TextToSpeech };

package/dist/esm/index.js

@@ -1,11 +1,11 @@
-import { registerPlugin } from '@capacitor/core';
-const TextToSpeech = registerPlugin('TextToSpeech', {
-    web: () => import('./web').then(m => new m.TextToSpeechWeb()),
-});
-// Warm up
-if ('speechSynthesis' in window) {
-    window.speechSynthesis;
-}
-export * from './definitions';
-export { TextToSpeech };
+import { registerPlugin } from '@capacitor/core';
+const TextToSpeech = registerPlugin('TextToSpeech', {
+    web: () => import('./web').then(m => new m.TextToSpeechWeb()),
+});
+// Warm up
+if ('speechSynthesis' in window) {
+    window.speechSynthesis;
+}
+export * from './definitions';
+export { TextToSpeech };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,YAAY,GAAG,cAAc,CAAqB,cAAc,EAAE;IACtE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,UAAU;AACV,IAAI,iBAAiB,IAAI,MAAM,EAAE;IAC/B,MAAM,CAAC,eAAe,CAAC;CACxB;AAED,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,YAAY,GAAG,cAAc,CAAqB,cAAc,EAAE;IACtE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,UAAU;AACV,IAAI,iBAAiB,IAAI,MAAM,EAAE;IAC/B,MAAM,CAAC,eAAe,CAAC;CACxB;AAED,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { TextToSpeechPlugin } from './definitions';\n\nconst TextToSpeech = registerPlugin<TextToSpeechPlugin>('TextToSpeech', {\n  web: () => import('./web').then(m => new m.TextToSpeechWeb()),\n});\n\n// Warm up\nif ('speechSynthesis' in window) {\n  window.speechSynthesis;\n}\n\nexport * from './definitions';\nexport { TextToSpeech };\n"]}

package/dist/esm/web.d.ts

@@ -1,20 +1,25 @@
-import { WebPlugin } from '@capacitor/core';
-import type { TextToSpeechPlugin, TTSOptions } from './definitions';
-export declare class TextToSpeechWeb extends WebPlugin implements TextToSpeechPlugin {
-    private speechSynthesis;
-    private supportedVoices;
-    constructor();
-    speak(options: TTSOptions): Promise<void>;
-    stop(): Promise<void>;
-    getSupportedLanguages(): Promise<{
-        languages: string[];
-    }>;
-    getSupportedVoices(): Promise<{
-        voices: SpeechSynthesisVoice[];
-    }>;
-    openInstall(): Promise<void>;
-    private createSpeechSynthesisUtterance;
-    private getSpeechSynthesisVoices;
-    private throwUnsupportedError;
-    private throwUnimplementedError;
-}
+import { WebPlugin } from '@capacitor/core';
+import type { TextToSpeechPlugin, TTSOptions } from './definitions';
+export declare class TextToSpeechWeb extends WebPlugin implements TextToSpeechPlugin {
+    private speechSynthesis;
+    private supportedVoices;
+    constructor();
+    speak(options: TTSOptions): Promise<void>;
+    stop(): Promise<void>;
+    getSupportedLanguages(): Promise<{
+        languages: string[];
+    }>;
+    getSupportedVoices(): Promise<{
+        voices: SpeechSynthesisVoice[];
+    }>;
+    isLanguageSupported(options: {
+        lang: string;
+    }): Promise<{
+        supported: boolean;
+    }>;
+    openInstall(): Promise<void>;
+    private createSpeechSynthesisUtterance;
+    private getSpeechSynthesisVoices;
+    private throwUnsupportedError;
+    private throwUnimplementedError;
+}

package/dist/esm/web.js

@@ -1,84 +1,92 @@
-import { WebPlugin } from '@capacitor/core';
-export class TextToSpeechWeb extends WebPlugin {
-    constructor() {
-        super();
-        this.speechSynthesis = null;
-        if ('speechSynthesis' in window) {
-            this.speechSynthesis = window.speechSynthesis;
-        }
-    }
-    async speak(options) {
-        if (!this.speechSynthesis) {
-            this.throwUnsupportedError();
-        }
-        await this.stop();
-        const speechSynthesis = this.speechSynthesis;
-        const utterance = this.createSpeechSynthesisUtterance(options);
-        return new Promise((resolve, reject) => {
-            utterance.onend = () => {
-                resolve();
-            };
-            utterance.onerror = (event) => {
-                reject(event);
-            };
-            speechSynthesis.speak(utterance);
-        });
-    }
-    async stop() {
-        if (!this.speechSynthesis) {
-            this.throwUnsupportedError();
-        }
-        this.speechSynthesis.cancel();
-    }
-    async getSupportedLanguages() {
-        const voices = this.getSpeechSynthesisVoices();
-        const languages = voices.map(voice => voice.lang);
-        const filteredLanguages = languages.filter((v, i, a) => a.indexOf(v) == i);
-        return { languages: filteredLanguages };
-    }
-    async getSupportedVoices() {
-        const voices = this.getSpeechSynthesisVoices();
-        return { voices };
-    }
-    async openInstall() {
-        this.throwUnimplementedError();
-    }
-    createSpeechSynthesisUtterance(options) {
-        const voices = this.getSpeechSynthesisVoices();
-        const utterance = new SpeechSynthesisUtterance();
-        const { text, lang, rate, pitch, volume, voice } = options;
-        if (voice) {
-            utterance.voice = voices[voice];
-        }
-        if (volume) {
-            utterance.volume = volume >= 0 && volume <= 1 ? volume : 1;
-        }
-        if (rate) {
-            utterance.rate = rate >= 0.1 && rate <= 10 ? rate : 1;
-        }
-        if (pitch) {
-            utterance.pitch = pitch >= 0 && pitch <= 2 ? pitch : 2;
-        }
-        if (lang) {
-            utterance.lang = lang;
-        }
-        utterance.text = text;
-        return utterance;
-    }
-    getSpeechSynthesisVoices() {
-        if (!this.speechSynthesis) {
-            this.throwUnsupportedError();
-        }
-        if (!this.supportedVoices || this.supportedVoices.length < 1) {
-            this.supportedVoices = this.speechSynthesis.getVoices();
-        }
-        return this.supportedVoices;
-    }
-    throwUnsupportedError() {
-        throw this.unavailable('SpeechSynthesis API not available in this browser.');
-    }
-    throwUnimplementedError() {
-        throw this.unimplemented('Not implemented on web.');
-    }
-}
+import { WebPlugin } from '@capacitor/core';
+export class TextToSpeechWeb extends WebPlugin {
+    constructor() {
+        super();
+        this.speechSynthesis = null;
+        if ('speechSynthesis' in window) {
+            this.speechSynthesis = window.speechSynthesis;
+            window.addEventListener("beforeunload", () => {
+                this.stop();
+            });
+        }
+    }
+    async speak(options) {
+        if (!this.speechSynthesis) {
+            this.throwUnsupportedError();
+        }
+        await this.stop();
+        const speechSynthesis = this.speechSynthesis;
+        const utterance = this.createSpeechSynthesisUtterance(options);
+        return new Promise((resolve, reject) => {
+            utterance.onend = () => {
+                resolve();
+            };
+            utterance.onerror = (event) => {
+                reject(event);
+            };
+            speechSynthesis.speak(utterance);
+        });
+    }
+    async stop() {
+        if (!this.speechSynthesis) {
+            this.throwUnsupportedError();
+        }
+        this.speechSynthesis.cancel();
+    }
+    async getSupportedLanguages() {
+        const voices = this.getSpeechSynthesisVoices();
+        const languages = voices.map(voice => voice.lang);
+        const filteredLanguages = languages.filter((v, i, a) => a.indexOf(v) == i);
+        return { languages: filteredLanguages };
+    }
+    async getSupportedVoices() {
+        const voices = this.getSpeechSynthesisVoices();
+        return { voices };
+    }
+    async isLanguageSupported(options) {
+        const result = await this.getSupportedLanguages();
+        const isLanguageSupported = result.languages.includes(options.lang);
+        return { supported: isLanguageSupported };
+    }
+    async openInstall() {
+        this.throwUnimplementedError();
+    }
+    createSpeechSynthesisUtterance(options) {
+        const voices = this.getSpeechSynthesisVoices();
+        const utterance = new SpeechSynthesisUtterance();
+        const { text, lang, rate, pitch, volume, voice } = options;
+        if (voice) {
+            utterance.voice = voices[voice];
+        }
+        if (volume) {
+            utterance.volume = volume >= 0 && volume <= 1 ? volume : 1;
+        }
+        if (rate) {
+            utterance.rate = rate >= 0.1 && rate <= 10 ? rate : 1;
+        }
+        if (pitch) {
+            utterance.pitch = pitch >= 0 && pitch <= 2 ? pitch : 2;
+        }
+        if (lang) {
+            utterance.lang = lang;
+        }
+        utterance.text = text;
+        return utterance;
+    }
+    getSpeechSynthesisVoices() {
+        if (!this.speechSynthesis) {
+            this.throwUnsupportedError();
+        }
+        if (!this.supportedVoices || this.supportedVoices.length < 1) {
+            this.supportedVoices = this.speechSynthesis.getVoices();
+        }
+        return this.supportedVoices;
+    }
+    throwUnsupportedError() {
+        throw this.unavailable('SpeechSynthesis API not available in this browser.');
+    }
+    throwUnimplementedError() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+}
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAI5C;QACE,KAAK,EAAE,CAAC;QAJF,oBAAe,GAA2B,IAAI,CAAC;QAKrD,IAAI,iBAAiB,IAAI,MAAM,EAAE;YAC/B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;SAC/C;IACH,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAAmB;QACpC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,SAAS,CAAC,KAAK,GAAG,GAAG,EAAE;gBACrB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YACF,SAAS,CAAC,OAAO,GAAG,CAAC,KAAU,EAAE,EAAE;gBACjC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,kBAAkB;QAG7B,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,OAAO,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,8BAA8B,CACpC,OAAmB;QAEnB,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACjD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC3D,IAAI,KAAK,EAAE;YACT,SAAS,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;SACjC;QACD,IAAI,MAAM,EAAE;YACV,SAAS,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D;QACD,IAAI,IAAI,EAAE;YACR,SAAS,CAAC,IAAI,GAAG,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACvD;QACD,IAAI,KAAK,EAAE;YACT,SAAS,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACxD;QACD,IAAI,IAAI,EAAE;YACR,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;SACvB;QACD,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,wBAAwB;QAC9B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5D,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;SACzD;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,qBAAqB;QAC3B,MAAM,IAAI,CAAC,WAAW,CACpB,oDAAoD,CACrD,CAAC;IACJ,CAAC;IAEO,uBAAuB;QAC7B,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;CACF"}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAI5C;QACE,KAAK,EAAE,CAAC;QAJF,oBAAe,GAA2B,IAAI,CAAC;QAKrD,IAAI,iBAAiB,IAAI,MAAM,EAAE;YAC/B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;YAC9C,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE;gBACzC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAAmB;QACpC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,SAAS,CAAC,KAAK,GAAG,GAAG,EAAE;gBACrB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YACF,SAAS,CAAC,OAAO,GAAG,CAAC,KAAU,EAAE,EAAE;gBACjC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,kBAAkB;QAG7B,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,OAAO,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,OAEhC;QACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAClD,MAAM,mBAAmB,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpE,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,8BAA8B,CACpC,OAAmB;QAEnB,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,IAAI,wBAAwB,EAAE,CAAC;QACjD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC3D,IAAI,KAAK,EAAE;YACT,SAAS,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;SACjC;QACD,IAAI,MAAM,EAAE;YACV,SAAS,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D;QACD,IAAI,IAAI,EAAE;YACR,SAAS,CAAC,IAAI,GAAG,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACvD;QACD,IAAI,KAAK,EAAE;YACT,SAAS,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACxD;QACD,IAAI,IAAI,EAAE;YACR,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;SACvB;QACD,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,wBAAwB;QAC9B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC9B;QACD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5D,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;SACzD;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,qBAAqB;QAC3B,MAAM,IAAI,CAAC,WAAW,CACpB,oDAAoD,CACrD,CAAC;IACJ,CAAC;IAEO,uBAAuB;QAC7B,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { TextToSpeechPlugin, TTSOptions } from './definitions';\n\nexport class TextToSpeechWeb extends WebPlugin implements TextToSpeechPlugin {\n  private speechSynthesis: SpeechSynthesis | null = null;\n  private supportedVoices: SpeechSynthesisVoice[] | undefined;\n\n  constructor() {\n    super();\n    if ('speechSynthesis' in window) {\n      this.speechSynthesis = window.speechSynthesis;\n      window.addEventListener(\"beforeunload\", () => {\n          this.stop();\n      });\n    }\n  }\n\n  public async speak(options: TTSOptions): Promise<void> {\n    if (!this.speechSynthesis) {\n      this.throwUnsupportedError();\n    }\n    await this.stop();\n    const speechSynthesis = this.speechSynthesis;\n    const utterance = this.createSpeechSynthesisUtterance(options);\n    return new Promise((resolve, reject) => {\n      utterance.onend = () => {\n        resolve();\n      };\n      utterance.onerror = (event: any) => {\n        reject(event);\n      };\n      speechSynthesis.speak(utterance);\n    });\n  }\n\n  public async stop(): Promise<void> {\n    if (!this.speechSynthesis) {\n      this.throwUnsupportedError();\n    }\n    this.speechSynthesis.cancel();\n  }\n\n  public async getSupportedLanguages(): Promise<{ languages: string[] }> {\n    const voices = this.getSpeechSynthesisVoices();\n    const languages = voices.map(voice => voice.lang);\n    const filteredLanguages = languages.filter((v, i, a) => a.indexOf(v) == i);\n    return { languages: filteredLanguages };\n  }\n\n  public async getSupportedVoices(): Promise<{\n    voices: SpeechSynthesisVoice[];\n  }> {\n    const voices = this.getSpeechSynthesisVoices();\n    return { voices };\n  }\n\n  public async isLanguageSupported(options: {\n    lang: string;\n  }): Promise<{ supported: boolean }> {\n    const result = await this.getSupportedLanguages();\n    const isLanguageSupported = result.languages.includes(options.lang);\n    return { supported: isLanguageSupported };\n  }\n\n  public async openInstall(): Promise<void> {\n    this.throwUnimplementedError();\n  }\n\n  private createSpeechSynthesisUtterance(\n    options: TTSOptions,\n  ): SpeechSynthesisUtterance {\n    const voices = this.getSpeechSynthesisVoices();\n    const utterance = new SpeechSynthesisUtterance();\n    const { text, lang, rate, pitch, volume, voice } = options;\n    if (voice) {\n      utterance.voice = voices[voice];\n    }\n    if (volume) {\n      utterance.volume = volume >= 0 && volume <= 1 ? volume : 1;\n    }\n    if (rate) {\n      utterance.rate = rate >= 0.1 && rate <= 10 ? rate : 1;\n    }\n    if (pitch) {\n      utterance.pitch = pitch >= 0 && pitch <= 2 ? pitch : 2;\n    }\n    if (lang) {\n      utterance.lang = lang;\n    }\n    utterance.text = text;\n    return utterance;\n  }\n\n  private getSpeechSynthesisVoices(): SpeechSynthesisVoice[] {\n    if (!this.speechSynthesis) {\n      this.throwUnsupportedError();\n    }\n    if (!this.supportedVoices || this.supportedVoices.length < 1) {\n      this.supportedVoices = this.speechSynthesis.getVoices();\n    }\n    return this.supportedVoices;\n  }\n\n  private throwUnsupportedError(): never {\n    throw this.unavailable(\n      'SpeechSynthesis API not available in this browser.',\n    );\n  }\n\n  private throwUnimplementedError(): never {\n    throw this.unimplemented('Not implemented on web.');\n  }\n}\n"]}