react-native-audio-api 0.6.1-rc.1 → 0.6.1-rc.10

package/src/core/AudioContext.ts

@@ -6,7 +6,11 @@ import { NotSupportedError } from '../errors';
 
 export default class AudioContext extends BaseAudioContext {
   constructor(options?: AudioContextOptions) {
-    if (options && (options.sampleRate < 8000 || options.sampleRate > 96000)) {
+    if (
+      options &&
+      options.sampleRate &&
+      (options.sampleRate < 8000 || options.sampleRate > 96000)
+    ) {
       throw new NotSupportedError(
         `The provided sampleRate is not supported: ${options.sampleRate}`
       );
@@ -14,7 +18,8 @@ export default class AudioContext extends BaseAudioContext {
 
     super(
       global.createAudioContext(
-        options?.sampleRate || AudioManager.getDevicePreferredSampleRate()
+        options?.sampleRate || AudioManager.getDevicePreferredSampleRate(),
+        options?.initSuspended || false
       )
     );
   }

package/src/core/AudioNode.ts

@@ -39,7 +39,11 @@ export default class AudioNode {
     return destination;
   }
 
-  public disconnect(destination?: AudioNode): void {
-    this.node.disconnect(destination?.node);
+  public disconnect(destination?: AudioNode | AudioParam): void {
+    if (destination instanceof AudioParam) {
+      this.node.disconnect(destination.audioParam);
+    } else {
+      this.node.disconnect(destination?.node);
+    }
   }
 }

package/src/core/AudioScheduledSourceNode.ts

@@ -1,12 +1,12 @@
 import { IAudioScheduledSourceNode } from '../interfaces';
 import AudioNode from './AudioNode';
 import { InvalidStateError, RangeError } from '../errors';
-import { EventTypeWithValueAndState } from '../events/types';
+import { OnEndedEventType } from '../events/types';
 import { AudioEventEmitter } from '../events';
 
 export default class AudioScheduledSourceNode extends AudioNode {
   protected hasBeenStarted: boolean = false;
-  private readonly audioEventEmitter = new AudioEventEmitter(
+  protected readonly audioEventEmitter = new AudioEventEmitter(
     global.AudioEventEmitter
   );
 
@@ -42,7 +42,7 @@ export default class AudioScheduledSourceNode extends AudioNode {
   }
 
   // eslint-disable-next-line accessor-pairs
-  public set onended(callback: (event: EventTypeWithValueAndState) => void) {
+  public set onended(callback: (event: OnEndedEventType) => void) {
     const subscription = this.audioEventEmitter.addAudioEventListener(
       'ended',
       callback

package/src/core/BaseAudioContext.ts

@@ -13,6 +13,7 @@ import AudioBufferSourceNode from './AudioBufferSourceNode';
 import AudioBuffer from './AudioBuffer';
 import PeriodicWave from './PeriodicWave';
 import AnalyserNode from './AnalyserNode';
+import AudioBufferQueueSourceNode from './AudioBufferQueueSourceNode';
 import { InvalidAccessError, NotSupportedError } from '../errors';
 
 export default class BaseAudioContext {
@@ -61,6 +62,13 @@ export default class BaseAudioContext {
     );
   }
 
+  createBufferQueueSource(): AudioBufferQueueSourceNode {
+    return new AudioBufferQueueSourceNode(
+      this,
+      this.context.createBufferQueueSource()
+    );
+  }
+
   createBuffer(
     numOfChannels: number,
     length: number,

package/src/events/types.ts

@@ -6,9 +6,15 @@ export interface EventTypeWithValue {
   value: number;
 }
 
-export interface EventTypeWithValueAndState {
+export interface OnEndedEventType {
   value: number;
   state: 'stopped' | 'ended';
+  bufferId: number | undefined;
+}
+
+export interface OnPositionChangedEventType {
+  value: number;
+  bufferId: number;
 }
 
 interface OnInterruptionEventType {
@@ -17,10 +23,18 @@ interface OnInterruptionEventType {
 }
 
 interface OnRouteChangeEventType {
-  reason: string;
+  reason:
+    | 'Unknown'
+    | 'Override'
+    | 'CategoryChange'
+    | 'WakeFromSleep'
+    | 'NewDeviceAvailable'
+    | 'OldDeviceUnavailable'
+    | 'ConfigurationChange'
+    | 'NoSuitableRouteForCategory';
 }
 
-interface SystemEvents {
+interface RemoteCommandEvents {
   remotePlay: EventEmptyType;
   remotePause: EventEmptyType;
   remoteStop: EventEmptyType;
@@ -28,15 +42,18 @@ interface SystemEvents {
   remoteChangePlaybackRate: EventTypeWithValue;
   remoteNextTrack: EventEmptyType;
   remotePreviousTrack: EventEmptyType;
-  remoteSkipForward: EventEmptyType;
-  remoteSkipBackward: EventEmptyType;
-  remoteSeekForward: EventTypeWithValue;
-  remoteSeekBackward: EventTypeWithValue;
+  remoteSkipForward: EventTypeWithValue;
+  remoteSkipBackward: EventTypeWithValue;
+  remoteSeekForward: EventEmptyType;
+  remoteSeekBackward: EventEmptyType;
   remoteChangePlaybackPosition: EventTypeWithValue;
+}
+
+type SystemEvents = RemoteCommandEvents & {
   volumeChange: EventTypeWithValue;
   interruption: OnInterruptionEventType;
   routeChange: OnRouteChangeEventType;
-}
+};
 
 export interface OnAudioReadyEventType {
   buffer: AudioBuffer;
@@ -45,14 +62,17 @@ export interface OnAudioReadyEventType {
 }
 
 interface AudioAPIEvents {
-  ended: EventTypeWithValueAndState;
+  ended: OnEndedEventType;
   audioReady: OnAudioReadyEventType;
+  positionChanged: OnPositionChangedEventType;
   audioError: EventEmptyType; // to change
   systemStateChanged: EventEmptyType; // to change
 }
 
 type AudioEvents = SystemEvents & AudioAPIEvents;
 
+export type RemoteCommandEventName = keyof RemoteCommandEvents;
+
 export type SystemEventName = keyof SystemEvents;
 export type SystemEventCallback<Name extends SystemEventName> = (
   event: SystemEvents[Name]

package/src/hooks/useSytemVolume.ts

@@ -6,9 +6,12 @@ export default function useSystemVolume() {
 
   useEffect(() => {
     AudioManager.observeVolumeChanges(true);
-    const listener = AudioManager.enableSystemEvent('volumeChange', (e) => {
-      setVolume(parseFloat(e.value.toFixed(2)));
-    });
+    const listener = AudioManager.addSystemEventListener(
+      'volumeChange',
+      (e) => {
+        setVolume(parseFloat(e.value.toFixed(2)));
+      }
+    );
     return () => {
       listener?.remove();
 

package/src/interfaces.ts

@@ -19,6 +19,7 @@ export interface IBaseAudioContext {
   createStereoPanner(): IStereoPannerNode;
   createBiquadFilter: () => IBiquadFilterNode;
   createBufferSource: (pitchCorrection: boolean) => IAudioBufferSourceNode;
+  createBufferQueueSource: () => IAudioBufferQueueSourceNode;
   createBuffer: (
     channels: number,
     length: number,
@@ -109,6 +110,23 @@ export interface IAudioBufferSourceNode extends IAudioScheduledSourceNode {
   start: (when?: number, offset?: number, duration?: number) => void;
 }
 
+export interface IAudioBufferQueueSourceNode extends IAudioScheduledSourceNode {
+  detune: IAudioParam;
+  playbackRate: IAudioParam;
+
+  enqueueBuffer: (
+    audioBuffer: IAudioBuffer,
+    bufferId: number,
+    isLastBuffer: boolean
+  ) => void;
+  start: (when?: number, offset?: number) => void;
+
+  // passing subscriptionId(uint_64 in cpp, string in js) to the cpp
+  onPositionChanged: string;
+  // set how often the onPositionChanged event is called
+  onPositionChangedInterval: number;
+}
+
 export interface IAudioBuffer {
   readonly length: number;
   readonly duration: number;

package/src/plugin/withAudioAPI.ts

@@ -5,9 +5,28 @@ import {
   withInfoPlist,
   withAndroidManifest,
 } from '@expo/config-plugins';
-
 const pkg = require('react-native-audio-api/package.json');
 
+interface Options {
+  iosBackgroundMode: boolean;
+  androidForegroundService: boolean;
+  androidFSPermissions: string[];
+  androidFSTypes: string[];
+}
+
+const withDefaultOptions = (options: Partial<Options>): Options => {
+  return {
+    iosBackgroundMode: true,
+    androidForegroundService: true,
+    androidFSPermissions: [
+      'android.permission.FOREGROUND_SERVICE',
+      'android.permission.WAKE_LOCK',
+    ],
+    androidFSTypes: ['mediaPlayback'],
+    ...options,
+  };
+};
+
 const withBackgroundAudio: ConfigPlugin = (config) => {
   return withInfoPlist(config, (iosConfig) => {
     iosConfig.modResults.UIBackgroundModes = [
@@ -20,18 +39,20 @@ const withBackgroundAudio: ConfigPlugin = (config) => {
   });
 };
 
-const withAndroidPermissions: ConfigPlugin<{
-  androidFSPermissions: string[];
-}> = (config, { androidFSPermissions }) => {
+const withAndroidPermissions: ConfigPlugin<Options> = (
+  config,
+  { androidFSPermissions }: Options
+) => {
   return AndroidConfig.Permissions.withPermissions(
     config,
     androidFSPermissions
   );
 };
 
-const withForegroundService: ConfigPlugin<{
-  androidFSTypes: string[];
-}> = (config, { androidFSTypes }) => {
+const withForegroundService: ConfigPlugin<Options> = (
+  config,
+  { androidFSTypes }: Options
+) => {
   return withAndroidManifest(config, (mod) => {
     const manifest = mod.modResults;
     const mainApplication =
@@ -59,30 +80,16 @@ const withForegroundService: ConfigPlugin<{
   });
 };
 
-const withAudioAPI: ConfigPlugin<{
-  iosBackgroundMode?: boolean;
-  androidForegroundService?: boolean;
-  androidFSPermissions?: string[];
-  androidFSTypes?: string[];
-}> = (
-  config,
-  {
-    iosBackgroundMode = true,
-    androidForegroundService = true,
-    androidFSPermissions = [],
-    androidFSTypes = [],
-  }
-) => {
-  if (iosBackgroundMode) {
+const withAudioAPI: ConfigPlugin<Options> = (config, optionsIn) => {
+  const options = withDefaultOptions(optionsIn ?? {});
+
+  if (options.iosBackgroundMode) {
     config = withBackgroundAudio(config);
   }
-  if (androidForegroundService) {
-    config = withAndroidPermissions(config, {
-      androidFSPermissions,
-    });
-    config = withForegroundService(config, {
-      androidFSTypes,
-    });
+
+  if (options.androidForegroundService) {
+    config = withAndroidPermissions(config, options);
+    config = withForegroundService(config, options);
   }
 
   return config;

package/src/specs/NativeAudioAPIModule.ts

@@ -5,20 +5,28 @@ import { PermissionStatus } from '../system/types';
 
 interface Spec extends TurboModule {
   install(): boolean;
+  getDevicePreferredSampleRate(): number;
 
-  setLockScreenInfo(info: {
-    [key: string]: string | boolean | number | undefined;
-  }): void;
-  resetLockScreenInfo(): void;
-  enableRemoteCommand(name: string, enabled: boolean): void;
+  // AVAudioSession management
+  setAudioSessionActivity(enabled: boolean): Promise<boolean>;
   setAudioSessionOptions(
     category: string,
     mode: string,
     options: Array<string>
   ): void;
-  getDevicePreferredSampleRate(): number;
+
+  // Lock Screen Info
+  setLockScreenInfo(info: {
+    [key: string]: string | boolean | number | undefined;
+  }): void;
+  resetLockScreenInfo(): void;
+
+  // Remote commands, system events and interruptions
+  enableRemoteCommand(name: string, enabled: boolean): void;
   observeAudioInterruptions(enabled: boolean): void;
   observeVolumeChanges(enabled: boolean): void;
+
+  // Permissions
   requestRecordingPermissions(): Promise<PermissionStatus>;
   checkRecordingPermissions(): Promise<PermissionStatus>;
 }

package/src/system/AudioManager.ts

@@ -1,5 +1,9 @@
 import { SessionOptions, LockScreenInfo, PermissionStatus } from './types';
-import { SystemEventName, SystemEventCallback } from '../events/types';
+import {
+  SystemEventName,
+  SystemEventCallback,
+  RemoteCommandEventName,
+} from '../events/types';
 import { NativeAudioAPIModule } from '../specs';
 import { AudioEventEmitter, AudioEventSubscription } from '../events';
 
@@ -19,12 +23,12 @@ class AudioManager {
     this.audioEventEmitter = new AudioEventEmitter(global.AudioEventEmitter);
   }
 
-  setLockScreenInfo(info: LockScreenInfo) {
-    NativeAudioAPIModule!.setLockScreenInfo(info);
+  getDevicePreferredSampleRate(): number {
+    return NativeAudioAPIModule!.getDevicePreferredSampleRate();
   }
 
-  resetLockScreenInfo() {
-    NativeAudioAPIModule!.resetLockScreenInfo();
+  setAudioSessionActivity(enabled: boolean): Promise<boolean> {
+    return NativeAudioAPIModule!.setAudioSessionActivity(enabled);
   }
 
   setAudioSessionOptions(options: SessionOptions) {
@@ -35,8 +39,12 @@ class AudioManager {
     );
   }
 
-  getDevicePreferredSampleRate(): number {
-    return NativeAudioAPIModule!.getDevicePreferredSampleRate();
+  setLockScreenInfo(info: LockScreenInfo) {
+    NativeAudioAPIModule!.setLockScreenInfo(info);
+  }
+
+  resetLockScreenInfo() {
+    NativeAudioAPIModule!.resetLockScreenInfo();
   }
 
   observeAudioInterruptions(enabled: boolean) {
@@ -47,17 +55,14 @@ class AudioManager {
     NativeAudioAPIModule!.observeVolumeChanges(enabled);
   }
 
-  enableSystemEvent<Name extends SystemEventName>(
-    name: Name,
-    callback?: SystemEventCallback<Name>,
-    enabled = true
-  ): AudioEventSubscription | null {
+  enableRemoteCommand(name: RemoteCommandEventName, enabled: boolean) {
     NativeAudioAPIModule!.enableRemoteCommand(name, enabled);
+  }
 
-    if (!enabled || !callback) {
-      return null;
-    }
-
+  addSystemEventListener<Name extends SystemEventName>(
+    name: Name,
+    callback: SystemEventCallback<Name>
+  ): AudioEventSubscription {
     return this.audioEventEmitter.addAudioEventListener(name, callback);
   }
 

package/src/types.ts

@@ -26,7 +26,8 @@ export interface PeriodicWaveConstraints {
 }
 
 export interface AudioContextOptions {
-  sampleRate: number;
+  sampleRate?: number;
+  initSuspended?: boolean;
 }
 
 export interface OfflineAudioContextOptions {

package/src/web-core/AudioBufferSourceNode.tsx

@@ -210,7 +210,8 @@ export default class AudioBufferSourceNode<
           -1200,
           1200,
           0
-        )
+        ),
+        context
       );
 
       this.playbackRate = new AudioParam(
@@ -221,11 +222,15 @@ export default class AudioBufferSourceNode<
           0,
           Infinity,
           1
-        )
+        ),
+        context
       );
     } else {
-      this.detune = new AudioParam((node as DefaultSource).detune);
-      this.playbackRate = new AudioParam((node as DefaultSource).playbackRate);
+      this.detune = new AudioParam((node as DefaultSource).detune, context);
+      this.playbackRate = new AudioParam(
+        (node as DefaultSource).playbackRate,
+        context
+      );
     }
   }
 

package/src/web-core/AudioContext.tsx

@@ -24,14 +24,18 @@ export default class AudioContext implements BaseAudioContext {
   readonly destination: AudioDestinationNode;
   readonly sampleRate: number;
 
-  constructor(options?: AudioContextOptions) {
-    if (options && (options.sampleRate < 8000 || options.sampleRate > 96000)) {
+  constructor(options?: AudioContextOptions, _initSuspended: boolean = false) {
+    if (
+      options &&
+      options.sampleRate &&
+      (options.sampleRate < 8000 || options.sampleRate > 96000)
+    ) {
       throw new NotSupportedError(
         `The provided sampleRate is not supported: ${options.sampleRate}`
       );
     }
 
-    this.context = new window.AudioContext(options);
+    this.context = new window.AudioContext({ sampleRate: options?.sampleRate });
 
     this.sampleRate = this.context.sampleRate;
     this.destination = new AudioDestinationNode(this, this.context.destination);

package/src/web-core/AudioNode.tsx

@@ -1,5 +1,6 @@
 import BaseAudioContext from './BaseAudioContext';
 import { ChannelCountMode, ChannelInterpretation } from '../types';
+import AudioParam from './AudioParam';
 
 export default class AudioNode {
   readonly context: BaseAudioContext;
@@ -21,12 +22,18 @@ export default class AudioNode {
     this.channelInterpretation = this.node.channelInterpretation;
   }
 
-  public connect(destination: AudioNode): AudioNode {
+  public connect(destination: AudioNode | AudioParam): AudioNode | AudioParam {
     if (this.context !== destination.context) {
-      throw new Error('The AudioNodes are from different BaseAudioContexts');
+      throw new Error(
+        'Source and destination are from different BaseAudioContexts'
+      );
     }
 
-    this.node.connect(destination.node);
+    if (destination instanceof AudioParam) {
+      this.node.connect(destination.param);
+    } else {
+      this.node.connect(destination.node);
+    }
 
     return destination;
   }

package/src/web-core/AudioParam.tsx

@@ -1,17 +1,20 @@
 import { RangeError, InvalidStateError } from '../errors';
+import BaseAudioContext from './BaseAudioContext';
 
 export default class AudioParam {
   readonly defaultValue: number;
   readonly minValue: number;
   readonly maxValue: number;
+  readonly context: BaseAudioContext;
 
-  private readonly param: globalThis.AudioParam;
+  readonly param: globalThis.AudioParam;
 
-  constructor(param: globalThis.AudioParam) {
+  constructor(param: globalThis.AudioParam, context: BaseAudioContext) {
     this.param = param;
     this.defaultValue = param.defaultValue;
     this.minValue = param.minValue;
     this.maxValue = param.maxValue;
+    this.context = context;
   }
 
   public get value(): number {

package/src/web-core/BiquadFilterNode.tsx

@@ -15,10 +15,10 @@ export default class BiquadFilterNode extends AudioNode {
     biquadFilter: globalThis.BiquadFilterNode
   ) {
     super(context, biquadFilter);
-    this.frequency = new AudioParam(biquadFilter.frequency);
-    this.detune = new AudioParam(biquadFilter.detune);
-    this.Q = new AudioParam(biquadFilter.Q);
-    this.gain = new AudioParam(biquadFilter.gain);
+    this.frequency = new AudioParam(biquadFilter.frequency, context);
+    this.detune = new AudioParam(biquadFilter.detune, context);
+    this.Q = new AudioParam(biquadFilter.Q, context);
+    this.gain = new AudioParam(biquadFilter.gain, context);
   }
 
   public get type(): BiquadFilterType {

package/src/web-core/GainNode.tsx

@@ -7,6 +7,6 @@ export default class GainNode extends AudioNode {
 
   constructor(context: BaseAudioContext, gain: globalThis.GainNode) {
     super(context, gain);
-    this.gain = new AudioParam(gain.gain);
+    this.gain = new AudioParam(gain.gain, context);
   }
 }

package/src/web-core/OscillatorNode.tsx

@@ -12,8 +12,8 @@ export default class OscillatorNode extends AudioScheduledSourceNode {
   constructor(context: BaseAudioContext, node: globalThis.OscillatorNode) {
     super(context, node);
 
-    this.detune = new AudioParam(node.detune);
-    this.frequency = new AudioParam(node.frequency);
+    this.detune = new AudioParam(node.detune, context);
+    this.frequency = new AudioParam(node.frequency, context);
   }
 
   public get type(): OscillatorType {

package/src/web-core/StereoPannerNode.tsx

@@ -7,6 +7,6 @@ export default class StereoPannerNode extends AudioNode {
 
   constructor(context: BaseAudioContext, pan: globalThis.StereoPannerNode) {
     super(context, pan);
-    this.pan = new AudioParam(pan.pan);
+    this.pan = new AudioParam(pan.pan, context);
   }
 }

package/android/src/main/res/drawable/skip_backward_5.xml

@@ -1,9 +0,0 @@
-<vector xmlns:android="http://schemas.android.com/apk/res/android"
-        android:width="24dp"
-        android:height="24dp"
-        android:viewportWidth="24.0"
-        android:viewportHeight="24.0">
-    <path
-        android:fillColor="#FFFFFFFF"
-        android:pathData="M12,5L12,1L7,6l5,5L12,7c3.3,0 6,2.7 6,6s-2.7,6 -6,6 -6,-2.7 -6,-6L4,13c0,4.4 3.6,8 8,8s8,-3.6 8,-8 -3.6,-8 -8,-8zM10.7,13.9l0.2,-2.2h2.4v0.7h-1.7l-0.1,0.9s0.1,0 0.1,-0.1 0.1,0 0.1,-0.1 0.1,0 0.2,0h0.2c0.2,0 0.4,0 0.5,0.1s0.3,0.2 0.4,0.3 0.2,0.3 0.3,0.5 0.1,0.4 0.1,0.6c0,0.2 0,0.4 -0.1,0.5s-0.1,0.3 -0.3,0.5 -0.3,0.2 -0.4,0.3 -0.4,0.1 -0.6,0.1c-0.2,0 -0.4,0 -0.5,-0.1s-0.3,-0.1 -0.5,-0.2 -0.2,-0.2 -0.3,-0.4 -0.1,-0.3 -0.1,-0.5h0.8c0,0.2 0.1,0.3 0.2,0.4s0.2,0.1 0.4,0.1c0.1,0 0.2,0 0.3,-0.1l0.2,-0.2s0.1,-0.2 0.1,-0.3v-0.6l-0.1,-0.2 -0.2,-0.2s-0.2,-0.1 -0.3,-0.1h-0.2s-0.1,0 -0.2,0.1 -0.1,0 -0.1,0.1 -0.1,0.1 -0.1,0.1h-0.7z"/>
-</vector>

package/android/src/main/res/drawable/skip_forward_5.xml

@@ -1,9 +0,0 @@
-<vector xmlns:android="http://schemas.android.com/apk/res/android"
-        android:width="24dp"
-        android:height="24dp"
-        android:viewportWidth="24.0"
-        android:viewportHeight="24.0">
-    <path
-        android:fillColor="#FFFFFFFF"
-        android:pathData="M4,13c0,4.4 3.6,8 8,8s8,-3.6 8,-8h-2c0,3.3 -2.7,6 -6,6s-6,-2.7 -6,-6 2.7,-6 6,-6v4l5,-5 -5,-5v4c-4.4,0 -8,3.6 -8,8zM10.7,13.9l0.2,-2.2h2.4v0.7h-1.7l-0.1,0.9s0.1,0 0.1,-0.1 0.1,0 0.1,-0.1 0.1,0 0.2,0h0.2c0.2,0 0.4,0 0.5,0.1s0.3,0.2 0.4,0.3 0.2,0.3 0.3,0.5 0.1,0.4 0.1,0.6c0,0.2 0,0.4 -0.1,0.5s-0.1,0.3 -0.3,0.5 -0.3,0.2 -0.5,0.3 -0.4,0.1 -0.6,0.1c-0.2,0 -0.4,0 -0.5,-0.1s-0.3,-0.1 -0.5,-0.2 -0.2,-0.2 -0.3,-0.4 -0.1,-0.3 -0.1,-0.5h0.8c0,0.2 0.1,0.3 0.2,0.4s0.2,0.1 0.4,0.1c0.1,0 0.2,0 0.3,-0.1l0.2,-0.2s0.1,-0.2 0.1,-0.3v-0.6l-0.1,-0.2 -0.2,-0.2s-0.2,-0.1 -0.3,-0.1h-0.2s-0.1,0 -0.2,0.1 -0.1,0 -0.1,0.1 -0.1,0.1 -0.1,0.1h-0.6z"/>
-</vector>