iOS Audio Playback Category (react-native-audio-toolkit#188)

Author: lukefanning

CHANGELOG.md

@@ -4,6 +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 ability to override iOS audio session category
 - Add Player option mixWithOthers
 
 ## [2.0.2] - 2019-07-09

docs/API.md

@@ -29,6 +29,10 @@ Media methods
       // iOS will always pause in this case.
       continuesToPlayInBackground : boolean (default: False)
 
+      // (iOS only) Define the audio session category
+      // Options: Playback, Ambient and SoloAmbient
+      category : PlaybackCategory (default: PlaybackCategory.Playback)
+
       // 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

index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-import Player from './src/Player';
+import Player, { PlaybackCategories } from './src/Player';
 import Recorder from './src/Recorder';
 import MediaStates from './src/MediaStates';
 
-export { Player, Recorder, MediaStates };
+export { Player, Recorder, MediaStates, PlaybackCategories };

ios/ReactNativeAudioToolkit/ReactNativeAudioToolkit/AudioPlayer.m

@@ -123,9 +123,23 @@ - (NSURL *)findUrlForPath:(NSString *)path {
                                                object:item];
 
     // Set audio session
+    NSNumber *category = [options objectForKey:@"category"];
+    NSString *avAudioSessionCategory;
+    switch ([category intValue]) {
+        case 1:
+        default:
+            avAudioSessionCategory = AVAudioSessionCategoryPlayback;
+            break;
+        case 2:
+            avAudioSessionCategory = AVAudioSessionCategoryAmbient;
+            break;
+        case 3:
+            avAudioSessionCategory = AVAudioSessionCategorySoloAmbient;
+            break;
+    }
     NSNumber *mixWithOthers = [options objectForKey:@"mixWithOthers"];
     NSError *error = nil;
-    [[AVAudioSession sharedInstance] setCategory: AVAudioSessionCategoryPlayback withOptions: mixWithOthers ? AVAudioSessionCategoryOptionMixWithOthers : 0 error: &error];
+    [[AVAudioSession sharedInstance] setCategory: avAudioSessionCategory withOptions: mixWithOthers ? AVAudioSessionCategoryOptionMixWithOthers : 0 error: &error];
     if (error) {
         NSDictionary* dict = [Helpers errObjWithCode:@"preparefail"
                                          withMessage:@"Failed to set audio session category."];

src/Player.js

@@ -14,9 +14,16 @@ const RCTAudioPlayer = NativeModules.AudioPlayer;
 
 let playerId = 0;
 
+export const PlaybackCategories = {
+  Playback: 1,
+  Ambient: 2,
+  SoloAmbient: 3,
+}
+
 const defaultPlayerOptions = {
   autoDestroy: true,
   continuesToPlayInBackground: false,
+  category: PlaybackCategories.Playback,
   mixWithOthers: false,
 };
 
@@ -38,6 +45,8 @@ class Player extends EventEmitter {
         options.autoDestroy = defaultPlayerOptions.autoDestroy;
       if (options.continuesToPlayInBackground == null)
         options.continuesToPlayInBackground = defaultPlayerOptions.continuesToPlayInBackground;
+      if (options.category == null)
+        options.category = defaultPlayerOptions.category;
       if (options.mixWithOthers == null)
         options.mixWithOthers = defaultPlayerOptions.mixWithOthers;
 

typings/index.d.ts

@@ -14,6 +14,12 @@ declare enum MediaStates {
     PAUSED = 5
 }
 
+declare enum PlaybackCategories {
+    Playback = 1,
+    Ambient = 2,
+    SoloAmbient = 3,
+}
+
 interface BaseError<T> {
     err: "invalidpath" | "preparefail" | "startfail" | "notfound" | "stopfail" | T;
     message: string;
@@ -46,6 +52,13 @@ interface PlayerOptions {
      */
 
     continuesToPlayInBackground?: boolean;
+
+    /**
+     * (iOS only) Define the audio session category
+     * (Default: Playback)
+     */
+    category?: PlaybackCategories;
+
     /**
      * Boolean to determine whether other audio sources on the device will mix
      * with sounds being played back by this module.