AudioWorks.Api 2.0.0

dotnet add package AudioWorks.Api --version 2.0.0                
NuGet\Install-Package AudioWorks.Api -Version 2.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AudioWorks.Api" Version="2.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AudioWorks.Api --version 2.0.0                
#r "nuget: AudioWorks.Api, 2.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AudioWorks.Api as a Cake Addin
#addin nuget:?package=AudioWorks.Api&version=2.0.0

// Install AudioWorks.Api as a Cake Tool
#tool nuget:?package=AudioWorks.Api&version=2.0.0                

About

This is the public API for AudioWorks, a cross-platform, multi-format audio conversion and tagging suite.

You should also consume one or more "Extensions" packages (see Related Packages below) for full functionality.

More documentation is available on the GitHub repository.

How to Use

Encode some files

var flacFiles = new DirectoryInfo("<path to an album>")
    .GetFiles("*.flac")
    .Select(file => new TaggedAudioFile(file.FullName));

// Export the files to Opus format, organized into directories and named according to metadata
var opusEncoder = new AudioFileEncoder("Opus")
{
    EncodedDirectoryName = @"C:\Output\{Album} by {Artist}",
    EncodedFileName = "{TrackNumber} - {Title}",
    Overwrite = true,
    Settings = new()
    {
        ["SignalType"] = "Speech",
        ["BitRate"] = 32
    }
};
await opusEncoder.EncodeAsync(flacFiles);

Set metadata (tags)

var flacFiles = new DirectoryInfo("<path to an album>")
    .GetFiles("*.flac")
    .Select(file => new TaggedAudioFile(file.FullName));

// Add ReplayGain tags, analyzing the files as a single album
var replayGainAnalyzer = new AudioFileAnalyzer("ReplayGain");
await replayGainAnalyzer.AnalyzeAsync(flacFiles);

// Set the artist as well, then persist the new tags to disk
foreach (var flacFile in flacFiles)
{
    flacFile.Metadata.Artist = "Iron Butterfly";
    flacFile.SaveMetadata();
}

Key Features

  • Supports MP3, MP4 AAC, FLAC, Apple Lossless (ALAC), Opus, Ogg Vorbis and Wave formats
  • High performance architecture
  • Runs on Windows, Linux and MacOS

Main Types

The main types provided by this library are:

  • TaggedAudioFile
  • AudioFileEncoder
  • AudioFileAnalyzer
  • CoverArtExtractor

Extensions providing audio formats

Extensions providing analysis

Feedback

AudioWorks is released as open source under the GNU Affero General Public License. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 15 2/25/2025
1.2.0 861 12/7/2021
1.1.0 679 11/16/2020
1.0.0 587 8/5/2020
1.0.0-beta9 368 7/8/2020
1.0.0-beta8 402 2/12/2020