Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jfversluis/Plugin.Maui.Audio
Plugin.Maui.Audio provides the ability to play audio inside a .NET MAUI application
https://github.com/jfversluis/Plugin.Maui.Audio
android audio-player dotnet-maui hacktoberfest ios macos maui windows
Last synced: 3 months ago
JSON representation
Plugin.Maui.Audio provides the ability to play audio inside a .NET MAUI application
- Host: GitHub
- URL: https://github.com/jfversluis/Plugin.Maui.Audio
- Owner: jfversluis
- License: mit
- Created: 2022-08-18T10:16:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T16:24:41.000Z (5 months ago)
- Last Synced: 2024-07-04T08:24:55.405Z (4 months ago)
- Topics: android, audio-player, dotnet-maui, hacktoberfest, ios, macos, maui, windows
- Language: C#
- Homepage:
- Size: 12.5 MB
- Stars: 245
- Watchers: 10
- Forks: 38
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-dotnet-maui - Plugin.Maui.Audio - square)](https://github.com/jfversluis/Plugin.Maui.Audio/stargazers)|[](https://github.com/jfversluis/Plugin.Maui.Audio/commits) (Plugins)
README
# Plugin.Maui.Audio
`Plugin.Maui.Audio` provides the ability to play and record audio inside a .NET MAUI application.
## Getting Started
* Available on NuGet: [](https://www.nuget.org/packages/Plugin.Maui.Audio/)
## API Usage
`Plugin.Maui.Audio` provides the `AudioManager` class that allows for the creation of [`AudioPlayer`s](docs/audio-player.md) and [`AudioRecorder`s](docs/audio-recording.md). The `AudioManager` can be used with or without dependency injection.
### `AudioManager`
There are two different ways in which you can interact with the `AudioManager` implementation provided by this plugin, they are:
#### Dependency Injection
You will first need to register the `AudioManager` with the `MauiAppBuilder` based on the following example:
```csharp
builder.AddAudio();
```
> [!NOTE]
> You can also customize the shared settings for both audio [playback](./docs/audio-player.md#configure-the-playback-options) and [recording](./docs/audio-recorder.md#configure-the-recording-options).
You can then enable your classes to depend on `IAudioManager` as per the following example.
```csharp
public class AudioPlayerViewModel
{
readonly IAudioManager audioManager;
public AudioPlayerViewModel(IAudioManager audioManager)
{
this.audioManager = audioManager;
}
public async void PlayAudio()
{
var audioPlayer = audioManager.CreatePlayer(await FileSystem.OpenAppPackageFileAsync("ukelele.mp3"));
audioPlayer.Play();
}
}
```
#### Straight usage
Alternatively if you want to skip using the dependency injection approach you can use the `AudioManager.Current` property.
```csharp
public class AudioPlayerViewModel
{
public async void PlayAudio()
{
var audioPlayer = AudioManager.Current.CreatePlayer(await FileSystem.OpenAppPackageFileAsync("ukelele.mp3"));
audioPlayer.Play();
}
}
```
Now that you know how to use the `AudioManager` class, please refer to the following sections:
* [Audio playback](docs/audio-player.md)
* [Record audio](docs/audio-recorder.md)
## Acknowledgements
This project could not have came to be without these projects and people, thank you! <3
## SimpleAudioPlayer for Xamarin
Basically this plugin, but then for Xamarin. We have been using this in our Xamarin projects with much joy and ease, so thank you so much [Adrian](https://github.com/adrianstevens) (and contributors!) for that. Find the original project [here](https://github.com/adrianstevens/Xamarin-Plugins/tree/main/SimpleAudioPlayer) where we have based our project on and evolved it from there.
## The Happy Ukelele Song
As a little sample song we wanted something Hawaii/Maui themed obviously, and we found The Happy Ukelele Song which seems to fit that description. Thank you [Stanislav Fomin](https://download1.audiohero.com/artist/597084) and [AudioHero](https://download1.audiohero.com/track/40778468) for making it available.