Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nightlybuilds-net/nightly.xam.audiorecorder
Xamarin Forms audio recorder library
https://github.com/nightlybuilds-net/nightly.xam.audiorecorder
Last synced: 3 months ago
JSON representation
Xamarin Forms audio recorder library
- Host: GitHub
- URL: https://github.com/nightlybuilds-net/nightly.xam.audiorecorder
- Owner: nightlybuilds-net
- License: mit
- Created: 2021-03-19T07:22:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-04T20:31:11.000Z (over 3 years ago)
- Last Synced: 2024-07-06T05:01:05.468Z (4 months ago)
- Language: C#
- Size: 188 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-xamarin-forms - nightly.xam.audiorecorder ★7
README
# nightly.xam.audiorecorder
## _Xamarin Forms Audio Recorder Library_
## Features
- Ultra easy to use
- Task-based asynchronous pattern
- Register compressed audio
- Highly customizable
- Not enought??
## Installation
Add nighlty.xam.audiorecorder nuget package to forms and native (iOS and Droid) apps [HERE]("https://www.nuget.org/packages/nightly.xam.audiorecorder/")
```sh
dotnet add package nightly.xam.audiorecorder
```
## Usage
[See Sample project in this repo.]("https://github.com/nightlybuilds-net/nightly.xam.audiorecorder/tree/main/nightly.xam.audiorecorder/nightly.xam.audiorecorder.forms")
Just create a record service:
```sh
this._recordService = new NightlyRecorderService();
```
Start record audio:
```sh
var streamFile = await this._recordService.RecordAsync();
this._stream = streamFile;
```
Stop Record
```sh
this._recordService.Stop();
```
**Isn't it easy?**
The default output stream is MP4 AAR.
You can easily customize SampleRate in this way:
```sh
this._recordService = new RecorderSettings.Default.WithSampleRate(SampleRate.Low);
```
or you can use others ready to use configurations in this way:
```sh
this._recordService = new NightlyRecorderService(new RecorderSettings
{
IosRecorderSettings = new IosAppleLossLess(),
DroidRecorderSettings = new DroidOggOpus()
});
```
## Permission
This library doesn't manage permission for record audio from device MIC.
I Suggest you to use Xamarin Essentials Permission API like this:
```sh
var status = await Permissions.CheckStatusAsync();
if (status != PermissionStatus.Granted)
{
status = await Permissions.RequestAsync();
if (status != PermissionStatus.Granted)
{
await this.DisplayAlert("Alert","you need pemrission to mic", "ok");
return;
}
}
```
## API
You can customize iOS and Android record settings implementing the following interfaces
```sh
public interface IIosRecorderSettings
{
IosAudioFormat AudioFormat { get; set; }
double? SampleRate { get; set; }
int? NumberChannels { get; set; }
int? LinearPcmBitDepth { get; set; }
bool? LinearPcmBigEndian { get; set; }
bool? LinearPcmFloat { get; set; }
bool? LinearPcmNonInterleaved { get; set; }
IosAudioQuality? AudioQuality { get; set; }
IosAudioQuality? SampleRateConverterAudioQuality { get; set; }
int? EncoderBitRate { get; set; }
int? EncoderBitRatePerChannel { get; set;}
int? EncoderBitDepthHint { get; set; }
}
public interface IDroidRecorderSettings
{
DroidAudioEncoder AudioEncoder { get; }
DroidOutPutFormat OutPutFormat { get; }
int? SamplingRate { get; set; }
int? AudioChannels { get; set; }
int? CaptureRate { get; set; }
int? AudioEncodingBitRate { get; set; }
}
```
After implementing those interfaces you can create a record service:
```sh
this._recordService = new NightlyRecorderService(new RecorderSettings
{
IosRecorderSettings = new YourIosImplementation(),
DroidRecorderSettings = new YourDroidImplementation()
});
```
## OOB Record Configuration
There are some ready to use implementation:
**iOS**
- IosAppleLossLess
- IosFlac
- IosMp4Aar
**Droid**
- Droid3GppAar
- DroidOggOpus
- DroidMp4Aar
## License
MIT
**Free Software, Hell Yeah!**