@capacitor-community/text-to-speech 0.2.3 → 1.1.2

package/CapacitorCommunityTextToSpeech.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
-  s.ios.deployment_target  = '11.0'
+  s.ios.deployment_target  = '12.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) COPYRIGHT_YEAR COPYRIGHT_HOLDER
+Copyright (c) 2021 Robin Genz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,7 +6,7 @@
 </p>
 
 <p align="center">
-  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
+  <img src="https://img.shields.io/maintenance/yes/2022?style=flat-square" />
   <a href="https://github.com/capacitor-community/text-to-speech/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/text-to-speech/CI/master?style=flat-square" /></a>
   <a href="https://www.npmjs.com/package/@capacitor-community/text-to-speech"><img src="https://img.shields.io/npm/l/@capacitor-community/text-to-speech?style=flat-square" /></a>
 <br>
@@ -30,134 +30,190 @@ npm install @capacitor-community/text-to-speech
 npx cap sync
 ```
 
-On **iOS**, no further steps are needed.
+### Android
 
-On **Android**, register the plugin in your main activity:
+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:
 
-```java
-import com.getcapacitor.community.tts.TextToSpeech;
+```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.
 
-public class MainActivity extends BridgeActivity {
+## Configuration
+
+No configuration required for this plugin.
 
-  @Override
-  public void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
+## Demo
 
-    // Initializes the Bridge
-    this.init(
-        savedInstanceState,
-        new ArrayList<Class<? extends Plugin>>() {
+A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)
 
-          {
-            // Additional plugins you've installed go here
-            // Ex: add(TotallyAwesomePlugin.class);
-            add(TextToSpeech.class);
-          }
-        }
-      );
-  }
-}
+## Usage
+
+```typescript
+import { TextToSpeech } from '@capacitor-community/text-to-speech';
+
+const speak = async () => {
+  await TextToSpeech.speak({
+    text: 'This is a sample text.',
+    lang: 'en_US',
+    rate: 1.0,
+    pitch: 1.0,
+    volume: 1.0,
+    category: 'ambient',
+  });
+};
+
+const stop = async () => {
+  await TextToSpeech.stop();
+};
+
+const getSupportedLanguages = async () => {
+  const languages = await TextToSpeech.getSupportedLanguages();
+};
+
+const getSupportedVoices = async () => {
+  const voices = await TextToSpeech.getSupportedVoices();
+};
+
+const isLanguageSupported = async (lang: string) => {
+  const isSupported = await TextToSpeech.isLanguageSupported({ lang });
+};
 ```
 
-## Configuration
+## API
 
-No configuration required for this plugin.
+<docgen-index>
 
-## Supported methods
+* [`speak(...)`](#speak)
+* [`stop()`](#stop)
+* [`getSupportedLanguages()`](#getsupportedlanguages)
+* [`getSupportedVoices()`](#getsupportedvoices)
+* [`isLanguageSupported(...)`](#islanguagesupported)
+* [`openInstall()`](#openinstall)
+* [Interfaces](#interfaces)
 
-| Name                  | Android | iOS | Web |
-| :-------------------- | :------ | :-- | :-- |
-| speak                 | ✅      | ✅  | ✅  |
-| stop                  | ✅      | ✅  | ✅  |
-| getSupportedLanguages | ✅      | ✅  | ✅  |
-| openInstall           | ✅      | ✅  | ❌  |
-| setPitchRate          | ✅      | ✅  | ❌  |
-| setSpeechRate         | ✅      | ✅  | ❌  |
+</docgen-index>
 
-## Usage
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### speak(...)
 
 ```typescript
-// Must import the package once to make sure the web support initializes
-import '@capacitor-community/text-to-speech';
-
-import { Plugins } from '@capacitor/core';
-
-const { TextToSpeech } = Plugins;
-
-/**
- * Platform: Android/iOS/Web
- * This method will trigger text to speech engine and play desired text.
- * @param text - desired text to play in speech
- *        locale - supported locale (can be obtained by calling getSupportedLanguages())
- *        speechRate - speech rate (1.0 is the normal speech rate, lower values slow down the speech, greater values accelerate it)
- *        pitchRate - pitch rate (1.0 is the normal pitch rate, smaller value lowers the tone and greater value increases it)
- *        volume - volume of the synthesis (0 - 1)
- *        voice - index of the voice (can be obtained by calling getSupportedVoices()) (Android/Web Only)
- * @returns void
- */
-TextToSpeech.speak({
-  text: 'This is a sample text.',
-  locale: 'en_US',
-  speechRate: 1.0,
-  pitchRate: 1,
-  volume: 1.0,
-  voice: 10,
-  category: 'ambient',
-});
-
-/**
- * Platform: Android/iOS/Web
- * This method will stop the engine if it's in the middle of playback.
- * @param none
- * @returns void
- */
-TextToSpeech.stop();
-
-/**
- * Platform: Android/iOS/Web
- * This method will return list of supported languages.
- * @param none
- * @returns languages - list of available languages
- */
-TextToSpeech.getSupportedLanguages();
-
-/**
- * Platform: Android/iOS/Web
- * This method will return list of supported voices.
- * @param none
- * @returns voices - list of available voices
- */
-TextToSpeech.getSupportedVoices();
-
-/**
- * Platform: Android/iOS
- * This method will trigger the platform TextToSpeech engine to start the activity that installs the resource files on the device that are required for TTS to be operational.
- * @param none
- * @returns void
- */
-TextToSpeech.openInstall();
-
-/**
- * * Platform: Android/iOS
- * This method will change the pitch rate while the text is being played.
- * @param pitchRate - rate of the pitch (1.0 is the normal pitch, lower values lower the tone of the synthesized voice, greater values increase it)
- * @returns void
- */
-TextToSpeech.setPitchRate({
-  pitchRate: 1.5,
-});
-
-/**
- * * Platform: Android/iOS
- * This method will change the speech rate while the text is being played.
- * @param speechRate - speech rate (1.0 is the normal speech rate, lower values slow down the speech, greater values accelerate it)
- * @returns void
- */
-TextToSpeech.setSpeechRate({
-  speechRate: 0.5,
-});
+speak(options: TTSOptions) => Promise<void>
 ```
 
+Starts the TTS engine and plays the desired text.
+
+| Param         | Type                                              |
+| ------------- | ------------------------------------------------- |
+| **`options`** | <code><a href="#ttsoptions">TTSOptions</a></code> |
+
+--------------------
+
+
+### stop()
+
+```typescript
+stop() => Promise<void>
+```
+
+Stops the TTS engine.
+
+--------------------
+
+
+### getSupportedLanguages()
+
+```typescript
+getSupportedLanguages() => Promise<{ languages: string[]; }>
+```
+
+Returns a list of supported BCP 47 language tags.
+
+**Returns:** <code>Promise&lt;{ languages: string[]; }&gt;</code>
+
+--------------------
+
+
+### getSupportedVoices()
+
+```typescript
+getSupportedVoices() => Promise<{ voices: SpeechSynthesisVoice[]; }>
+```
+
+Returns a list of supported voices.
+
+**Returns:** <code>Promise&lt;{ voices: SpeechSynthesisVoice[]; }&gt;</code>
+
+--------------------
+
+
+### isLanguageSupported(...)
+
+```typescript
+isLanguageSupported(options: { lang: string; }) => Promise<{ supported: boolean; }>
+```
+
+Checks if a specific BCP 47 language tag is supported.
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ lang: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ supported: boolean; }&gt;</code>
+
+--------------------
+
+
+### openInstall()
+
+```typescript
+openInstall() => Promise<void>
+```
+
+Verifies proper installation and availability of resource files on the system.
+
+Only available for Android.
+
+--------------------
+
+
+### Interfaces
+
+
+#### TTSOptions
+
+| Prop           | Type                | Description                                                                                                                                                                                        |
+| -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`text`**     | <code>string</code> | The text that will be synthesised when the utterance is spoken.                                                                                                                                    |
+| **`lang`**     | <code>string</code> | The language of the utterance. Possible languages can be queried using `getSupportedLanguages`. Default: `en-US`.                                                                                  |
+| **`rate`**     | <code>number</code> | The speed at which the utterance will be spoken at. Default: `1.0`.                                                                                                                                |
+| **`pitch`**    | <code>number</code> | The pitch at which the utterance will be spoken at. Default: `1.0`.                                                                                                                                |
+| **`volume`**   | <code>number</code> | The volume that the utterance will be spoken at. Default: `1.0`.                                                                                                                                   |
+| **`voice`**    | <code>number</code> | 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.                                       |
+| **`category`** | <code>string</code> | 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`. |
+
+
+#### SpeechSynthesisVoice
+
+The <a href="#speechsynthesisvoice">SpeechSynthesisVoice</a> interface represents a voice that the system supports.
+
+| Prop               | Type                 | Description                                                                                                                                                  |
+| ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`default`**      | <code>boolean</code> | Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).                                                              |
+| **`lang`**         | <code>string</code>  | BCP 47 language tag indicating the language of the voice. Example: `en-US`.                                                                                  |
+| **`localService`** | <code>boolean</code> | Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.                                                  |
+| **`name`**         | <code>string</code>  | Human-readable name that represents the voice. Example: `Microsoft Zira Desktop - English (United States)`.                                                  |
+| **`voiceURI`**     | <code>string</code>  | 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`. |
+
+</docgen-api>
+
 ## Changelog
 
 See [CHANGELOG.md](https://github.com/capacitor-community/text-to-speech/blob/master/CHANGELOG.md).

package/android/build.gradle

@@ -1,26 +1,27 @@
 ext {
-    junitVersion =  project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.12'
-    androidxJunitVersion =  project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.1'
-    androidxEspressoCoreVersion =  project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.2.0'
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.2.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.2'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.3.0'
 }
 
 buildscript {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.6.1'
+        classpath 'com.android.tools.build:gradle:4.2.1'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 29
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 29
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -34,18 +35,23 @@ android {
     lintOptions {
         abortOnError false
     }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
 }
 
 repositories {
     google()
-    jcenter()
     mavenCentral()
+    jcenter()
 }
 
 
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

package/android/src/main/AndroidManifest.xml

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

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

@@ -0,0 +1,6 @@
+package com.getcapacitor.community.tts;
+
+public interface SpeakResultCallback {
+    void onDone();
+    void onError();
+}