Record or stream audio input

This recipe demonstrates how to use the record package to add audio recording and streaming capabilities to your Flutter app. To get started using the package, follow these steps:

To add package:record as a dependency, use flutter pub add:

$ flutter pub add record

Initialize an AudioRecorder object. This is the primary object that controls the recording process.

import 'package:record/record.dart';
​
final recorder = AudioRecorder();

Before recording, you need to request user permission. You might also need to add platform-specific permission configurations. Refer to the record package documentation for details.

final recorder = AudioRecorder();
if (await recorder.hasPermission()) {
  // Permission granted, proceed with recording.
} else {
  // Permission denied.
}

Create and configure a RecordConfig object to specify the record settings, such as the encoder, sample rate, and channel number. You can also enable features like auto gain, echo cancellation, and noise suppression.

final recordConfig = RecordConfig(
  encoder: AudioEncoder.pcm16bits,
  sampleRate: 24000,
  numChannels: 1,
  autoGain: true,
  echoCancel: true,
  noiseSuppress: true,
);

To start recording to a file, call the start method on the AudioRecorder, passing in the recordConfig you defined and the path where the file should be stored.

// TODO: Specify the path where the audio file should be saved.
final audioFilePath = 'myRecording.wav';
await recorder.start(recordConfig, path: audioFilePath);

You can control an ongoing recording using the pause, resume, and stop methods on the AudioRecorder.

await recorder.pause();
await recorder.resume();
await recorder.stop();

To stream audio, use the startStream method. This returns a stream of audio data.

final stream = await recorder.startStream(recordConfig);
stream.listen((audioChunk) {
  // Process the audio data. For example, send it to a server.
});

To stop the recording and get the path to the saved file, call the asynchronous stop method on the AudioRecorder.

final path = await recorder.stop();
print('Recording stopped. File saved to: $path');

When you are finished using the AudioRecorder, remember to call its dispose method to release its resources.

await recorder.dispose();

The record package supports various encoders and file formats, but support varies by platform. For the full list of supported encoders per platform, check out the package's encoding support table.

For more detailed information and examples, visit the record package page on pub.dev or check out the record Package of the Week video.