react-native-audio-api 0.11.1 → 0.11.3

package/src/hooks/useAudioInput.ts

@@ -0,0 +1,93 @@
+import { useCallback, useEffect, useMemo, useState } from 'react';
+
+import { AudioManager } from '../api';
+import { OnRouteChangeEventType, RouteChangeReason } from '../events/types';
+import {
+  AudioDeviceInfo,
+  AudioDeviceList,
+  AudioDevicesInfo,
+} from '../system/types';
+
+const meaningfulReasons: RouteChangeReason[] = [
+  'NewDeviceAvailable',
+  'OldDeviceUnavailable',
+  // e.g. system picks a different device as current one is not suitable for the new configuration
+  'CategoryChange',
+  'ConfigurationChange',
+];
+
+/**
+ * A hook that provides basic information and selection capabilities for audio
+ * input devices on the system. (iOS only currently). The hook will
+ * automatically listen for configuration changes and updates its state. If you
+ * need more granular control, consider using the AudioManager API directly.
+ *
+ * @returns An object containing audio input information and selection
+ *   capabilities
+ */
+export default function useAudioInput() {
+  const [availableInputs, setAvailableInputs] = useState<AudioDeviceList>([]);
+  const [currentInput, setCurrentInput] = useState<string | null>(null);
+
+  const onSelectInput = useCallback(async (device: AudioDeviceInfo) => {
+    const success = await AudioManager.setInputDevice(device.id);
+
+    if (success) {
+      setCurrentInput(device.id);
+    }
+
+    const devicesInfo: AudioDevicesInfo = await AudioManager.getDevicesInfo();
+    setAvailableInputs(devicesInfo.availableInputs);
+  }, []);
+
+  useEffect(() => {
+    async function fetchAvailableInputs() {
+      const audioDevices = await AudioManager.getDevicesInfo();
+      const currentDeviceId = audioDevices.currentInputs.length
+        ? audioDevices.currentInputs[0].id
+        : null;
+
+      setAvailableInputs(audioDevices.availableInputs);
+      setCurrentInput(currentDeviceId);
+    }
+
+    async function handleRouteChange(event: OnRouteChangeEventType) {
+      if (!meaningfulReasons.includes(event.reason)) {
+        return;
+      }
+
+      await fetchAvailableInputs();
+    }
+
+    const sub = AudioManager.addSystemEventListener(
+      'routeChange',
+      handleRouteChange
+    );
+
+    fetchAvailableInputs();
+    return () => {
+      sub?.remove();
+    };
+  }, []);
+
+  return useMemo(
+    () => ({
+      /**
+       * The list of available audio input devices under current device
+       * configuration.
+       */
+      availableInputs,
+      /**
+       * The currently selected audio input device, or null if none is yet
+       * decided by the system.
+       */
+      currentInput: availableInputs.find((d) => d.id === currentInput) || null,
+      /**
+       * Selects the given device as the current input. Returns true if
+       * successful, throws otherwise.
+       */
+      onSelectInput,
+    }),
+    [availableInputs, currentInput, onSelectInput]
+  );
+}

package/src/hooks/useSystemVolume.ts

@@ -1,5 +1,6 @@
 import { useEffect, useState } from 'react';
-import AudioManager from '../system/AudioManager';
+
+import { AudioManager } from '../api';
 
 export default function useSystemVolume() {
   const [volume, setVolume] = useState(0);
@@ -12,9 +13,9 @@ export default function useSystemVolume() {
         setVolume(parseFloat(e.value.toFixed(2)));
       }
     );
+
     return () => {
       listener?.remove();
-
       AudioManager.observeVolumeChanges(false);
     };
   }, []);

package/src/index.ts

@@ -1 +1,6 @@
 export * from './api';
+
+// Note: hooks are (and always should!) rely only on imports from './api'
+// to be able to use them both in RN and Web environments.
+// Thus they can/have to be exported here.
+export * from './hooks';

package/src/interfaces.ts

@@ -304,7 +304,7 @@ export interface IAudioRecorderCallbackOptions
 
 export interface IAudioRecorder {
   // default recorder methods
-  start: () => Result<{ path: string }>;
+  start: (fileNameOverride?: string) => Result<{ path: string }>;
   stop: () => Result<FileInfo>;
   isRecording: () => boolean;
   isPaused: () => boolean;

package/src/specs/NativeAudioAPIModule.ts

@@ -34,6 +34,7 @@ interface Spec extends TurboModule {
 
   // Audio devices
   getDevicesInfo(): Promise<AudioDevicesInfo>;
+  setInputDevice(deviceId: string): Promise<boolean>;
 
   // Notification system
   showNotification(
@@ -45,6 +46,6 @@ interface Spec extends TurboModule {
   isNotificationActive(key: string): Promise<boolean>;
 }
 
-const NativeAudioAPIModule = TurboModuleRegistry.get<Spec>('AudioAPIModule');
+const NativeAudioAPIModule = TurboModuleRegistry.get<Spec>('AudioAPIModule')!;
 
 export { NativeAudioAPIModule };

package/src/specs/NativeAudioAPIModule.web.ts

@@ -35,6 +35,7 @@ interface Spec extends TurboModule {
 
   // Audio devices
   getDevicesInfo(): Promise<AudioDevicesInfo>;
+  setInputDevice(deviceId: string): Promise<boolean>;
 
   // New notification system
   showNotification(
@@ -74,6 +75,7 @@ const NativeAudioAPIModule: Spec = {
     currentInputs: [],
     currentOutputs: [],
   }),
+  setInputDevice: mockAsync(true),
   showNotification: mockAsync({ success: true }),
   hideNotification: mockAsync({ success: true }),
   isNotificationActive: mockAsync(false),

package/src/system/AudioManager.ts

@@ -94,6 +94,10 @@ class AudioManager implements IAudioManager {
   async getDevicesInfo(): Promise<AudioDevicesInfo> {
     return NativeAudioAPIModule.getDevicesInfo();
   }
+
+  async setInputDevice(deviceId: string): Promise<boolean> {
+    return NativeAudioAPIModule.setInputDevice(deviceId);
+  }
 }
 
 export default new AudioManager();

package/src/system/types.ts

@@ -24,8 +24,8 @@ export type IOSOption =
   | 'duckOthers'
   | 'allowAirPlay'
   | 'mixWithOthers'
-  | 'allowBluetooth'
   | 'defaultToSpeaker'
+  | 'allowBluetoothHFP'
   | 'allowBluetoothA2DP'
   | 'overrideMutedMicrophoneInterruption'
   | 'interruptSpokenAudioAndMixWithOthers';
@@ -40,6 +40,7 @@ export interface SessionOptions {
 export type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
 
 export interface AudioDeviceInfo {
+  id: string;
   name: string;
   category: string;
 }
@@ -70,4 +71,5 @@ export interface IAudioManager {
   requestNotificationPermissions(): Promise<PermissionStatus>;
   checkNotificationPermissions(): Promise<PermissionStatus>;
   getDevicesInfo(): Promise<AudioDevicesInfo>;
+  setInputDevice(deviceId: string): Promise<boolean>;
 }

package/src/types.ts

@@ -151,3 +151,7 @@ export interface IIRFilterNodeOptions {
 }
 
 export type DecodeDataInput = number | string | ArrayBuffer;
+
+export interface AudioRecorderStartOptions {
+  fileNameOverride?: string;
+}

package/src/web-system/AudioManager.ts

@@ -22,6 +22,7 @@ class AudioManager implements IAudioManager {
   checkRecordingPermissions = mockAsync('Granted' as PermissionStatus);
   requestNotificationPermissions = mockAsync('Granted' as PermissionStatus);
   checkNotificationPermissions = mockAsync('Granted' as PermissionStatus);
+  setInputDevice = mockAsync(true);
   getDevicesInfo = mockAsync({
     availableInputs: [],
     availableOutputs: [],