Plugin.Maui.Audio 4.0.0-preview2

Plugin.Maui.Audio

Plugin.Maui.Audio provides the ability to play, record and stream audio inside a .NET MAUI application.

Getting Started

• Available on NuGet: http://www.nuget.org/packages/Plugin.Maui.Audio

API Usage

Plugin.Maui.Audio provides the AudioManager class that allows for the creation of AudioPlayers and AudioRecorders and AudioStreamers. 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:

builder.AddAudio();

[!NOTE]
You can also customize the shared settings for both audio playback and recording.

You can then enable your classes to depend on IAudioManager as per the following example.

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.

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
• Record audio
• Stream audio
• Audio listeners

Supported Audio Formats

Audio Playback

The audio formats supported for playback depend on the underlying platform:

The audio file format is determined automatically based on the file extension or stream content.

Audio Recording

Recording capabilities vary by platform with the following supported encoding formats:

PCM Audio Details

When recording or streaming PCM audio (WAV format):

• Sample Rates:
  • Android: 44100Hz is recommended and most widely supported
  • iOS/macOS: 48000Hz is recommended
  • Customizable in all platforms (8000Hz, 16000Hz, etc.)
• Channels:
  • Mono (1 channel) and Stereo (2 channels) supported on all platforms
  • Mono is recommended for maximum compatibility
• Bit Depth:
  • 8-bit and 16-bit PCM supported (16-bit recommended)
  • Windows streaming supports only 16-bit PCM

Acknowledgements

This project could not have came to be without these projects and people, thank you! ❤️

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 (and contributors!) for that. Find the original project here 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 and AudioHero for making it available.