flutter_audio_recorder4 #

English

Flutter Audio Record 4 Plugin that supports Record Pause Resume Stop and provide access to audio level metering properties average power peak power

Derived from Flutter Audio Recorder 1/2/3. Initial reasons for new repo:

• Other repos not updating with the times
• Fix the following Android warning: The plugin flutter_audio_recorder3 uses a deprecated version of the Android embedding. To avoid unexpected runtime failures, or future build failures, try to see if this plugin supports the Android V2 embedding. Otherwise, consider removing it since a future release of Flutter will remove these deprecated APIs. If you are plugin author, take a look at the docs for migrating the plugin to the V2 embedding: https://flutter.dev/go/android-plugin-migration.
• Fix Android Gradle plugin error on Mac Sonoma: The Android Gradle plugin supports only Kotlin Gradle plugin version 1.5.20 and higher. The following dependencies do not satisfy the required version: project ':flutter_audio_recorder3' -> org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.50

Works for both Android and iOS

Installation #

add flutter_audio_recorder4 to your pubspec.yaml

iOS Permission #

1. Add usage description to Info.plist

<key>NSMicrophoneUsageDescription</key>
<string>Can We Use Your Microphone Please</string>

2. Then use hasPermission api to ask user for permission when needed

Android Permission #

1. Add uses-permission to ./android/app/src/main/AndroidManifest.xml in xml root level like below

    ...
    </application>
    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    ...
</manifest>

2. Then use hasPermission api to ask user for permission when needed

Configuration #

iOS Deployment Target is 8.0 above

Android

• AndroidX: use latest version (0.5.x)
• Legacy Android: use old version (0.4.9)

Usage #

Recommended API Usage: hasPermission => init > start -> (pause <-> resume) * n -> stop, call init again before start another recording

Always check permission first(it will request permission if permission has not been set to true/false yet, otherwise it will return the result of recording permission)

bool hasPermission = await FlutterAudioRecorder4.hasPermissions;

Initialize (run this before start, so we could check if file with given name already exists)

var recorder = FlutterAudioRecorder4("file_path.mp4"); // .wav .aac .m4a
await recorder.initialized;

or

var recorder = FlutterAudioRecorder4("file_path", audioFormat: AudioFormat.AAC); // or AudioFormat.WAV
await recorder.initialized;

Sample Rate

var recorder = FlutterAudioRecorder4("file_path", audioFormat: AudioFormat.AAC, sampleRate: 22000); // sampleRate is 16000 by default
await recorder.initialized;

Audio Extension and Format Mapping

Start recording

await recorder.start();
var recording = await recorder.current(channel: 0);

Get recording details

var current = await recording.current(channel: 0);
// print(current.status);

You could use a timer to access details every 50ms(simply cancel the timer when recording is done)

new Timer.periodic(tick, (Timer t) async {
        var current = await recording.current(channel: 0);
        // print(current.status);
        setState(() {
        });
      });

Recording

Recording.metering

Recording.status

Unset,Initialized,Recording,Paused,Stopped

Pause

await recorder.pause();

Resume

await recorder.resume();

Stop (after stop, run init again to create another recording)

var result = await recorder.stop();
File file = widget.localFileSystem.file(result.path);

Example #

Please check example app using Xcode.

Getting Started #

This project is a starting point for a Flutter plug-in package, a specialized package that includes platform-specific implementation code for Android and/or iOS.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.