Mix with others (react-native-audio-toolkit#187)

Author: lukefanning

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
-
+- Add Player option mixWithOthers
 
 ## [2.0.2] - 2019-07-09
 ### Added

android/src/main/java/com/reactnativecommunity/rctaudiotoolkit/AudioPlayerModule.java

@@ -46,6 +46,7 @@ public class AudioPlayerModule extends ReactContextBaseJavaModule implements Med
     private ReactApplicationContext context;
     private AudioManager mAudioManager;
     private Integer lastPlayerId;
+    boolean mixWithOthers = false;
 
     public AudioPlayerModule(ReactApplicationContext reactContext) {
         super(reactContext);
@@ -301,6 +302,13 @@ public void onPrepared(MediaPlayer player) {
             continueInBackground = options.getBoolean("continuesToPlayInBackground");
         }
 
+        // Don't mix audio with others by default
+        this.mixWithOthers = false;
+
+        if (options.hasKey("mixWithOthers")) {
+            this.mixWithOthers = options.getBoolean("mixWithOthers");
+        }
+
         this.playerAutoDestroy.put(playerId, autoDestroy);
         this.playerContinueInBackground.put(playerId, continueInBackground);
 
@@ -382,7 +390,9 @@ public void play(Integer playerId, Callback callback) {
         }
 
         try {
-            this.mAudioManager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
+            if (!this.mixWithOthers) {
+                this.mAudioManager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
+            }
             player.start();
 
             callback.invoke(null, getInfo(player));

docs/API.md

@@ -28,6 +28,11 @@ Media methods
       // (Android only) Should playback continue if app is sent to background?
       // iOS will always pause in this case.
       continuesToPlayInBackground : boolean (default: False)
+
+      // Boolean to determine whether other audio sources on the device will mix
+      // with sounds being played back by this module. If this is not set, playback
+      // of audio will stop other sources
+      mixWithOthers : boolean (default: False)
     }
     ```
 

ios/ReactNativeAudioToolkit/ReactNativeAudioToolkit/AudioPlayer.m

@@ -123,8 +123,9 @@ - (NSURL *)findUrlForPath:(NSString *)path {
                                                object:item];
 
     // Set audio session
+    NSNumber *mixWithOthers = [options objectForKey:@"mixWithOthers"];
     NSError *error = nil;
-    [[AVAudioSession sharedInstance] setCategory: AVAudioSessionCategoryPlayback error: &error];
+    [[AVAudioSession sharedInstance] setCategory: AVAudioSessionCategoryPlayback withOptions: mixWithOthers ? AVAudioSessionCategoryOptionMixWithOthers : 0 error: &error];
     if (error) {
         NSDictionary* dict = [Helpers errObjWithCode:@"preparefail"
                                          withMessage:@"Failed to set audio session category."];

src/Player.js

@@ -17,6 +17,7 @@ let playerId = 0;
 const defaultPlayerOptions = {
   autoDestroy: true,
   continuesToPlayInBackground: false,
+  mixWithOthers: false,
 };
 
 /**
@@ -37,6 +38,8 @@ class Player extends EventEmitter {
         options.autoDestroy = defaultPlayerOptions.autoDestroy;
       if (options.continuesToPlayInBackground == null)
         options.continuesToPlayInBackground = defaultPlayerOptions.continuesToPlayInBackground;
+      if (options.mixWithOthers == null)
+        options.mixWithOthers = defaultPlayerOptions.mixWithOthers;
 
       this._options = options;
     }

typings/index.d.ts

@@ -44,7 +44,14 @@ interface PlayerOptions {
      * iOS will always pause in this case.
      * (Default: false)
      */
+
     continuesToPlayInBackground?: boolean;
+    /**
+     * Boolean to determine whether other audio sources on the device will mix
+     * with sounds being played back by this module.
+     * (Default: false)
+     */
+    mixWithOthers?: boolean;
 }
 
 /**