fix(ui): await audio recorder feedback callbacks to prevent sound bleeding into recordings (#2488)

Co-authored-by: xsahil03x <25670178+xsahil03x@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Sahil Kumar <xdsahil@gmail.com>
Co-authored-by: Sahil Kumar <sahil@getstream.io>

Author: Copilot

packages/stream_chat_flutter/CHANGELOG.md

@@ -3,6 +3,7 @@
 🐞 Fixed
 
 - Fixed `StreamChannelAvatar` crashing with `RangeError` when user/channel name is empty.
+- Fixed audio tone bleeding into recorded voice message when playing custom feedback sound on recording start.
 
 ## 9.22.0
 

packages/stream_chat_flutter/lib/src/message_input/audio_recorder/audio_recorder_feedback.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:flutter/widgets.dart';
 
 /// A feedback handler for audio recorder interactions.
@@ -17,13 +19,21 @@ import 'package:flutter/widgets.dart';
 /// ```
 ///
 /// Custom feedback (haptic or system sounds):
+///
+/// **Note:** Generally, you should not await feedback to avoid blocking the
+/// recorder. However, if you play sound-based feedback (e.g., custom tones or
+/// system sounds) and notice audio bleeding into the recorded voice message,
+/// try awaiting it to ensure the sound completes before recording begins.
+///
 /// ```dart
 /// class CustomFeedback extends AudioRecorderFeedback {
 ///   @override
 ///   Future<void> onRecordStart(BuildContext context) async {
-///     // Haptic feedback
-///     await HapticFeedback.heavyImpact();
-///     // Or system sound
+///     // Haptic feedback - no need to await (doesn't produce sound)
+///     HapticFeedback.heavyImpact();
+///
+///     // System sound - await only if it bleeds into the recording
+///     SystemSound.play(SystemSoundType.click);
 ///     // await SystemSound.play(SystemSoundType.click);
 ///   }
 /// }
@@ -55,23 +65,23 @@ class AudioRecorderFeedback {
   /// recording actually begins.
   Future<void> onRecordStart(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forLongPress(context);
+    return unawaited(Feedback.forLongPress(context));
   }
 
   /// Provides platform-specific feedback when recording is paused.
   ///
   /// This is called when the user pauses the ongoing recording.
   Future<void> onRecordPause(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forTap(context);
+    return unawaited(Feedback.forTap(context));
   }
 
   /// Provides platform-specific feedback when recording is finished.
   ///
   /// This is called when the user finishes the recording.
   Future<void> onRecordFinish(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forTap(context);
+    return unawaited(Feedback.forTap(context));
   }
 
   /// Provides platform-specific feedback when the recording is locked.
@@ -80,15 +90,15 @@ class AudioRecorderFeedback {
   /// holding the record button.
   Future<void> onRecordLock(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forLongPress(context);
+    return unawaited(Feedback.forLongPress(context));
   }
 
   /// Provides platform-specific feedback when recording is canceled.
   ///
   /// This is called when the user cancels an ongoing recording.
   Future<void> onRecordCancel(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forTap(context);
+    return unawaited(Feedback.forTap(context));
   }
 
   /// Provides platform-specific feedback when recording is canceled before
@@ -98,7 +108,7 @@ class AudioRecorderFeedback {
   /// the recording actually starts.
   Future<void> onRecordStartCancel(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forTap(context);
+    return unawaited(Feedback.forTap(context));
   }
 
   /// Provides platform-specific feedback when recording stops.
@@ -107,7 +117,7 @@ class AudioRecorderFeedback {
   /// is now ready to be used.
   Future<void> onRecordStop(BuildContext context) async {
     if (!enableFeedback) return;
-    return Feedback.forTap(context);
+    return unawaited(Feedback.forTap(context));
   }
 }
 

packages/stream_chat_flutter/lib/src/message_input/audio_recorder/stream_audio_recorder.dart

@@ -127,41 +127,41 @@ class StreamAudioRecorderButton extends StatelessWidget {
     final isLocked = isRecording && recordState is! RecordStateRecordingHold;
 
     return GestureDetector(
-      onLongPressStart: (_) {
+      onLongPressStart: (_) async {
         // Return if the recording is already started.
         if (isRecording) return;
 
-        feedback.onRecordStart(context);
+        await feedback.onRecordStart(context);
         return onRecordStart?.call();
       },
-      onLongPressEnd: (_) {
+      onLongPressEnd: (_) async {
         // Return if the recording not yet started or already locked.
         if (!isRecording || isLocked) return;
 
-        feedback.onRecordFinish(context);
+        await feedback.onRecordFinish(context);
         return onRecordFinish?.call();
       },
-      onLongPressCancel: () {
+      onLongPressCancel: () async {
         // Return if the recording is already started.
         if (isRecording) return;
 
         // Notify the parent that the recorder is canceled before it starts.
-        feedback.onRecordStartCancel(context);
+        await feedback.onRecordStartCancel(context);
         return onRecordStartCancel?.call();
       },
-      onLongPressMoveUpdate: (details) {
+      onLongPressMoveUpdate: (details) async {
         // Return if the recording not yet started or already locked.
         if (!isRecording || isLocked) return;
         final dragOffset = details.offsetFromOrigin;
 
         // Lock recording if the drag offset is greater than the threshold.
         if (dragOffset.dy <= -lockRecordThreshold) {
-          feedback.onRecordLock(context);
+          await feedback.onRecordLock(context);
           return onRecordLock?.call();
         }
         // Cancel recording if the drag offset is greater than the threshold.
         if (dragOffset.dx <= -cancelRecordThreshold) {
-          feedback.onRecordCancel(context);
+          await feedback.onRecordCancel(context);
           return onRecordCancel?.call();
         }
 
@@ -187,31 +187,31 @@ class StreamAudioRecorderButton extends StatelessWidget {
             ),
           RecordStateRecordingLocked() => RecordStateLockedRecordingContent(
               state: state,
-              onRecordEnd: () {
-                feedback.onRecordFinish(context);
+              onRecordEnd: () async {
+                await feedback.onRecordFinish(context);
                 return onRecordFinish?.call();
               },
-              onRecordPause: () {
-                feedback.onRecordPause(context);
+              onRecordPause: () async {
+                await feedback.onRecordPause(context);
                 return onRecordPause?.call();
               },
-              onRecordCancel: () {
-                feedback.onRecordCancel(context);
+              onRecordCancel: () async {
+                await feedback.onRecordCancel(context);
                 return onRecordCancel?.call();
               },
-              onRecordStop: () {
-                feedback.onRecordStop(context);
+              onRecordStop: () async {
+                await feedback.onRecordStop(context);
                 return onRecordStop?.call();
               },
             ),
           RecordStateStopped() => RecordStateStoppedContent(
               state: state,
-              onRecordCancel: () {
-                feedback.onRecordCancel(context);
+              onRecordCancel: () async {
+                await feedback.onRecordCancel(context);
                 return onRecordCancel?.call();
               },
-              onRecordFinish: () {
-                feedback.onRecordFinish(context);
+              onRecordFinish: () async {
+                await feedback.onRecordFinish(context);
                 return onRecordFinish?.call();
               },
             ),