Skip to content

Repository files navigation

Audio recorder from microphone to a given file path or stream.

No external dependencies:

  • On Android, AudioRecord and MediaCodec.
  • On iOS and macOS, AVFoundation.
  • On Windows, MediaFoundation.
  • On web, well... your browser! (and its underlying platform).

External dependencies:

  • On linux, encoding is provided by fmedia. It must be installed separately.

Platform feature parity matrix

FeatureAndroidiOSwebWindowsmacOSlinux
pause/resume✔️✔️✔️✔️✔️✔️
amplitude(dBFS)✔️✔️✔️✔️✔️
permission check✔️✔️✔️✔️
num of channels✔️✔️✔️✔️✔️✔️
device selection(auto BT/mic)✔️✔️✔️✔️
auto gain✔️(always active?)✔️
echo cancel✔️✔️
noise suppresion✔️✔️

Bluetooth is not supported on Android at this time.

File

EncoderAndroidiOSwebWindowsmacOSlinux
aacLc✔️✔️?✔️✔️✔️
aacEld✔️✔️?✔️
aacHe✔️?✔️
amrNb✔️?✔️
amrWb✔️?
opus✔️✔️✔️
wav✔️✔️✔️✔️✔️✔️
flac✔️✔️?✔️✔️✔️
pcm16bits✔️✔️✔️✔️✔️

* Question marks (?) in web column mean that the formats are supported by the plugin but are not available in current (and tested) browsers (Chrome / Firefox).

Stream

EncoderAndroidiOSwebWindowsmacOSlinux
aacLc *✔️
aacEld *✔️
aacHe *✔️
pcm16bits✔️✔️✔️✔️✔️

* AAC is streamed with raw AAC with ADTS headers, so it's directly readable through a file!

All audio output is with 16bits depth.

Usage

import'package:record/record.dart';
final record =AudioRecorder();
// Check and request permission if neededif (await record.hasPermission()) {
// Start recording to fileawait record.start(constRecordConfig(), path:'aFullPath/myFile.m4a');
// ... or to streamfinal stream =await record.startStream(constRecordConfig(AudioEncoder.pcm16bits));
}
// Stop recording...final path =await record.stop();
// ... or cancel it (and implicitly remove file/blob).await record.cancel();
record.dispose(); // As always, don't forget this one.

Setup, permissions and others

Android

<uses-permissionandroid:name="android.permission.RECORD_AUDIO" />
  • min SDK: 21 (amrNb/amrWb: 26, Opus: 29)

Bluetooth Microphone

Use bluetooth microphone recording

const config =RecordConfig(encoder: encoder, numChannels:1, bluetoothSco:true); // bluetoothSco set true

*this only for Android . for iOS will automatically use bluetooth if device already connected with iPhone/iPad

You SHOULD add this in you main application (see example) : (Android - AndroidManifest.xml)

<uses-permissionandroid:name="android.permission.MODIFY_AUDIO_SETTINGS" />

(iOS - Info.plist)

 <key>UIBackgroundModes</key>
<array>
<string>audio</string>
</array>

iOS

<key>NSMicrophoneUsageDescription</key>
<string>Some message to describe why you need this permission</string>
  • min SDK: 11.0

macOS

<key>NSMicrophoneUsageDescription</key>
<string>Some message to describe why you need this permission</string>
  • In capabilities, activate "Audio input" in debug AND release schemes.
  • or directly in *.entitlements files
<key>com.apple.security.device.audio-input</key>
<true/>
  • min SDK: 10.15

About

Audio recorder from microphone to a given file path. No external dependencies, MediaRecorder is used for Android an AVAudioRecorder for iOS.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages