repository·master·Indexed 21 days ago
https://github.com/canardoux/flutter_soundA comprehensive audio library for Flutter providing high-level APIs for playing and recording audio across iOS, Android, and Web. It supports various playback sources (Dart buffers, assets, files, remote URLs, and streams) and recording destinations. Key features include real-time stream processing with PCM Float32 and Int16 formats, a FlutterSoundHelper utility for WAVE and Raw PCM conversion, and the FlutterSoundPlayer for managing audio playback lifecycles.
A core feature of Flutter Sound is its deep integration with Dart Streams, allowing for real-time audio processing:
PCM Float32 or PCM Int16 formats. This is useful for processing live audio in Dart or streaming it to a remote host.PCM Float32 or PCM Int16 data. This enables playing live audio generated within Dart (e.g., via a sequencer or sound generator) or received from a remote host.Flutter Sound supports a wide variety of input and output methods:
Playback Sources:
Recording Destinations:
The Tau family consists of several related Flutter plugins for different stages of audio development and platform support:
Etau. It is also released under GPL v3.Etau for Web and Mobile respectively.To use Flutter Sound, ensure your target platforms meet the following minimum SDK requirements:
To change the image displayed during the app's launch on iOS, you can either replace the image files directly in the file system or use Xcode.
Option 1: File System
Replace the existing image files located in the example/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory with your own assets.
Option 2: Xcode (Recommended for visual management)
open ios/Runner.xcworkspace.Runner/Assets.xcassets.LaunchImage asset set and drag/drop your desired images into it.open ios/Runner.xcworkspaceThe FlutterSoundHelper is a singleton utility class used for handling audio files and buffers, specifically for converting between WAVE and Raw PCM formats. You can access it using the FlutterSoundHelper() factory constructor.
It also includes a built-in logger for debugging, which can be configured using setLogLevel(Level theNewLogLevel).
// Access the singleton
var helper = FlutterSoundHelper();
// Configure logging
helper.setLogLevel(Level.info);
// Use the logger
helper.logger.d('An information');The recorder follows a specific state machine. You must manage its lifecycle to avoid resource leaks or errors.
openRecorder({bool isBGService = false}): Must be called before any recording operations. If isBGService is true, it configures the recorder for background service use.closeRecorder(): Releases all system resources and deletes temporary files created during recording. Always call this when the recorder is no longer needed (e.g., in a Flutter dispose() method).isRecording / isStopped / isPaused: Boolean getters to check the current recorderState.Important: If you are using a widget, ensure you clean up the recorder to prevent memory leaks and device resource locking.
@override
void dispose() {
if (myRecorder != null) {
myRecorder!.closeRecorder();
myRecorder = null;
}
super.dispose();
}The RecordingDisposition class holds real-time details about an active recording. You can access these details by subscribing to the dispositionStream (available on the recorder instance).
It provides:
duration: The total duration of the recording at that point in time.decibels: The volume of the audio being captured (ranges from 0 to 120).// Example of how RecordingDisposition is structured
final disposition = RecordingDisposition(Duration(seconds: 5), 85.0);
print(disposition.toString()); // 'duration: 0:00:05.000000 decibels: 85.0'
// Use the zero constructor for initial StreamBuilder values
final initialValue = RecordingDisposition.zero();The FlutterSoundRecorder class allows you to record audio to either a file or a Dart stream.
FlutterSoundRecorder instance.openRecorder() to initialize the recorder and acquire system resources.startRecorder() specifying a destination (file or stream).pauseRecorder() and resumeRecorder() to manage the recording state.stopRecorder() to finish recording and retrieve the file URL.closeRecorder() to release resources. It is highly recommended to call this in your widget's dispose() method.toFile in startRecorder().StreamSink via toStream, toStreamFloat32, or toStreamInt16 in startRecorder().// 1. Instantiate
FlutterSoundRecorder myRecorder = FlutterSoundRecorder();
// 2. Open
await myRecorder.openRecorder();
// 3. Start recording to a file
await myRecorder.startRecorder(toFile: 'path/to/recording.aac', codec: Codec.aacADTS);
// 4. Stop recording
String? url = await myRecorder.stopRecorder();
print('Recorded file at: $url');
// 5. Close
await myRecorder.closeRecorder();A FlutterSoundPlayer is an object used to play audio from various sources including files, remote URLs, internal buffers, or Dart streams. You can have multiple instances of the player running simultaneously, each controlling its own source.
FlutterSoundPlayer().openPlayer() to allocate system resources.startPlayer() to begin playback.pausePlayer(), resumePlayer(), or setVolume() (available in subsequent segments).stopPlayer() to end playback.closePlayer() to free all resources. This will automatically call stopPlayer() if necessary.FlutterSoundPlayer myPlayer = FlutterSoundPlayer();
await myPlayer.openPlayer();
// ... play audio ...
await myPlayer.closePlayer();Flutter Sound is published under the MPL-2.0 License (Mozilla Public License 2.0).