Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ZaraclaJ/audio_recorder


https://github.com/ZaraclaJ/audio_recorder

android audio-recorder awesome flutter ios mobile plugin

Last synced: about 2 months ago
JSON representation

Lists

README

        

# Audio recorder

[![pub package](https://img.shields.io/pub/v/audio_recorder.svg)](https://pub.dartlang.org/packages/audio_recorder)
[![Build Status](https://travis-ci.org/mmcc007/audio_recorder.svg?branch=master)](https://travis-ci.org/mmcc007/audio_recorder)
[![Coverage Status](https://coveralls.io/repos/github/mmcc007/audio_recorder/badge.svg?branch=master)](https://coveralls.io/github/mmcc007/audio_recorder?branch=master)

Record audio and store it locally

## Usage
To use this plugin, add `audio_recorder` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).

### Android
Make sure you add the following permissions to your Android Manifest
```

```

### iOS
Make sure you add the following key to Info.plist for iOS
```
NSMicrophoneUsageDescription
Record audio for playback
```

## Example
``` dart
// Import package
import 'package:audio_recorder/audio_recorder.dart';

// Check permissions before starting
bool hasPermissions = await AudioRecorder.hasPermissions;

// Get the state of the recorder
bool isRecording = await AudioRecorder.isRecording;

// Start recording
await AudioRecorder.start(path: _controller.text, audioOutputFormat: AudioOutputFormat.AAC);

// Stop recording
Recording recording = await AudioRecorder.stop();
print("Path : ${recording.path}, Format : ${recording.audioOutputFormat}, Duration : ${recording.duration}, Extension : ${recording.extension},");

```

### Encoding format
For now, the plugin only use the AAC compression to encode audio.
You can specify the extension of the output audio file in the file path that you give to the start method.
The recognized extensions are :
- .m4a
- .mp4
- .aac

If the file path does not finish with these extensions, the ".m4a" extension is added by default.

### Exceptions
The start method raise an exception if :
- A file already exists at the given file path
- The parent directory of the file path does not exist

## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).