feat: ⚡ Update audio_waveform dependency

dhyash-simform · dhyash-simform · commit 903ece1892a8 · 2025-11-07T19:04:27.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
 ## [3.0.0] (unreleased)
+
 * **Feat**: [401](https://github.com/SimformSolutionsPvtLtd/chatview/pull/401)
   Add selection and copy options for text view.
 * **Breaking**: [318](https://github.com/SimformSolutionsPvtLtd/chatview/issues/318)
@@ -53,6 +54,11 @@
 * **Breaking**: [390](https://github.com/SimformSolutionsPvtLtd/chatview/pull/390) `playIcon` and
   `pauseIcon` Now accepts a callback that provides different icons based on whether the message is
   by the sender or not. accept `Widget`.
+* **Feat**: [390](https://github.com/SimformSolutionsPvtLtd/chatview/pull/406) Updated
+  audio_waveforms version to `2.0.0`
+* **Breaking**: [390](https://github.com/SimformSolutionsPvtLtd/chatview/pull/406) Moved recording
+  audio settings from `VoiceRecordingConfiguration` to `RecorderSettings`. Check out the migration
+  guide [here](https://simform-flutter-packages.web.app/chatView/migration-guide).
 
 ## [2.5.0]
 
diff --git a/doc/documentation.md b/doc/documentation.md
@@ -1145,6 +1145,45 @@ This guide will help you migrate your code from previous versions of ChatView to
 
 ## Key Changes
 
+### Voice Recording Configuration
+
+The `VoiceRecordingConfiguration` class has been updated to utilize `RecorderSettings`, which now
+encapsulates the recorder settings for both iOS and Android platforms. The `androidOutputFormat`
+property has been removed so whatever format will be given by the encoder that will be used.
+
+Previous Usage:
+```dart
+ChatView(
+  sendMessageConfig: SendMessageConfiguration(
+    voiceRecordingConfiguration: VoiceRecordingConfiguration(
+      sampleRate: 44100,
+      bitRate: 128000,
+      iosEncoder: IosEncoder.kAudioFormatMPEG4AAC,
+      androidEncoder: AndroidEncoder.aacLc,
+      androidOutputFormat: AndroidOutputFormat.mpeg4,
+    ),
+),
+```
+
+New Usage:
+```dart
+ChatView(
+  sendMessageConfig: SendMessageConfiguration(
+    voiceRecordingConfiguration: VoiceRecordingConfiguration(
+        recorderSettings: RecorderSettings(
+          bitRate: 128000,
+          sampleRate: 44100,
+          androidEncoderSettings: AndroidEncoderSettings(
+            androidEncoder: AndroidEncoder.aacLc,
+          ),
+          iosEncoderSettings: IosEncoderSetting(
+            iosEncoder: IosEncoder.kAudioFormatMPEG4AAC,
+          ),
+        ),
+    ),
+),
+```
+
 ### Text Field Action Items
 
 You can now add action buttons to the input field using two builders:
diff --git a/example/lib/widgets/custom_chat_bar.dart b/example/lib/widgets/custom_chat_bar.dart
@@ -375,11 +375,7 @@ class _CustomChatBarState extends State<CustomChatBar> {
   Future<void> _recordOrStop() async {
     if (!isRecording.value) {
       await controller?.record(
-        sampleRate: voiceRecordingConfig.sampleRate,
-        bitRate: voiceRecordingConfig.bitRate,
-        androidEncoder: voiceRecordingConfig.androidEncoder,
-        iosEncoder: voiceRecordingConfig.iosEncoder,
-        androidOutputFormat: voiceRecordingConfig.androidOutputFormat,
+        recorderSettings: voiceRecordingConfig.recorderSettings,
       );
       isRecording.value = true;
     } else {
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -13,7 +13,7 @@ dependencies:
     sdk: flutter
   cupertino_icons: ^1.0.5
   flutter_svg: ^2.2.1
-  audio_waveforms: ^1.3.0
+  audio_waveforms: ^2.0.0
   chatview:
     path: ../
   intl:
diff --git a/lib/chatview.dart b/lib/chatview.dart
@@ -25,9 +25,11 @@ library chatview;
 export 'package:audio_waveforms/audio_waveforms.dart'
     show
         AndroidEncoder,
-        AndroidOutputFormat,
+        AndroidEncoderSettings,
         IosEncoder,
+        IosEncoderSetting,
         PlayerWaveStyle,
+        RecorderSettings,
         WaveStyle;
 export 'package:chatview_utils/chatview_utils.dart'
     hide
diff --git a/lib/src/models/config_models/send_message_configuration.dart b/lib/src/models/config_models/send_message_configuration.dart
@@ -30,6 +30,7 @@ import '../../values/typedefs.dart';
 
 class SendMessageConfiguration {
   const SendMessageConfiguration({
+    this.voiceRecordingConfiguration = const VoiceRecordingConfiguration(),
     this.shouldSendImageWithText = false,
     this.allowRecordingVoice = true,
     this.textFieldConfig,
@@ -42,7 +43,6 @@ class SendMessageConfiguration {
     this.replyTitleColor,
     this.replyMessageColor,
     this.closeIconColor,
-    this.voiceRecordingConfiguration,
     this.micIconColor,
     this.cancelRecordConfiguration,
     this.removeImageIcon,
@@ -92,7 +92,7 @@ class SendMessageConfiguration {
   final Color? micIconColor;
 
   /// Styling configuration for recorder widget.
-  final VoiceRecordingConfiguration? voiceRecordingConfiguration;
+  final VoiceRecordingConfiguration voiceRecordingConfiguration;
 
   /// Configuration for cancel voice recording
   final CancelRecordConfiguration? cancelRecordConfiguration;
@@ -271,6 +271,7 @@ class VoiceRecordingConfiguration {
   /// Styling configuration for the recorder widget as well as
   /// configuring the audio recording quality.
   const VoiceRecordingConfiguration({
+    this.recorderSettings = const RecorderSettings(),
     this.waveStyle,
     this.padding,
     this.margin,
@@ -279,11 +280,6 @@ class VoiceRecordingConfiguration {
     this.micIcon,
     this.recorderIconColor,
     this.stopIcon,
-    this.sampleRate,
-    this.bitRate,
-    this.androidEncoder,
-    this.iosEncoder,
-    this.androidOutputFormat,
   });
 
   /// Applies styles to waveform.
@@ -311,24 +307,8 @@ class VoiceRecordingConfiguration {
   /// Applies color to mic and stop icon.
   final Color? recorderIconColor;
 
-  /// The sample rate for audio is measured in samples per second.
-  /// A higher sample rate generates more samples per second,
-  /// resulting in better audio quality but also larger file sizes.
-  final int? sampleRate;
-
-  /// Bitrate is the amount of data per second that the codec uses to
-  /// encode the audio. A higher bitrate results in better quality
-  /// but also larger file sizes.
-  final int? bitRate;
-
-  /// Audio encoder to be used for recording for IOS.
-  final IosEncoder? iosEncoder;
-
-  /// Audio encoder to be used for recording for Android.
-  final AndroidEncoder? androidEncoder;
-
-  /// The audio output format to be used for recorded audio files on Android.
-  final AndroidOutputFormat? androidOutputFormat;
+  /// Configures audio recording settings for Android and iOS.
+  final RecorderSettings recorderSettings;
 }
 
 class CancelRecordConfiguration {
diff --git a/lib/src/widgets/chat_view.dart b/lib/src/widgets/chat_view.dart
@@ -56,11 +56,11 @@ class ChatView extends StatefulWidget {
     this.appBar,
     ChatBackgroundConfiguration? chatBackgroundConfig,
     this.sendMessageBuilder,
-    this.sendMessageConfig,
     this.onChatListTap,
     required this.chatViewState,
     ChatViewStateConfiguration? chatViewStateConfig,
     this.featureActiveConfig = const FeatureActiveConfig(),
+    this.sendMessageConfig = const SendMessageConfiguration(),
     this.emojiPickerSheetConfig,
     this.replyMessageBuilder,
     this.replySuggestionsConfig,
@@ -123,7 +123,7 @@ class ChatView extends StatefulWidget {
   final ChatController chatController;
 
   /// Provides configuration of default text field in chat.
-  final SendMessageConfiguration? sendMessageConfig;
+  final SendMessageConfiguration sendMessageConfig;
 
   /// Provides current state of chat.
   final ChatViewState chatViewState;
@@ -296,7 +296,7 @@ class _ChatViewState extends State<ChatView>
                                       _sendMessageKey.currentState
                                           ?.assignReplyMessage(message),
                                   textFieldConfig:
-                                      widget.sendMessageConfig?.textFieldConfig,
+                                      widget.sendMessageConfig.textFieldConfig,
                                 ),
                               ),
                             if (featureActiveConfig.enableTextField)
diff --git a/lib/src/widgets/chatui_textfield.dart b/lib/src/widgets/chatui_textfield.dart
@@ -44,12 +44,12 @@ class ChatUITextField extends StatefulWidget {
     required this.onPressed,
     required this.onRecordingComplete,
     required this.onImageSelected,
-    this.sendMessageConfig,
+    required this.sendMessageConfig,
     super.key,
   });
 
   /// Provides configuration of default text field in chat.
-  final SendMessageConfiguration? sendMessageConfig;
+  final SendMessageConfiguration sendMessageConfig;
 
   /// Provides focusNode for focusing text field.
   final FocusNode focusNode;
@@ -80,23 +80,23 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
 
   bool Function(KeyEvent)? _keyboardHandler;
 
-  SendMessageConfiguration? get sendMessageConfig => widget.sendMessageConfig;
+  SendMessageConfiguration get sendMessageConfig => widget.sendMessageConfig;
 
-  VoiceRecordingConfiguration? get voiceRecordingConfig =>
-      widget.sendMessageConfig?.voiceRecordingConfiguration;
+  VoiceRecordingConfiguration get voiceRecordingConfig =>
+      widget.sendMessageConfig.voiceRecordingConfiguration;
 
   ImagePickerIconsConfiguration? get imagePickerIconsConfig =>
-      sendMessageConfig?.imagePickerIconsConfig;
+      sendMessageConfig.imagePickerIconsConfig;
 
   TextFieldConfiguration? get textFieldConfig =>
-      sendMessageConfig?.textFieldConfig;
+      sendMessageConfig.textFieldConfig;
 
   CancelRecordConfiguration? get cancelRecordConfiguration =>
-      sendMessageConfig?.cancelRecordConfiguration;
+      sendMessageConfig.cancelRecordConfiguration;
 
   OutlineInputBorder get _outLineBorder => OutlineInputBorder(
         borderSide: const BorderSide(color: Colors.transparent),
-        borderRadius: widget.sendMessageConfig?.textFieldConfig?.borderRadius ??
+        borderRadius: widget.sendMessageConfig.textFieldConfig?.borderRadius ??
             BorderRadius.circular(textFieldBorderRadius),
       );
 
@@ -112,7 +112,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
     // onChanged is not called when text is set programmatically.
     widget.textEditingController.addListener(_listenTextEditingController);
     debouncer = Debouncer(
-        sendMessageConfig?.textFieldConfig?.compositionThresholdTime ??
+        sendMessageConfig.textFieldConfig?.compositionThresholdTime ??
             const Duration(seconds: 1));
     super.initState();
 
@@ -142,7 +142,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
 
   void attachListeners() {
     composingStatus.addListener(() {
-      widget.sendMessageConfig?.textFieldConfig?.onMessageTyping
+      widget.sendMessageConfig.textFieldConfig?.onMessageTyping
           ?.call(composingStatus.value);
     });
   }
@@ -198,7 +198,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
       decoration: BoxDecoration(
         borderRadius: textFieldConfig?.borderRadius ??
             BorderRadius.circular(textFieldBorderRadius),
-        color: sendMessageConfig?.textFieldBackgroundColor ?? Colors.white,
+        color: sendMessageConfig.textFieldBackgroundColor ?? Colors.white,
       ),
       child: ChatTextFieldViewBuilder<bool>(
         valueListenable: isRecording,
@@ -210,22 +210,22 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
                   child: AudioWaveforms(
                     size: const Size(double.maxFinite, 50),
                     recorderController: controller!,
-                    margin: voiceRecordingConfig?.margin,
-                    padding: voiceRecordingConfig?.padding ??
+                    margin: voiceRecordingConfig.margin,
+                    padding: voiceRecordingConfig.padding ??
                         EdgeInsets.symmetric(
                           horizontal: cancelRecordConfiguration == null ? 8 : 5,
                         ),
-                    decoration: voiceRecordingConfig?.decoration ??
+                    decoration: voiceRecordingConfig.decoration ??
                         BoxDecoration(
-                          color: voiceRecordingConfig?.backgroundColor,
+                          color: voiceRecordingConfig.backgroundColor,
                           borderRadius: BorderRadius.circular(12),
                         ),
-                    waveStyle: voiceRecordingConfig?.waveStyle ??
+                    waveStyle: voiceRecordingConfig.waveStyle ??
                         WaveStyle(
                           extendWaveform: true,
                           showMiddleLine: false,
                           waveColor:
-                              voiceRecordingConfig?.waveStyle?.waveColor ??
+                              voiceRecordingConfig.waveStyle?.waveColor ??
                                   Colors.black,
                         ),
                   ),
@@ -271,7 +271,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
                             hintText: textFieldConfig?.hintText ??
                                 PackageStrings.currentLocale.message,
                             fillColor:
-                                sendMessageConfig?.textFieldBackgroundColor ??
+                                sendMessageConfig.textFieldBackgroundColor ??
                                     Colors.white,
                             filled: true,
                             hintMaxLines: textFieldConfig?.hintMaxLines ?? 1,
@@ -300,13 +300,13 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
                 builder: (_, isNotEmpty, child) {
                   if (isNotEmpty) {
                     return IconButton(
-                      color: sendMessageConfig?.defaultSendButtonColor ??
+                      color: sendMessageConfig.defaultSendButtonColor ??
                           Colors.green,
-                      style: sendMessageConfig?.sendButtonStyle,
+                      style: sendMessageConfig.sendButtonStyle,
                       onPressed: (textFieldConfig?.enabled ?? true)
                           ? _onPressed
                           : null,
-                      icon: sendMessageConfig?.sendButtonIcon ??
+                      icon: sendMessageConfig.sendButtonIcon ??
                           const Icon(Icons.send),
                     );
                   } else {
@@ -353,20 +353,19 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
                               ],
 
                         // Always add the voice button at the end if allowed
-                        if ((sendMessageConfig?.allowRecordingVoice ?? false) &&
+                        if ((sendMessageConfig.allowRecordingVoice) &&
                             !kIsWeb &&
                             (Platform.isIOS || Platform.isAndroid))
                           IconButton(
                             onPressed: (textFieldConfig?.enabled ?? true)
                                 ? _recordOrStop
                                 : null,
                             icon: (isRecordingValue
-                                    ? voiceRecordingConfig?.stopIcon
-                                    : voiceRecordingConfig?.micIcon) ??
+                                    ? voiceRecordingConfig.stopIcon
+                                    : voiceRecordingConfig.micIcon) ??
                                 Icon(
                                   isRecordingValue ? Icons.stop : Icons.mic,
-                                  color:
-                                      voiceRecordingConfig?.recorderIconColor,
+                                  color: voiceRecordingConfig.recorderIconColor,
                                 ),
                           ),
 
@@ -380,7 +379,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
                             icon: cancelRecordConfiguration?.icon ??
                                 const Icon(Icons.cancel_outlined),
                             color: cancelRecordConfiguration?.iconColor ??
-                                voiceRecordingConfig?.recorderIconColor,
+                                voiceRecordingConfig.recorderIconColor,
                           ),
                       ],
                     );
@@ -428,11 +427,7 @@ class _ChatUITextFieldState extends State<ChatUITextField> {
     );
     if (!isRecording.value) {
       await controller?.record(
-        sampleRate: voiceRecordingConfig?.sampleRate,
-        bitRate: voiceRecordingConfig?.bitRate,
-        androidEncoder: voiceRecordingConfig?.androidEncoder,
-        iosEncoder: voiceRecordingConfig?.iosEncoder,
-        androidOutputFormat: voiceRecordingConfig?.androidOutputFormat,
+        recorderSettings: voiceRecordingConfig.recorderSettings,
       );
       isRecording.value = true;
     } else {
diff --git a/lib/src/widgets/send_message_widget.dart b/lib/src/widgets/send_message_widget.dart
diff --git a/pubspec.yaml b/pubspec.yaml
