Feature/iosParams

README.md

@@ -56,6 +56,7 @@ Additionally, speak() allows to pass platform-specific options.
 Tts.speak('Hello, world!', {
   iosVoiceId: 'com.apple.ttsbundle.Moira-compact',
   rate: 0.5,
+  audioOutput: 'speaker',
 });
 // Android
 Tts.speak('Hello, world!', {
@@ -80,6 +81,8 @@ The supported options for IOS are:
 - `iosVoiceId` which voice to use, check [voices()](#list-voices) for available values
 - `rate` which speech rate this line should be spoken with. Will override [default rate](#set-default-speech-rate) if set for this utterance.
 
+- `audioOutput` you can use either `earpiece` or `speaker`. Default one is `speaker`. To enable the earpiece you need to set `Tts.setIgnoreSilentSwitch("ignore");`
+
 Stop speaking and flush the TTS queue.
 
 ```js

index.d.ts

@@ -76,11 +76,19 @@ export type AndroidOptions = {
   KEY_PARAM_PAN: number;
 };
 
+export type IosOptions = {
+  /** Parameter to specify which voice to use, check voices() for available values. */
+  iosVoiceId: string;
+  /** Parameter to specify which speech rate this line should be spoken with. Will override default rate if set for this utterance. */
+  rate: number;
+  /** Parameter key to specify the audio hardware output of the TTS. */
+  audioOutput: "speaker" | "earpiece";
+}
+
 export type Options =
   | string
   | {
-      iosVoiceId: string;
-      rate: number;
+      iosParams: IosOptions;
       androidParams: AndroidOptions;
     };
 

index.js

@@ -80,7 +80,7 @@ class Tts extends NativeEventEmitter {
     // compatibility with old-style voiceId argument passing
     if (typeof options === 'string') {
       if (Platform.OS === 'ios') {
-        return TextToSpeech.speak(utterance, { iosVoiceId: options });
+        return TextToSpeech.speak(utterance, options.iosParams || {});
       } else {
         return TextToSpeech.speak(utterance, {});
       }

ios/TextToSpeech/TextToSpeech.m

@@ -52,17 +52,19 @@ + (BOOL)requiresMainQueueSetup
         reject(@"no_text", @"No text to speak", nil);
         return;
     }
+
+    NSDictionary *iosParams = [params valueForKey:@"iosParams"];
 
     AVSpeechUtterance *utterance = [[AVSpeechUtterance alloc] initWithString:text];
 
-    NSString* voice = [params valueForKey:@"iosVoiceId"];
+    NSString* voice = [iosParams valueForKey:@"iosVoiceId"];
     if (voice) {
         utterance.voice = [AVSpeechSynthesisVoice voiceWithIdentifier:voice];
     } else if (_defaultVoice) {
         utterance.voice = _defaultVoice;
     }
 
-    float rate = [[params valueForKey:@"rate"] floatValue];
+    float rate = [[iosParams valueForKey:@"rate"] floatValue];
     if (rate) {
         if(rate > AVSpeechUtteranceMinimumSpeechRate && rate < AVSpeechUtteranceMaximumSpeechRate) {
             utterance.rate = rate;
@@ -79,10 +81,20 @@ + (BOOL)requiresMainQueueSetup
     }
 
     if([_ignoreSilentSwitch isEqualToString:@"ignore"]) {
-        [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:nil];
+        [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayAndRecord error:nil];
     } else if([_ignoreSilentSwitch isEqualToString:@"obey"]) {
         [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryAmbient error:nil];
     }
+
+    NSString *audioOutput = [iosParams valueForKey:@"audioOutput"];
+    if (audioOutput) {
+        if([audioOutput isEqualToString:@"speaker"]) {
+            [[AVAudioSession sharedInstance] overrideOutputAudioPort:(AVAudioSessionPortOverrideSpeaker) error:nil];
+        } else if([audioOutput isEqualToString:@"earpiece"]) {
+            [[AVAudioSession sharedInstance] overrideOutputAudioPort:(AVAudioSessionPortOverrideNone) error:nil];
+        }
+    }
+
 
     [self.synthesizer speakUtterance:utterance];
     resolve([NSNumber numberWithUnsignedLong:utterance.hash]);