@edkimmel/expo-audio-stream 0.3.3 → 0.4.0

package/src/events.ts

@@ -23,10 +23,6 @@ export interface AudioEventPayload {
   frequencyBands?: { low: number; mid: number; high: number };
 }
 
-export type SoundChunkPlayedEventPayload = {
-  isFinal: boolean;
-};
-
 export const DeviceReconnectedReasons = {
   newDeviceAvailable: "newDeviceAvailable",
   oldDeviceUnavailable: "oldDeviceUnavailable",
@@ -42,8 +38,6 @@ export type DeviceReconnectedEventPayload = {
 
 export const AudioEvents = {
   AudioData: "AudioData",
-  SoundChunkPlayed: "SoundChunkPlayed",
-  SoundStarted: "SoundStarted",
   DeviceReconnected: "DeviceReconnected",
 };
 
@@ -53,12 +47,6 @@ export function addAudioEventListener(
   return (emitter as any).addListener("AudioData", listener);
 }
 
-export function addSoundChunkPlayedListener(
-  listener: (event: SoundChunkPlayedEventPayload) => Promise<void>
-): EventSubscription {
-  return (emitter as any).addListener("SoundChunkPlayed", listener);
-}
-
 export function subscribeToEvent<T extends unknown>(
   eventName: string,
   listener: (event: T | undefined) => Promise<void>

package/src/index.ts

@@ -8,7 +8,6 @@ import {
   AudioRecording,
   RecordingConfig,
   StartRecordingResult,
-  SoundConfig,
   PlaybackMode,
   Encoding,
   EncodingTypes,
@@ -31,82 +30,21 @@ import {
 
 import {
   addAudioEventListener,
-  addSoundChunkPlayedListener,
   AudioEventPayload,
-  SoundChunkPlayedEventPayload,
   AudioEvents,
   subscribeToEvent,
   DeviceReconnectedReason,
   DeviceReconnectedEventPayload,
 } from "./events";
 
-const SuspendSoundEventTurnId = "suspend-sound-events";
-
 export class ExpoPlayAudioStream {
   /**
    * Destroys the audio stream module, cleaning up all resources.
    * This should be called when the module is no longer needed.
    * It will reset all internal state and release audio resources.
    */
-  static destroy() {
-    ExpoPlayAudioStreamModule.destroy();
-  }
-
-  /**
-   * @deprecated Use the `Pipeline` class for more efficient audio streaming with better error handling and telemetry.
-   * Plays a sound.
-   * @param {string} audio - The audio to play.
-   * @param {string} turnId - The turn ID.
-   * @param {string} [encoding] - The encoding format of the audio data ('pcm_f32le' or 'pcm_s16le').
-   * @returns {Promise<void>}
-   * @throws {Error} If the sound fails to play.
-   */
-  static async playSound(
-    audio: string,
-    turnId: string,
-    encoding?: Encoding
-  ): Promise<void> {
-    try {
-      await ExpoPlayAudioStreamModule.playSound(
-        audio,
-        turnId,
-        encoding ?? EncodingTypes.PCM_S16LE
-      );
-    } catch (error) {
-      console.error(error);
-      throw new Error(`Failed to enqueue audio: ${error}`);
-    }
-  }
-
-  /**
-   * @deprecated Use the `Pipeline` class for more efficient audio streaming with better error handling and telemetry.
-   * Stops the currently playing sound.
-   * @returns {Promise<void>}
-   * @throws {Error} If the sound fails to stop.
-   */
-  static async stopSound(): Promise<void> {
-    try {
-      await ExpoPlayAudioStreamModule.stopSound();
-    } catch (error) {
-      console.error(error);
-      throw new Error(`Failed to stop enqueued audio: ${error}`);
-    }
-  }
-
-  /**
-   * @deprecated Use the `Pipeline` class for more efficient audio streaming with better error handling and telemetry.
-   * Clears the sound queue by turn ID.
-   * @param {string} turnId - The turn ID.
-   * @returns {Promise<void>}
-   * @throws {Error} If the sound queue fails to clear.
-   */
-  static async clearSoundQueueByTurnId(turnId: string): Promise<void> {
-    try {
-      await ExpoPlayAudioStreamModule.clearSoundQueueByTurnId(turnId);
-    } catch (error) {
-      console.error(error);
-      throw new Error(`Failed to clear sound queue: ${error}`);
-    }
+  static async destroy() {
+    await ExpoPlayAudioStreamModule.destroy();
   }
 
   /**
@@ -181,15 +119,7 @@ export class ExpoPlayAudioStream {
   /**
    * Subscribes to audio events emitted during recording/streaming.
    * @param onMicrophoneStream - Callback function that will be called when audio data is received.
-   * The callback receives an AudioDataEvent containing:
-   * - data: Base64 encoded audio data at original sample rate
-   * - data16kHz: Optional base64 encoded audio data resampled to 16kHz
-   * - position: Current position in the audio stream
-   * - fileUri: URI of the recording file
-   * - eventDataSize: Size of the current audio data chunk
-   * - totalSize: Total size of recorded audio so far
    * @returns {Subscription} A subscription object that can be used to unsubscribe from the events
-   * @throws {Error} If encoded audio data is missing from the event
    */
   static subscribeToAudioEvents(
     onMicrophoneStream: (event: AudioDataEvent) => Promise<void>
@@ -213,18 +143,6 @@ export class ExpoPlayAudioStream {
     });
   }
 
-  /**
-   * Subscribes to events emitted when a sound chunk has finished playing.
-   * @param onSoundChunkPlayed - Callback function that will be called when a sound chunk is played.
-   * The callback receives a SoundChunkPlayedEventPayload indicating if this was the final chunk.
-   * @returns {Subscription} A subscription object that can be used to unsubscribe from the events.
-   */
-  static subscribeToSoundChunkPlayed(
-    onSoundChunkPlayed: (event: SoundChunkPlayedEventPayload) => Promise<void>
-  ): Subscription {
-    return addSoundChunkPlayedListener(onSoundChunkPlayed);
-  }
-
   /**
    * Subscribes to events emitted by the audio stream module, for advanced use cases.
    * @param eventName - The name of the event to subscribe to.
@@ -238,21 +156,6 @@ export class ExpoPlayAudioStream {
     return subscribeToEvent(eventName, onEvent);
   }
 
-  /**
-   * Sets the sound player configuration.
-   * @param {SoundConfig} config - Configuration options for the sound player.
-   * @returns {Promise<void>}
-   * @throws {Error} If the configuration fails to update.
-   */
-  static async setSoundConfig(config: SoundConfig): Promise<void> {
-    try {
-      await ExpoPlayAudioStreamModule.setSoundConfig(config);
-    } catch (error) {
-      console.error(error);
-      throw new Error(`Failed to set sound configuration: ${error}`);
-    }
-  }
-
   /**
    * Prompts the user to select the microphone mode.
    * @returns {Promise<void>}
@@ -308,15 +211,12 @@ export class ExpoPlayAudioStream {
 
 export {
   AudioDataEvent,
-  SoundChunkPlayedEventPayload,
   DeviceReconnectedReason,
   DeviceReconnectedEventPayload,
   AudioRecording,
   RecordingConfig,
   StartRecordingResult,
   AudioEvents,
-  SuspendSoundEventTurnId,
-  SoundConfig,
   PlaybackMode,
   Encoding,
   EncodingTypes,

package/src/types.ts

@@ -16,41 +16,6 @@ export const PlaybackModes = {
 export type PlaybackMode =
   (typeof PlaybackModes)[keyof typeof PlaybackModes];
 
-/**
- * Configuration for audio playback settings
- */
-export interface SoundConfig {
-  /**
-   * The sample rate for audio playback in Hz
-   */
-  sampleRate?: SampleRate;
-
-  /**
-   * The playback mode (regular, voiceProcessing, or conversation)
-   */
-  playbackMode?: PlaybackMode;
-
-  /**
-   * When true, resets to default configuration regardless of other parameters
-   */
-  useDefault?: boolean;
-
-  /**
-   * Enable jitter buffering for audio streams
-   */
-  enableBuffering?: boolean;
-
-  /**
-   * Automatically enable buffering based on network conditions
-   */
-  autoBuffer?: boolean;
-
-  /**
-   * Configuration for the jitter buffer when enableBuffering is true
-   */
-  bufferConfig?: Partial<IAudioBufferConfig>;
-}
-
 /**
  * Configuration for buffered audio streaming
  */