@capacitor-community/text-to-speech 2.1.0 → 3.0.0

package/android/build.gradle

@@ -1,8 +1,8 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
 }
 
 buildscript {
@@ -11,17 +11,18 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.2.1'
+        classpath 'com.android.tools.build:gradle:8.0.0'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    namespace "com.getcapacitor.community.tts"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -36,8 +37,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 }
 

package/android/src/main/AndroidManifest.xml

@@ -1,3 +1,2 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.getcapacitor.community.tts">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 </manifest>

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":["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"]}

package/ios/Plugin/TextToSpeech.swift

@@ -18,7 +18,7 @@ import Capacitor
         self.resolveCurrentCall()
     }
 
-    @objc public func speak(_ text: String, _ lang: String, _ rate: Float, _ pitch: Float, _ category: String, _ volume: Float, _ voice : Int, _ call: CAPPluginCall) throws {
+    @objc public func speak(_ text: String, _ lang: String, _ rate: Float, _ pitch: Float, _ category: String, _ volume: Float, _ voice: Int, _ call: CAPPluginCall) throws {
         self.synthesizer.stopSpeaking(at: .immediate)
 
         var avAudioSessionCategory = AVAudioSession.Category.ambient
@@ -37,11 +37,11 @@ import Capacitor
         utterance.pitchMultiplier = pitch
         utterance.volume = volume
 
-        //Find the voice associated with the voice parameter if a voice specified. 
-        //If the specified voice is not available we will fall back to default voice rather than raising an error. 
-        if (voice >= 0) {
+        // Find the voice associated with the voice parameter if a voice specified.
+        // If the specified voice is not available we will fall back to default voice rather than raising an error.
+        if voice >= 0 {
             let allVoices = AVSpeechSynthesisVoice.speechVoices()
-            if (voice < allVoices.count) {
+            if voice < allVoices.count {
                 utterance.voice = allVoices[voice]
             }
         }

package/ios/Plugin/TextToSpeechPlugin.swift

@@ -61,10 +61,10 @@ public class TextToSpeechPlugin: CAPPlugin {
                 "localService": true,
                 "name": voice.name,
                 "voiceURI": voice.identifier
-            ] as [String : Any]
+            ] as [String: Any]
             res.append(lang)
         }
-        
+
         call.resolve([
             "voices": res
         ])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/text-to-speech",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Capacitor plugin for synthesizing speech from text.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -26,11 +26,11 @@
   "author": "Robin Genz <mail@robingenz.dev>",
   "license": "MIT",
   "devDependencies": {
-    "@capacitor/android": "4.0.1",
-    "@capacitor/cli": "4.0.1",
-    "@capacitor/core": "4.0.1",
+    "@capacitor/android": "5.0.0",
+    "@capacitor/cli": "5.0.0",
+    "@capacitor/core": "5.0.0",
     "@capacitor/docgen": "0.2.0",
-    "@capacitor/ios": "4.0.1",
+    "@capacitor/ios": "5.0.0",
     "@ionic/eslint-config": "0.3.0",
     "@ionic/prettier-config": "1.0.1",
     "@ionic/swiftlint-config": "1.1.2",
@@ -44,7 +44,7 @@
     "typescript": "4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^4.0.0"
+    "@capacitor/core": "^5.0.0"
   },
   "files": [
     "android/src/main/",