# record

**Repository Path**: flutter-assembly/record

## Basic Information

- **Project Name**: record
- **Description**: 将录音依赖库record 4.4.4放到当前插件，对android部分增加service 将录音功能放到其中 并且发起录音中的通知，增加存活率
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-06
- **Last Updated**: 2024-12-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Audio recorder from microphone to a given file path.  

No external dependencies:

- On Android, MediaRecorder is used.  
- On iOS, AVAudioRecorder is used.  
- On macOS, AVCaptureSession is used.  
- On web, well... your browser!

External dependencies:
- On Windows and linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/).  
- On linux, fmedia must be installed separately.

## Options
- bit rate (where applicable)
- sampling rate
- encoder
- Number of channels
- Input device selection

## Platforms

### Android
```xml
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<!-- Optional, you'll have to check this permission by yourself. -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
```
- min SDK: 19 (maybe higher => encoder dependent)

### iOS
```xml
<key>NSMicrophoneUsageDescription</key>
<string>We need to access to the microphone to record audio file</string>
```
- min SDK: 11.0

### macOS
```xml
<key>NSMicrophoneUsageDescription</key>
<string>We need to access to the microphone to record audio file</string>
```

- In capabilities, activate "Audio input" in debug AND release schemes

- min SDK: 10.15

## Platform feature parity matrix
| Feature          | Android        | iOS             | web     | Windows    | macOS  | linux
|------------------|----------------|-----------------|---------|------------|-------|-----------
| pause/resume     | ✔️             |   ✔️           | ✔️     |      ✔️    | ✔️    |  ✔️
| amplitude(dBFS)  | ✔️             |   ✔️           |         |            |  ✔️   |
| permission check | ✔️             |   ✔️           |  ✔️    |            |  ✔️   |
| num of channels  | ✔️             |   ✔️           |  ✔️    |    ✔️      |  ✔️   |  ✔️
| device selection |                | (auto BT/mic)   |  ✔️    |    ✔️      |  ✔️   |  ✔️


| Encoder         | Android        | iOS     | web     | Windows | macOS   | linux
|-----------------|----------------|---------|---------|---------|---------|---------
| aacLc           | ✔️            |   ✔️    |  ?      |   ✔️    |  ✔️    |  ✔️ 
| aacEld          | ✔️            |   ✔️    |  ?      |         |  ✔️    | 
| aacHe           | ✔️            |   ✔️    |  ?      |   ✔️    |  ✔️    |  ✔️ 
| amrNb           | ✔️            |   ✔️    |  ?      |         |  ✔️    |  
| amrWb           | ✔️            |   ✔️    |  ?      |          |  ✔️   |  
| opus            | ✔️            |   ✔️    |  ?      |   ✔️    |  ✔️    |  ✔️ 
| vorbisOgg       | ?(optional)   |          |  ?      |  ✔️     |        |   ✔️  
| wav             |  ✔️           |         |  ?      |   ✔️     |        |   ✔️ 
| flac            |               |    ✔️    |  ?      |  ✔️     |   ✔️  |   ✔️
| pcm8bit         | ✔️            |   ✔️    |  ?      |          |  ✔️   |  
| pcm16bit        | ✔️            |   ✔️    |  ?      |          |  ✔️   |  

For every encoder, you should be really careful with given sampling rates.
For example, opus could or could not be recorded at 44100Hz.

If a given encoder is not supported when starting recording on platform, the fallbacks are:  

| Platform    | encoder                                                      
|-------------|--------------------------------------------------------------
| Android     | AAC LC                                                       
| iOS         | AAC LC                                                       
| web         | OPUS OGG (not guaranteed => choice is made by the browser)   
| Windows     | AAC LC                                                       
| macOS       | AAC LC                                                       
| linux       | AAC LC                                                       

## Encoding API levels documentation
### Android
* [MediaRecorder encoding constants](https://developer.android.com/reference/android/media/MediaRecorder.AudioEncoder)
* [Audio formats sample rate hints](https://developer.android.com/guide/topics/media/media-formats#audio-formats)

### iOS
* [AVAudioRecorder encoding constants](https://developer.apple.com/documentation/coreaudiotypes/coreaudiotype_constants/1572096-audio_data_format_identifiers)

## Usage
```dart
// Import package
import 'package:record/record.dart';

final record = Record();

// Check and request permission
if (await record.hasPermission()) {
  // Start recording
  await record.start(
    path: 'aFullPath/myFile.m4a',
    encoder: AudioEncoder.aacLc, // by default
    bitRate: 128000, // by default
    sampleRate: 44100, // by default
  );
}

// Get the state of the recorder
bool isRecording = await record.isRecording();

// Stop recording
await record.stop();
```

## Warnings
Be sure to check supported values from the given links above.

## Roadmap
- Allow to choose the capture device.
- Format vs. container accuracy.
- Bug fixes.