Add devices info to session manager (#551)

* feat: add devices info to session manager

* feat: add devices info to session manager

* feat: android devices wanna be

* fix: android impl

* ci: yarn format

* docs: added getDevicesInfo to docs

---------

Co-authored-by: Maciej Makowski <[email protected]>

Author: michalsek

apps/common-app/src/examples/AudioFile/AudioFile.tsx

@@ -18,6 +18,8 @@ const AudioFile: FC = () => {
       await AudioPlayer.play();
 
       AudioManager.observeAudioInterruptions(true);
+
+      AudioManager.getDevicesInfo().then(console.log);
     }
 
     setIsPlaying((prev) => !prev);

packages/audiodocs/docs/system/audio-manager.mdx

@@ -6,7 +6,7 @@ import { Optional, ReadOnly, OnlyiOS } from '@site/src/components/Badges';
 
 # AudioManager
 
-The `AudioManager` is a layer of an abstraction between user and a system. 
+The `AudioManager` is a layer of an abstraction between user and a system.
 It provides a set of system-specific functions that are invoked directly in native code, by related system.
 
 ## Example
@@ -62,6 +62,7 @@ function App() {
       }
     );
 
+    AudioManager.getDevicesInfo().then(console.log);
 
     return () => {
       remotePlaySubscription?.remove();
@@ -167,6 +168,12 @@ Allows to check if permissions were previously granted.
 
 #### Returns promise of [`PermissionStatus`](/system/audio-manager#permissionstatus) type, which is resolved after receiving answer from the system.
 
+### `getDevicesInfo`
+
+Allows to check currently used and available devices.
+
+#### Returns promise of [`AudioDevicesInfo`](/system/audio-manager#audiodevicesinfo) type, which is resolved after receiving answer from the system.
+
 ## Remarks
 
 ### `LockScreenInfo`
@@ -195,7 +202,7 @@ interface LockScreenInfo extends BaseLockScreenInfo {
 ```
 </details>
 
-### `SessionOptions` 
+### `SessionOptions`
 
 <details>
 <summary>Type definitions</summary>
@@ -337,3 +344,24 @@ class AudioEventSubscription {
 type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
 ```
 </details>
+
+### `AudioDevicesInfo`
+
+<details>
+<summary>Type definitions</summary>
+```typescript
+export interface AudioDeviceInfo {
+  name: string;
+  category: string;
+}
+
+export type AudioDeviceList = AudioDeviceInfo[];
+
+export interface AudioDevicesInfo {
+  availableInputs: AudioDeviceList;
+  availableOutputs: AudioDeviceList;
+  currentInputs: AudioDeviceList; // iOS only
+  currentOutputs: AudioDeviceList; // iOS only
+}
+```
+</details>

packages/react-native-audio-api/android/src/main/java/com/swmansion/audioapi/AudioAPIModule.kt

@@ -103,4 +103,8 @@ class AudioAPIModule(
   override fun checkRecordingPermissions(promise: Promise) {
     promise.resolve(MediaSessionManager.checkRecordingPermissions())
   }
+
+  override fun getDevicesInfo(promise: Promise) {
+    promise.resolve(MediaSessionManager.getDevicesInfo())
+  }
 }

packages/react-native-audio-api/android/src/main/java/com/swmansion/audioapi/system/MediaSessionManager.kt

@@ -9,6 +9,7 @@ import android.content.Intent
 import android.content.IntentFilter
 import android.content.ServiceConnection
 import android.content.pm.PackageManager
+import android.media.AudioDeviceInfo
 import android.media.AudioManager
 import android.os.Build
 import android.os.IBinder
@@ -17,6 +18,7 @@ import android.util.Log
 import androidx.annotation.RequiresApi
 import androidx.core.app.NotificationCompat
 import androidx.core.content.ContextCompat
+import com.facebook.react.bridge.Arguments
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReadableMap
 import com.facebook.react.modules.core.PermissionAwareActivity
@@ -186,4 +188,48 @@ object MediaSessionManager {
     mChannel.lockscreenVisibility = NotificationCompat.VISIBILITY_PUBLIC
     notificationManager.createNotificationChannel(mChannel)
   }
+
+  @RequiresApi(Build.VERSION_CODES.O)
+  fun getDevicesInfo(): ReadableMap {
+    val availableInputs = Arguments.createArray()
+    val availableOutputs = Arguments.createArray()
+
+    for (inputDevice in this.audioManager.getDevices(AudioManager.GET_DEVICES_INPUTS)) {
+      val deviceInfo = Arguments.createMap()
+      deviceInfo.putString("name", inputDevice.productName.toString())
+      deviceInfo.putString("type", parseDeviceType(inputDevice))
+
+      availableInputs.pushMap(deviceInfo)
+    }
+
+    for (outputDevice in this.audioManager.getDevices(AudioManager.GET_DEVICES_OUTPUTS)) {
+      val deviceInfo = Arguments.createMap()
+      deviceInfo.putString("name", outputDevice.productName.toString())
+      deviceInfo.putString("type", parseDeviceType(outputDevice))
+
+      availableOutputs.pushMap(deviceInfo)
+    }
+
+    val devicesInfo = Arguments.createMap()
+
+    devicesInfo.putArray("currentInputs", Arguments.createArray())
+    devicesInfo.putArray("currentOutputs", Arguments.createArray())
+    devicesInfo.putArray("availableInputs", availableInputs)
+    devicesInfo.putArray("availableOutputs", availableOutputs)
+
+    return devicesInfo
+  }
+
+  @RequiresApi(Build.VERSION_CODES.O)
+  fun parseDeviceType(device: AudioDeviceInfo): String =
+    when (device.type) {
+      AudioDeviceInfo.TYPE_BUILTIN_MIC -> "Built-in Mic"
+      AudioDeviceInfo.TYPE_BUILTIN_EARPIECE -> "Built-in Earpiece"
+      AudioDeviceInfo.TYPE_BUILTIN_SPEAKER -> "Built-in Speaker"
+      AudioDeviceInfo.TYPE_WIRED_HEADSET -> "Wired Headset"
+      AudioDeviceInfo.TYPE_WIRED_HEADPHONES -> "Wired Headphones"
+      AudioDeviceInfo.TYPE_BLUETOOTH_A2DP -> "Bluetooth A2DP"
+      AudioDeviceInfo.TYPE_BLUETOOTH_SCO -> "Bluetooth SCO"
+      else -> "Other (${device.type})"
+    }
 }

packages/react-native-audio-api/android/src/oldarch/NativeAudioAPIModuleSpec.java

@@ -77,4 +77,8 @@ public NativeAudioAPIModuleSpec(ReactApplicationContext reactContext) {
    @ReactMethod
    @DoNotStrip
    public abstract void checkRecordingPermissions(Promise promise);
+
+   @ReactMethod
+   @DoNotStrip
+   public abstract void getDevicesInfo(Promise promise);
  }

packages/react-native-audio-api/ios/audioapi/ios/AudioAPIModule.mm

@@ -142,6 +142,12 @@ - (void)invalidate
   [self.audioSessionManager checkRecordingPermissions:resolve reject:reject];
 }
 
+RCT_EXPORT_METHOD(
+    getDevicesInfo : (nonnull RCTPromiseResolveBlock)resolve reject : (nonnull RCTPromiseRejectBlock)reject)
+{
+  [self.audioSessionManager getDevicesInfo:resolve reject:reject];
+}
+
 #ifdef RCT_NEW_ARCH_ENABLED
 - (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
     (const facebook::react::ObjCTurboModule::InitParams &)params

packages/react-native-audio-api/ios/audioapi/ios/system/AudioSessionManager.h

@@ -26,7 +26,11 @@
                        options:(NSArray *)options
                   allowHaptics:(BOOL)allowHaptics;
 - (bool)setActive:(bool)active;
+
 - (void)requestRecordingPermissions:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject;
 - (void)checkRecordingPermissions:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject;
 
+- (void)getDevicesInfo:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject;
+- (NSArray<NSDictionary *> *)parseDeviceList:(NSArray<AVAudioSessionPortDescription *> *)devices;
+
 @end

packages/react-native-audio-api/ios/audioapi/ios/system/AudioSessionManager.mm

@@ -292,4 +292,30 @@ - (NSString *)checkRecordingPermissions
   }
 }
 
+- (void)getDevicesInfo:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject
+{
+  NSMutableDictionary *devicesInfo = [[NSMutableDictionary alloc] init];
+
+  [devicesInfo setValue:[self parseDeviceList:[self.audioSession availableInputs]] forKey:@"availableInputs"];
+  [devicesInfo setValue:[self parseDeviceList:[[self.audioSession currentRoute] inputs]] forKey:@"currentInputs"];
+  [devicesInfo setValue:[self parseDeviceList:[[self.audioSession currentRoute] outputs]] forKey:@"availableOutputs"];
+  [devicesInfo setValue:[self parseDeviceList:[[self.audioSession currentRoute] outputs]] forKey:@"currentOutputs"];
+
+  resolve(devicesInfo);
+}
+
+- (NSArray<NSDictionary *> *)parseDeviceList:(NSArray<AVAudioSessionPortDescription *> *)devices
+{
+  NSMutableArray<NSDictionary *> *deviceList = [[NSMutableArray alloc] init];
+
+  for (AVAudioSessionPortDescription *device in devices) {
+    [deviceList addObject:@{
+      @"name" : device.portName,
+      @"category" : device.portType,
+    }];
+  }
+
+  return deviceList;
+}
+
 @end

packages/react-native-audio-api/src/specs/NativeAudioAPIModule.ts

@@ -1,7 +1,7 @@
 'use strict';
 import { TurboModuleRegistry } from 'react-native';
 import type { TurboModule } from 'react-native';
-import { PermissionStatus } from '../system/types';
+import { PermissionStatus, AudioDevicesInfo } from '../system/types';
 
 interface Spec extends TurboModule {
   install(): boolean;
@@ -30,6 +30,9 @@ interface Spec extends TurboModule {
   // Permissions
   requestRecordingPermissions(): Promise<PermissionStatus>;
   checkRecordingPermissions(): Promise<PermissionStatus>;
+
+  // Audio devices
+  getDevicesInfo(): Promise<AudioDevicesInfo>;
 }
 
 const NativeAudioAPIModule = TurboModuleRegistry.get<Spec>('AudioAPIModule');

packages/react-native-audio-api/src/system/AudioManager.ts

@@ -1,4 +1,9 @@
-import { SessionOptions, LockScreenInfo, PermissionStatus } from './types';
+import {
+  SessionOptions,
+  LockScreenInfo,
+  PermissionStatus,
+  AudioDevicesInfo,
+} from './types';
 import {
   SystemEventName,
   SystemEventCallback,
@@ -74,6 +79,10 @@ class AudioManager {
   async checkRecordingPermissions(): Promise<PermissionStatus> {
     return NativeAudioAPIModule!.checkRecordingPermissions();
   }
+
+  async getDevicesInfo(): Promise<AudioDevicesInfo> {
+    return NativeAudioAPIModule!.getDevicesInfo();
+  }
 }
 
 export default new AudioManager();