feat: adding silentMode for ios

Author: Mhp23

example/src/views/RootView.tsx

@@ -22,6 +22,8 @@ const RootView: React.FC = () => {
   >([]);
 
   React.useEffect(() => {
+    // Speech.initialize({silentMode: 'ignore'});
+
     const onSpeechEnd = () => {
       setIsStarted(false);
       setIsPaused(false);

ios/Speech.mm

@@ -23,6 +23,7 @@ - (instancetype)init {
     defaultOptions = @{
       @"pitch": @(1.0),
       @"volume": @(1.0),
+      @"silentMode": @"obey",
       @"rate": @(AVSpeechUtteranceDefaultSpeechRate),
       @"language": [AVSpeechSynthesisVoice currentLanguageCode] ?: @"en-US"
     };
@@ -32,6 +33,20 @@ - (instancetype)init {
   return self;
 }
 
+- (void)configureAudioSessionWithOptions:(NSDictionary *)options {
+  NSError *error = nil;
+  NSString *silentMode = options[@"silentMode"] ?: @"obey";
+
+  if ([silentMode isEqualToString:@"ignore"]) {
+    [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:&error];
+  } else if ([silentMode isEqualToString:@"respect"]) {
+    [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryAmbient error:&error];
+  }
+  if (error) {
+    NSLog(@"[Speech] AVAudioSession setCategory error: %@", error.localizedDescription);
+  }
+}
+
 - (NSDictionary *)getEventData:(AVSpeechUtterance *)utterance {
   return @{
     @"id": @(utterance.hash)
@@ -56,6 +71,9 @@ - (NSDictionary *)getValidatedOptions:(VoiceOptions &)options {
   if (options.language()) {
     validatedOptions[@"language"] = options.language();
   }
+  if (options.silentMode()) {
+    validatedOptions[@"silentMode"] = options.silentMode();
+  }
   if (options.pitch()) {
     float pitch = MAX(0.5, MIN(2.0, options.pitch().value()));
     validatedOptions[@"pitch"] = @(pitch);
@@ -105,7 +123,7 @@ - (void)reset {
 
 - (void)getAvailableVoices:(NSString *)language
                   resolve:(RCTPromiseResolveBlock)resolve
-                  reject:(RCTPromiseRejectBlock)reject 
+                  reject:(RCTPromiseRejectBlock)reject
 {
   NSMutableArray *voicesArray = [NSMutableArray new];
   NSArray *speechVoices = [AVSpeechSynthesisVoice speechVoices];
@@ -170,6 +188,8 @@ - (void)speak:(NSString *)text
   AVSpeechUtterance *utterance;
 
   @try {
+    [self configureAudioSessionWithOptions:self.globalOptions];
+
     utterance = [self getDefaultUtterance:text];
     [self.synthesizer speakUtterance:utterance];
     resolve(nil);
@@ -193,17 +213,18 @@ - (void)speakWithOptions:(NSString *)text
   AVSpeechUtterance *utterance;
 
   @try {
-    utterance = [self getDefaultUtterance:text];
     NSDictionary *validatedOptions = [self getValidatedOptions:options];
+    [self configureAudioSessionWithOptions:validatedOptions];
+    
+    utterance = [self getDefaultUtterance:text];
 
     if (validatedOptions[@"voice"]) {
       AVSpeechSynthesisVoice *voice = [AVSpeechSynthesisVoice voiceWithIdentifier:validatedOptions[@"voice"]];
-      
       if (voice) {
         utterance.voice = voice;
-      } else if (validatedOptions[@"language"]) {
-        utterance.voice = [AVSpeechSynthesisVoice voiceWithLanguage:validatedOptions[@"language"]];
       }
+    } else if (validatedOptions[@"language"]) {
+      utterance.voice = [AVSpeechSynthesisVoice voiceWithLanguage:validatedOptions[@"language"]];
     }
     if (validatedOptions[@"pitch"]) {
       utterance.pitchMultiplier = [validatedOptions[@"pitch"] floatValue];
@@ -224,7 +245,7 @@ - (void)speakWithOptions:(NSString *)text
   }
 }
 
-- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer 
+- (void)speechSynthesizer:(AVSpeechSynthesizer *)synthesizer
   didStartSpeechUtterance:(AVSpeechUtterance *)utterance {
   [self emitOnStart:[self getEventData:utterance]];
 }

src/NativeSpeech.ts

@@ -30,6 +30,15 @@ export interface VoiceProps {
   identifier: string;
 }
 export interface VoiceOptions {
+  /**
+   * Determines how speech audio should behave with the iOS silent switch (ringer)
+   * @platform ios
+   *
+   * - `obey`: (Default) The library does not change the app's audio session. Speech audio will follow the app's current audio configuration or the system default
+   * - `respect`: Speech audio will be silenced by the ringer switch. This is for non-critical speech
+   * - `ignore`: Speech audio will play even if the ringer switch is on silent. Use this for critical speech like navigation
+   */
+  silentMode?: 'obey' | 'respect' | 'ignore';
   /** The language code to use (e.g., 'en', 'fr', 'en-US', 'fr-FR') */
   language?: string;
   /** Volume level from 0.0 to 1.0 */