Playback events support (#6)

* feat: added sound chunk played event

* chore: bumped version

ios/ExpoPlayAudioStreamModule.swift

@@ -3,8 +3,9 @@ import AVFoundation
 import ExpoModulesCore
 
 let audioDataEvent: String = "AudioData"
+let soundIsPlayedEvent: String = "SoundChunkPlayed"
 
-public class ExpoPlayAudioStreamModule: Module, AudioStreamManagerDelegate, MicrophoneDataDelegate {
+public class ExpoPlayAudioStreamModule: Module, AudioStreamManagerDelegate, MicrophoneDataDelegate, SoundPlayerDelegate {
     private let audioController = AudioController()
     private let audioSessionManager = AudioSessionManager()
     private lazy var microphone: Microphone = {
@@ -23,12 +24,13 @@ public class ExpoPlayAudioStreamModule: Module, AudioStreamManagerDelegate, Micr
         Name("ExpoPlayAudioStream")
 
         // Defines event names that the module can send to JavaScript.
-        Events([audioDataEvent])
+        Events([audioDataEvent, soundIsPlayedEvent])
 
         OnCreate {
             print("Setting up Audio Session Manager")
             audioSessionManager.delegate = self
             microphone.delegate = self
+            soundPlayer.delegate = self
         }
 
         /// Asynchronously starts audio recording with the given settings.
@@ -363,4 +365,8 @@ public class ExpoPlayAudioStreamModule: Module, AudioStreamManagerDelegate, Micr
         // Emit the event to JavaScript
         sendEvent(audioDataEvent, eventBody)
     }
+
+    func onSoundChunkPlayed(_ isFinal: Bool) {
+        sendEvent(soundIsPlayedEvent, ["isFinal": isFinal])
+    }
 }

ios/SoundPlayer.swift

@@ -2,6 +2,7 @@ import AVFoundation
 import ExpoModulesCore
 
 class SoundPlayer {
+    weak var delegate: SoundPlayerDelegate?
     private var audioEngine: AVAudioEngine!
 
     private var inputNode: AVAudioInputNode!
@@ -13,6 +14,8 @@ class SoundPlayer {
     private let bufferAccessQueue = DispatchQueue(label: "com.kinexpoaudiostream.bufferAccessQueue")
 
     private var audioQueue: [(buffer: AVAudioPCMBuffer, promise: RCTPromiseResolveBlock, turnId: String)] = []  // Queue for audio segments
+    // needed to track segments in progress in order to send playbackevents properly
+    private var segmentsLeftToPlay: Int = 0
     private var isPlaying: Bool = false  // Tracks if audio is currently playing
     private var isInterrupted: Bool = false
     private var isAudioEngineIsSetup: Bool = false
@@ -58,6 +61,8 @@ class SoundPlayer {
             self.audioPlayerNode.pause()
             self.audioPlayerNode.stop()
 
+            self.segmentsLeftToPlay = 0
+
             self.isPlaying = false
         } else {
             Logger.debug("Player is not playing")
@@ -102,6 +107,7 @@ class SoundPlayer {
             }
             let bufferTuple = (buffer: pcmBuffer, promise: resolver, turnId: strTurnId)
             audioQueue.append(bufferTuple)
+            self.segmentsLeftToPlay += 1
             print("New Chunk \(isPlaying)")
             // If not already playing, start playback
             playNextInQueue()
@@ -132,6 +138,9 @@ class SoundPlayer {
                 self.audioQueue.removeFirst()
 
                 self.audioPlayerNode.scheduleBuffer(buffer) {
+                    self.segmentsLeftToPlay -= 1
+                    let isFinalSegment = self.segmentsLeftToPlay == 0
+                    self.delegate?.onSoundChunkPlayed(isFinalSegment)
                     promise(nil)
 
 

ios/SoundPlayerDelegate.swift

@@ -0,0 +1,3 @@
+protocol SoundPlayerDelegate: AnyObject {
+   func onSoundChunkPlayed(_ isFinal: Bool)
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mykin-ai/expo-audio-stream",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Expo Play Audio Stream module",
   "main": "build/index.js",
   "types": "build/index.d.ts",

src/events.ts

@@ -21,8 +21,18 @@ export interface AudioEventPayload {
     streamUuid: string
 }
 
+export type SoundChunkPlayedEventPayload = {
+    isFinal: boolean
+}
+
 export function addAudioEventListener(
     listener: (event: AudioEventPayload) => Promise<void>
 ): Subscription {
     return emitter.addListener<AudioEventPayload>('AudioData', listener)
+}
+
+export function addSoundChunkPlayedListener(
+    listener: (event: SoundChunkPlayedEventPayload) => Promise<void>
+): Subscription {
+    return emitter.addListener<SoundChunkPlayedEventPayload>('SoundChunkPlayed', listener)
 }

src/index.ts

@@ -7,7 +7,7 @@ import {
   StartRecordingResult,
 } from "./types";
 
-import { addAudioEventListener, AudioEventPayload } from "./events";
+import { addAudioEventListener, addSoundChunkPlayedListener, AudioEventPayload, SoundChunkPlayedEventPayload } from "./events";
 
 export class ExpoPlayAudioStream {
   /**
@@ -262,6 +262,19 @@ 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>
   ): Subscription {
@@ -282,10 +295,23 @@ 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);
+  }
 }
 
 export {
   AudioDataEvent,
+  SoundChunkPlayedEventPayload,
   AudioRecording,
   RecordingConfig,
   StartRecordingResult,