feat(android): adding getEngines and setEngine methods

Author: Mhp23

android/src/main/java/com/speech/SpeechModule.kt

@@ -38,11 +38,18 @@ class SpeechModule(reactContext: ReactApplicationContext) :
   private val queueLock = Any()
 
   private val isSupportedPausing = Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
+
   private lateinit var synthesizer: TextToSpeech
+
+  private var selectedEngine: String? = null
+  private var cachedEngines: List<TextToSpeech.EngineInfo>? = null
+
   private var isInitialized = false
   private var isInitializing = false
   private val pendingOperations = mutableListOf<Pair<() -> Unit, Promise>>()
+
   private var globalOptions: MutableMap<String, Any> = defaultOptions.toMutableMap()
+
   private var isPaused = false
   private var isResuming = false
   private var currentQueueIndex = -1
@@ -112,11 +119,12 @@ class SpeechModule(reactContext: ReactApplicationContext) :
     if (isInitializing) return
     isInitializing = true
 
-    synthesizer = TextToSpeech(reactApplicationContext) { status ->
+    synthesizer = TextToSpeech(reactApplicationContext, { status ->
       isInitialized = status == TextToSpeech.SUCCESS
       isInitializing = false
 
       if (isInitialized) {
+        cachedEngines = synthesizer.engines
         synthesizer.setOnUtteranceProgressListener(object : UtteranceProgressListener() {
           override fun onStart(utteranceId: String) {
             synchronized(queueLock) {
@@ -187,7 +195,7 @@ class SpeechModule(reactContext: ReactApplicationContext) :
       } else {
         rejectPendingOperations()
       }
-    }
+    }, selectedEngine)
   }
 
   private fun ensureInitialized(promise: Promise, operation: () -> Unit) {
@@ -223,7 +231,7 @@ class SpeechModule(reactContext: ReactApplicationContext) :
     globalOptions["voice"]?.let { voiceId ->
       synthesizer.voices?.forEach { voice ->
         if (voice.name == voiceId) {
-          synthesizer.setVoice(voice)
+          synthesizer.voice = voice
           return@forEach
         }
       }
@@ -247,7 +255,7 @@ class SpeechModule(reactContext: ReactApplicationContext) :
     tempOptions["voice"]?.let { voiceId ->
       synthesizer.voices?.forEach { voice ->
         if (voice.name == voiceId) {
-          synthesizer.setVoice(voice)
+          synthesizer.voice = voice
           return@forEach
         }
       }
@@ -443,12 +451,49 @@ class SpeechModule(reactContext: ReactApplicationContext) :
     }
   }
 
+  override fun getEngines(promise: Promise) {
+    ensureInitialized(promise) {
+      val enginesArray = Arguments.createArray()
+      cachedEngines?.forEach { engine ->
+        enginesArray.pushMap(
+          Arguments.createMap().apply {
+            putString("name", engine.name)
+            putString("label", engine.label)
+            putBoolean("isDefault", engine.name == synthesizer.defaultEngine)
+          }
+        )
+      }
+      promise.resolve(enginesArray)
+    }
+  }
+
+  override fun setEngine(engineName: String, promise: Promise) {
+    if (cachedEngines?.any { it.name == engineName } == false) {
+      promise.reject("engine_error", "Engine '$engineName' is not available")
+      return
+    }
+    if (isInitialized) {
+      val activeEngine = selectedEngine ?: synthesizer.defaultEngine
+      if (activeEngine == engineName) {
+        promise.resolve(null)
+        return
+      }
+    }
+    selectedEngine = engineName
+
+    invalidate()
+
+    pendingOperations.add(Pair({ promise.resolve(null) }, promise))
+    initializeTTS()
+  }
+
   override fun invalidate() {
     super.invalidate()
     if (::synthesizer.isInitialized) {
       synthesizer.stop()
       synthesizer.shutdown()
       resetQueueState()
     }
+    isInitialized = false
   }
 }

example/src/views/RootView.tsx

@@ -69,6 +69,13 @@ const RootView: React.FC = () => {
     //   });
     // })();
 
+    // (async () => {
+    //   const engines = await Speech.getEngines();
+    //   if (engines?.[0]) {
+    //     await Speech.setEngine(engines[0].name);
+    //   }
+    // })();
+
     return () => {
       startSubscription.remove();
       finishSubscription.remove();

ios/Speech.mm

@@ -146,6 +146,16 @@ - (void)getAvailableVoices:(NSString *)language
   resolve(voicesArray);
 }
 
+- (void)getEngines:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+  resolve(@[]);
+}
+
+- (void)setEngine:(NSString *)engineName
+          resolve:(RCTPromiseResolveBlock)resolve
+          reject:(RCTPromiseRejectBlock)reject {
+  resolve(nil);
+}
+
 - (void)isSpeaking:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
   BOOL speaking = self.synthesizer.isSpeaking;
   resolve(@(speaking));

jest/index.js

@@ -20,6 +20,8 @@ class Speech {
   static isSpeaking = mockPromiseBool;
   static speakWithOptions = mockPromise;
   static getAvailableVoices = mockPromiseArr;
+  static getEngines = mockPromiseArr;
+  static setEngine = mockPromise;
   static onError = eventMock;
   static onStart = eventMock;
   static onFinish = eventMock;

src/NativeSpeech.ts

@@ -58,15 +58,31 @@ export interface VoiceOptions {
    */
   rate?: number;
 }
-
+export interface EngineProps {
+  /**
+   * The unique system identifier for the engine.
+   * This is typically the package name (e.g., "com.google.android.tts")
+   */
+  name: string;
+  /**
+   * The human-readable display name for the engine (e.g., "Google Text-to-Speech Engine").
+   */
+  label: string;
+  /**
+   * A boolean flag indicating if this is the default engine
+   */
+  isDefault: boolean;
+}
 export interface Spec extends TurboModule {
   reset: () => void;
   stop: () => Promise<void>;
   pause: () => Promise<boolean>;
   resume: () => Promise<boolean>;
   isSpeaking: () => Promise<boolean>;
   speak: (text: string) => Promise<void>;
+  getEngines: () => Promise<EngineProps[]>;
   initialize: (options: VoiceOptions) => void;
+  setEngine: (engineName: string) => Promise<void>;
   getAvailableVoices: (language: string) => Promise<VoiceProps[]>;
   speakWithOptions: (text: string, options: VoiceOptions) => Promise<void>;
 

src/Speech.ts

@@ -1,5 +1,5 @@
 import TurboSpeech from './NativeSpeech';
-import type {VoiceProps, VoiceOptions} from './NativeSpeech';
+import type {VoiceProps, VoiceOptions, EngineProps} from './NativeSpeech';
 
 export default class Speech {
   /**
@@ -18,6 +18,38 @@ export default class Speech {
   public static getAvailableVoices(language?: string): Promise<VoiceProps[]> {
     return TurboSpeech.getAvailableVoices(language ?? '');
   }
+  /**
+   * Gets a list of all available text-to-speech engines on the device
+   * @returns Promise<EngineProps[]> Array of engine properties including name, label, and isDefault flag
+   * @platform android
+   * @example
+   * const engines = await Speech.getEngines();
+   * engines.forEach(engine => {
+   *   console.log(`Engine: ${engine.label} (${engine.name})`);
+   *   if (engine.isDefault) {
+   *     console.log('This is the default engine');
+   *   }
+   * });
+   */
+  public static getEngines(): Promise<EngineProps[]> {
+    return TurboSpeech.getEngines();
+  }
+  /**
+   * Sets the text-to-speech engine to use for speech synthesis
+   * @param engineName - The name of the engine to use (obtained from getEngines())
+   * @returns Promise<void> Resolves when engine is set
+   * @platform android
+   * @example
+   * // First, get available engines
+   * const engines = await Speech.getEngines();
+   * // Then set a specific engine
+   * await Speech.setEngine(engines[0].name);
+   * // Or set by known engine name
+   * await Speech.setEngine('com.google.android.tts');
+   */
+  public static setEngine(engineName: string): Promise<void> {
+    return TurboSpeech.setEngine(engineName);
+  }
   /**
    * Sets the global options for all subsequent speak() calls
    * @param options - Voice configuration options