flutter_sound
This plugin provides simple recorder and player functionalities for both `android` and `ios` platforms. This only supports default file extension for each platform. This plugin handles file from remote url. This plugin can handle playback stream from native (To sync exact time with bridging).
Install
Add flutter_sound as a dependency in pubspec.yaml For help on adding as a dependency, view the documentation.
Post Installation
On iOS you need to add a usage description to info.plist:
<key>NSMicrophoneUsageDescription</key> <string>This sample uses the microphone to record your speech and convert it to text.</string> <key>UIBackgroundModes</key> <array> <string>audio</string> </array>
On Android you need to add a permission to AndroidManifest.xml:
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
Methods
| Func | Param | Return | Description |
|---|---|---|---|
| setSubscriptionDuration | double sec |
Stringmessage |
Set subscription timer in seconds. Default is 0.01if not using this method. |
| startRecorder | String uri, int sampleRate, int numChannels |
Stringuri |
Start recording. This will return uri used. |
| stopRecorder | Stringmessage |
Stop recording. | |
| startPlayer | String uri |
Stringmessage |
Start playing. |
| stopPlayer | Stringmessage |
Stop playing. | |
| pausePlayer | Stringmessage |
Pause playing. | |
| resumePlayer | Stringmessage |
Resume playing. | |
| seekToPlayer | int milliSecsposition to goTo |
Stringmessage |
Seek audio to selected position in seconds. Parameter should be less than audio duration to correctly placed. |
Subscriptions
| Subscription | Return | Description |
|---|---|---|
| onRecorderStateChanged | <RecordStatus> |
Able to listen to subscription when recorder starts. |
| onPlayerStateChanged | <PlayStatus> |
Able to listen to subscription when player starts. |
Default uri path
When uri path is not set during the function call in startRecorder or startPlayer, they are saved in below path depending on the platform.
- Default path for android
- sdcard/sound.mp4.
- Default path for ios
- sound.m4a.
Usage
Creating instance.
FlutterSound flutterSound = new FlutterSound();
Starting recorder with listener.
String path = await flutterSound.startRecorder(null);
print('startRecorder: $path');
_recorderSubscription = flutterSound.onRecorderStateChanged.listen((e) {
DateTime date = new DateTime.fromMillisecondsSinceEpoch(e.currentPosition.toInt());
String txt = DateFormat('mm:ss:SS', 'en_US').format(date);
});
Stop recorder
String result = await flutterSound.stopRecorder();
print('stopRecorder: $result');
if (_recorderSubscription != null) {
_recorderSubscription.cancel();
_recorderSubscription = null;
}
Start player
String path = await flutterSound.startPlayer(null);
print('startPlayer: $path');
_playerSubscription = flutterSound.onPlayerStateChanged.listen((e) {
if (e != null) {
DateTime date = new DateTime.fromMillisecondsSinceEpoch(e.currentPosition.toInt());
String txt = DateFormat('mm:ss:SS', 'en_US').format(date);
this.setState(() {
this._isPlaying = true;
this._playerTxt = txt.substring(0, 8);
});
}
});
Stop player
String result = await flutterSound.stopPlayer();
print('stopPlayer: $result');
if (_playerSubscription != null) {
_playerSubscription.cancel();
_playerSubscription = null;
}
Pause player
String result = await flutterSound.pausePlayer();
Resume player
String result = await flutterSound.resumePlayer();
Seek player
String result = await flutterSound.seekToPlayer(miliSecs);
Setting subscription duration (Optional). 0.01 is default value when not set.
/// 0.01 is default
flutterSound.setSubscriptionDuration(0.01);
Setting volume.
/// 1.0 is default
/// Currently, volume can be changed when player is running. Try manage this right after player starts.
String path = await flutterSound.startPlayer(null);
await flutterSound.setVolume(0.1);
Using the amplitude meter
The amplitude meter allows displaying a basic representation of the input sound. When enabled, it returns values ranging 0-120dB.
//// By default this option is disabled, you can enable it by calling
setDbLevelEnabled(true);
//// You can tweak the frequency of updates by calling this function (unit is seconds)
updateDbPeakProgress(0.8);
//// You need to subscribe in order to receive the value updates
_dbPeakSubscription = flutterSound.onRecorderDbPeakChanged.listen((value) {
setState(() {
this._dbLevel = value;
});
});
TODO
- Seeking example in
Exmapleproject - Volume Control
- Sync timing for recorder callback handler
Credit (github url) : https://github.com/dooboolab/flutter_sound
Next Article : https://flutterappdev.com/2019/01/31/a-google-analytics-wrapper-for-command-line-web-and-flutter-apps/
