dotnet add package NetCoreAudio --version 2.0.0
NuGet\Install-Package NetCoreAudio -Version 2.0.0
<PackageReference Include="NetCoreAudio" Version="2.0.0" />
paket add NetCoreAudio --version 2.0.0
#r "nuget: NetCoreAudio, 2.0.0"
// Install NetCoreAudio as a Cake Addin
// Install NetCoreAudio as a Cake Tool
The library allows playback of audio files on .NET on any supported operating system (Windows, macOS, Linux) and any CPU architecture (AMD, ARM, etc.) with minimal dependencies.
The library can be downloaded and installed like any other NuGet package. On Windows, there are no further prerequisites, as it depends entirely on OS components for its functionality. On other operating systems, however, additional utilities may have to be installed before the library can fully function.
On Mac, the library depends on afplay for its audio playback functionality, which should already be included in the operating system.
However, for audio recording functionality, we need to install the ffmpeg tool.
Linux implementation depends on ALSA architecture. Therefore, the machine needs to have the following utilities installed, which may or may not be included in the distro:
- aplay for audio playback (excluding MP3 files)
- amixer for setting the volume
- arecord for recording audio
In addition to this, we need mpg123 to be able to play MP3 files on Linux.
The library can play and record audio. It will automatically detect which OS it's running on and will activate the components specific to this OS.
Below is the description of its public API:
Audio Playback Functionality
For audio playback, the library exposes the
Player class for audio playback, which detects the OS the library is running on and abstracts away any OS-specific audio playback implementations.
The class contains the following properties:
bool Playing: Indicates that the audio is currently playing.
bool Paused: Indicates that the audio playback is currently paused.
It also has the following methods:
Task Play(string fileName): Will stop any current playback and will start playing the specified audio file. The fileName parameter can be an absolute path or a path relative to the directory where the library is located. Sets the
Playingflag to true. Sets the
Pausedflag to false.
Task Pause(): Pauses any ongoing playback. Sets Paused flag to true. Doesn't modify the
Task Resume(): Resumes any paused playback. Sets the
Pausedflag to false. Doesn't modify the
Task Stop(): Stops any current playback and clears the buffer. Sets the
Pausedflags to false. Stopped playback cannot be resumed. If the same file needs to be played again, it can only be played from the beginning.
Task SetVolume(): Sets the playing volume as percentage.
The class also has the following event handler:
EventHandler PlaybackFinished: Internally, sets the
Playingflag to false. Additional handlers can be attached to it to handle any custom logic.
Audio Recording Functionality
For audio recording, we use the
Recorder class. The class contains the following properties:
bool Recording: Indicates that the audio is currently being recorded.
Task Record(string fileName): Begins the recording into the specified audio file.
Task Stop(): Stops the recording ans saves the data into the file specified previously.
Contact and support
If you want to support me and my work, you can do so via this page.
If you want my help integrating this library with your software or making any bespoke changes to it to meet your needs, you can book my time via this page.
For any other queries, you can get in touch with me via LinkedIn.
|Versions Compatible and additional computed target framework versions.
|net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
|netcoreapp3.0 was computed. netcoreapp3.1 was computed.
|netstandard2.1 is compatible.
|monoandroid was computed.
|monomac was computed.
|monotouch was computed.
|tizen60 was computed.
|xamarinios was computed.
|xamarinmac was computed.
|xamarintvos was computed.
|xamarinwatchos was computed.
- No dependencies.
NuGet packages (2)
Showing the top 2 NuGet packages that depend on NetCoreAudio:
Do not use reference this package directly. Use this meta package: https://www.nuget.org/packages/Aximo Aximo Game Engine is an Open Source Game Engine written purly in C#. Documentation: https://www.aximo.games Source: https://github.com/AximoGames/AxEngine
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on NetCoreAudio:
Handy tools for managing my live stream, built with ASP.NET Core