react-native-audio-api 0.11.2 → 0.11.3

package/src/api.ts

@@ -20,6 +20,7 @@ export { default as DelayNode } from './core/DelayNode';
 export { default as GainNode } from './core/GainNode';
 export { default as OfflineAudioContext } from './core/OfflineAudioContext';
 export { default as OscillatorNode } from './core/OscillatorNode';
+export { default as PeriodicWave } from './core/PeriodicWave';
 export { default as RecorderAdapterNode } from './core/RecorderAdapterNode';
 export { default as StereoPannerNode } from './core/StereoPannerNode';
 export { default as StreamerNode } from './core/StreamerNode';
@@ -27,8 +28,6 @@ export { default as WaveShaperNode } from './core/WaveShaperNode';
 export { default as WorkletNode } from './core/WorkletNode';
 export { default as WorkletProcessingNode } from './core/WorkletProcessingNode';
 export { default as WorkletSourceNode } from './core/WorkletSourceNode';
-
-export { default as useSystemVolume } from './hooks/useSystemVolume';
 export { default as AudioManager } from './system';
 
 export * from './errors';
@@ -37,8 +36,10 @@ export * from './types';
 export { default as FilePreset } from './utils/filePresets';
 
 // Notification System
-export { PlaybackNotificationManager } from './system/notification';
-export { RecordingNotificationManager } from './system/notification';
+export {
+  PlaybackNotificationManager,
+  RecordingNotificationManager,
+} from './system/notification';
 
 export {
   NotificationManager,

package/src/core/AudioDecoder.ts

@@ -1,5 +1,6 @@
 import { Image } from 'react-native';
 
+import { AudioApiError } from '../errors';
 import { IAudioDecoder } from '../interfaces';
 import { DecodeDataInput } from '../types';
 import {
@@ -8,7 +9,6 @@ import {
   isRemoteSource,
 } from '../utils/paths';
 import AudioBuffer from './AudioBuffer';
-import { AudioApiError } from '../errors';
 
 class AudioDecoder {
   private static instance: AudioDecoder | null = null;
@@ -62,7 +62,7 @@ class AudioDecoder {
       return new AudioBuffer(buffer);
     }
 
-    if (!(typeof input === 'string')) {
+    if (!(typeof stringSource === 'string')) {
       throw new TypeError('Input must be a module, uri or ArrayBuffer');
     }
 

package/src/core/AudioRecorder.ts

@@ -26,7 +26,7 @@ function withDefaultOptions(
   return {
     directory: FileDirectory.Cache,
     subDirectory: 'AudioAPI',
-    fileNamePrefix: 'recording_',
+    fileNamePrefix: 'recording',
     channelCount: 2,
     format: FileFormat.M4A,
     batchDurationSeconds: 0,

package/src/events/types.ts

@@ -7,21 +7,25 @@ export interface EventTypeWithValue {
   value: number;
 }
 
-interface OnInterruptionEventType {
-  type: 'ended' | 'began';
+export type InterruptionType = 'began' | 'ended';
+
+export interface OnInterruptionEventType {
+  type: InterruptionType;
   shouldResume: boolean;
 }
 
-interface OnRouteChangeEventType {
-  reason:
-    | 'Unknown'
-    | 'Override'
-    | 'CategoryChange'
-    | 'WakeFromSleep'
-    | 'NewDeviceAvailable'
-    | 'OldDeviceUnavailable'
-    | 'ConfigurationChange'
-    | 'NoSuitableRouteForCategory';
+export type RouteChangeReason =
+  | 'Unknown'
+  | 'Override'
+  | 'CategoryChange'
+  | 'WakeFromSleep'
+  | 'NewDeviceAvailable'
+  | 'OldDeviceUnavailable'
+  | 'ConfigurationChange'
+  | 'NoSuitableRouteForCategory';
+
+export interface OnRouteChangeEventType {
+  reason: RouteChangeReason;
 }
 
 export interface OnRecorderErrorEventType {

package/src/hooks/index.ts

@@ -0,0 +1,2 @@
+export { default as useAudioInput } from './useAudioInput';
+export { default as useSystemVolume } from './useSystemVolume';

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/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/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: [],