refactor: jsdocs, docs, removed some unused code

Author: mdydek

apps/common-app/src/demos/Record/Record.tsx

@@ -40,8 +40,8 @@ const Record: FC = () => {
     );
 
     return () => {
-      RecordingNotificationManager.removeEventListener(pauseListener);
-      RecordingNotificationManager.removeEventListener(resumeListener);
+      pauseListener.remove();
+      resumeListener.remove();
       RecordingNotificationManager.hide();
     };
   }, []);

packages/audiodocs/docs/other/ffmpeg-info.mdx

@@ -2,6 +2,9 @@
 sidebar_position: 5
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # FFmpeg additional information
 
 We use [`ffmpeg`](https://github.com/FFmpeg/FFmpeg) for few components:
@@ -13,27 +16,28 @@ We use [`ffmpeg`](https://github.com/FFmpeg/FFmpeg) for few components:
 The ffmpeg usage is enabled by default, however if you would like not to use it, f.e. there are some name clashes with other ffmpeg
 binaries in your project, you can easily disable it. Just add one flag in corresponding file.
 
-## Expo projects
-
-Add entry in [expo plugin](/docs/fundamentals/getting-started#step-2-add-audio-api-expo-plugin-optional). If not provided, default
-value is `false`.
-
-```
-"disableFFmpeg": true
-```
-
-## Non expo projects
-
-### Android
-
-gradle.properties
-```
-disableAudioapiFFmpeg=true
-```
-
-### iOS
-
-Podfile
-```
-ENV['DISABLE_AUDIOAPI_FFMPEG'] = '1'
-```
+:::info
+FFmpeg is enabled by default
+:::
+
+<Tabs queryString="platform">
+  <TabItem value="expo" label="Expo" default>
+    Add entry in [expo plugin](/docs/fundamentals/getting-started#step-2-add-audio-api-expo-plugin-optional).
+
+    ```
+    "disableFFmpeg": true
+    ```
+  </TabItem>
+  <TabItem value="iOS" label="iOS">
+    Podfile
+    ```
+    ENV['DISABLE_AUDIOAPI_FFMPEG'] = '1'
+    ```
+  </TabItem>
+  <TabItem value="android" label="Android">
+    gradle.properties
+    ```
+    disableAudioapiFFmpeg=true
+    ```
+  </TabItem>
+</Tabs>

packages/audiodocs/docs/system/recording-notification-manager.mdx

@@ -49,7 +49,7 @@ Shows the recording notification with the parameters.
 #### Returns `Promise<void>`.
 
 :::info
-For more details about what exactly each options mean, go to [android developer page](https://developer.android.com/develop/ui/views/notifications#Templates).
+For more details, go to [android developer page](https://developer.android.com/develop/ui/views/notifications#Templates).
 Resource name is a path to resource plased in res/drawable folder. It has to be either .png file or .xml file, name is indicated without file extenstion. (photo.png -> photo).
 :::
 
@@ -76,22 +76,6 @@ Hides the recording notification.
 | :--------: | :---------- |
 | `NotSupportedError` | NativeAudioAPIModule is not available |
 
-### `update`
-
-Updates the recording notification with the new state.
-
-| Parameter |Type| Description|
-| :-------: | :--: | :----|
-|  `info`   | [`RecordingNotificationInfo`](recording-notification-manager#recordingnotificationinfo) | Metadata to update |
-
-#### Returns `Promise<void>`.
-
-#### Errors
-
-| Error type | Description|
-| :--------: | :---------- |
-| `NotSupportedError` | NativeAudioAPIModule is not available |
-
 ### `isActive`
 
 Checks if the notification is displayed.
@@ -109,14 +93,6 @@ Add an event listener for notification actions.
 
 #### Returns [`AudioEventSubscription`](/docs/system/audio-manager#audioeventsubscription).
 
-### `removeEventListener`
-
-Remove an event listener.
-
-|   Parameter    |                                     Type                                      | Description                |
-| :------------: | :---------------------------------------------------------------------------: | :------------------------- |
-| `subscription` | [`AudioEventSubscription`](/docs/system/audio-manager#audioeventsubscription) | The subscription to remove |
-
 ## Remarks
 
 ### `RecordingNotificationInfo`

packages/react-native-audio-api/src/api.web.ts

@@ -37,7 +37,11 @@ export {
   PermissionStatus,
 } from './system/types';
 
-export { PlaybackNotificationManager, AudioManager } from './web-system';
+export {
+  PlaybackNotificationManager,
+  RecordingNotificationManager,
+  AudioManager,
+} from './web-system';
 
 export * from './system/notification/types';
 

packages/react-native-audio-api/src/errors/AudioApiError.ts

@@ -0,0 +1,8 @@
+class AudioApiError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'AudioApiError';
+  }
+}
+
+export default AudioApiError;

packages/react-native-audio-api/src/errors/index.ts

@@ -3,3 +3,4 @@ export { default as InvalidAccessError } from './InvalidAccessError';
 export { default as InvalidStateError } from './InvalidStateError';
 export { default as RangeError } from './RangeError';
 export { default as NotSupportedError } from './NotSupportedError';
+export { default as AudioApiError } from './AudioApiError';

packages/react-native-audio-api/src/system/notification/PlaybackNotificationManager.ts

@@ -11,11 +11,7 @@ import type {
 /// Manager for media playback notifications with controls and MediaSession integration.
 class PlaybackNotificationManager
   implements
-    NotificationManager<
-      PlaybackNotificationInfo,
-      PlaybackNotificationInfo,
-      PlaybackNotificationEventName
-    >
+    NotificationManager<PlaybackNotificationInfo, PlaybackNotificationEventName>
 {
   private notificationKey = 'playback';
   private audioEventEmitter: AudioEventEmitter;
@@ -102,11 +98,6 @@ class PlaybackNotificationManager
   ): AudioEventSubscription {
     return this.audioEventEmitter.addAudioEventListener(eventName, callback);
   }
-
-  /** Remove an event listener. */
-  removeEventListener(subscription: AudioEventSubscription): void {
-    subscription.remove();
-  }
 }
 
 export default new PlaybackNotificationManager();

packages/react-native-audio-api/src/system/notification/RecordingNotificationManager.ts

@@ -7,29 +7,31 @@ import type {
   RecordingNotificationInfo,
 } from './types';
 
-import { NotSupportedError } from '../../errors';
+import { AudioApiError } from '../../errors';
 
-/// Manager for media playback notifications with controls and MediaSession integration.
 class RecordingNotificationManager
   implements
     NotificationManager<
-      RecordingNotificationInfo,
       RecordingNotificationInfo,
       RecordingNotificationEventName
     >
 {
-  private notificationKey = 'react-native audio-api-recording';
+  private notificationKey = 'react-native-audio-api-recording';
   private audioEventEmitter: AudioEventEmitter;
 
   constructor() {
     this.audioEventEmitter = new AudioEventEmitter(global.AudioEventEmitter);
   }
 
-  /// Show the notification with metadata or update if already visible.
-  /// Automatically creates the notification on first call.
+  /**
+   * Show the notification with metadata or update if already visible.
+   *
+   * @param info - The info to be displayed.
+   * @returns Promise that resolves after creating notification.
+   */
   async show(info: RecordingNotificationInfo): Promise<void> {
     if (!NativeAudioAPIModule) {
-      throw new NotSupportedError('NativeAudioAPIModule is not available');
+      throw new AudioApiError('NativeAudioAPIModule is not available');
     }
 
     const result = await NativeAudioAPIModule.showNotification(
@@ -43,16 +45,14 @@ class RecordingNotificationManager
     }
   }
 
-  /// Update the notification with new metadata or state.
-  /// This is an alias for show() since show handles both initial display and updates.
-  async update(info: RecordingNotificationInfo): Promise<void> {
-    return this.show(info);
-  }
-
-  /// Hide the notification.
+  /**
+   * Hide the notification.
+   *
+   * @returns Promise that resolves after hiding notification.
+   */
   async hide(): Promise<void> {
     if (!NativeAudioAPIModule) {
-      throw new NotSupportedError('NativeAudioAPIModule is not available');
+      throw new AudioApiError('NativeAudioAPIModule is not available');
     }
 
     const result = await NativeAudioAPIModule.hideNotification(
@@ -64,7 +64,11 @@ class RecordingNotificationManager
     }
   }
 
-  /// Check if the notification is currently active.
+  /**
+   * Check if the notification is currently active.
+   *
+   * @returns Promise that resolves to whether notification is active.
+   */
   async isActive(): Promise<boolean> {
     if (!NativeAudioAPIModule) {
       return false;
@@ -75,18 +79,19 @@ class RecordingNotificationManager
     );
   }
 
-  /// Add an event listener for notification actions.
+  /**
+   * Add an event listener for notification actions.
+   *
+   * @param eventName - The event name to listen for.
+   * @param callback - The callback to invoke on event.
+   * @returns Promise that resolves to whether notification is active.
+   */
   addEventListener<T extends RecordingNotificationEventName>(
     eventName: T,
     callback: (event: RecordingNotificationEvent[T]) => void
   ): AudioEventSubscription {
     return this.audioEventEmitter.addAudioEventListener(eventName, callback);
   }
-
-  /** Remove an event listener. */
-  removeEventListener(subscription: AudioEventSubscription): void {
-    subscription.remove();
-  }
 }
 
 export default new RecordingNotificationManager();

packages/react-native-audio-api/src/system/notification/types.ts

@@ -5,16 +5,12 @@ import { EventEmptyType, EventTypeWithValue } from '../../events/types';
 /// Provides a consistent API for managing notification lifecycle and events.
 export interface NotificationManager<
   TShowOptions,
-  TUpdateOptions,
   TEventName extends NotificationEventName,
 > {
   /// Show the notification with options or update if already visible.
   /// Automatically creates the notification instance on first call.
   show(options: TShowOptions): Promise<void>;
 
-  /// Update the notification with new options (alias for show).
-  update(options: TUpdateOptions): Promise<void>;
-
   /// Hide the notification.
   hide(): Promise<void>;
 
@@ -26,9 +22,6 @@ export interface NotificationManager<
     eventName: T,
     callback: NotificationCallback<T>
   ): AudioEventSubscription | undefined;
-
-  /// Remove an event listener.
-  removeEventListener(subscription: AudioEventSubscription): void;
 }
 
 /// Metadata and state information for playback notifications.
@@ -77,8 +70,6 @@ export interface RecordingNotificationInfo {
   color?: number;
 }
 
-export type RecordingControlName = 'pause' | 'resume';
-
 export interface RecordingNotificationEvent {
   recordingNotificationPause: EventEmptyType;
   recordingNotificationResume: EventEmptyType;

packages/react-native-audio-api/src/web-system/notification/PlaybackNotificationManager.ts

@@ -14,11 +14,7 @@ import type {
 /// Mock Manager for playback notifications. Does nothing.
 class PlaybackNotificationManager
   implements
-    NotificationManager<
-      PlaybackNotificationInfo,
-      PlaybackNotificationInfo,
-      PlaybackNotificationEventName
-    >
+    NotificationManager<PlaybackNotificationInfo, PlaybackNotificationEventName>
 {
   private isRegistered_ = false;
   private isShown_ = false;
@@ -57,8 +53,6 @@ class PlaybackNotificationManager
       remove: () => {},
     } as unknown as AudioEventSubscription;
   }
-
-  removeEventListener(subscription: AudioEventSubscription): void {}
 }
 
 export default new PlaybackNotificationManager();