# nx_audio v0.3.2 - Table of Contents

> NxAudio is a analogous implementation for the python torchaudio library for NX

## Pages

- [Introduction](readme.md)
- [Changelog](changelog.md)
- [Spectrogram Visualizations](visualizations.md)
- [License](license.md)

## Modules

- [NxAudio](NxAudio.md): # NxAudio
- [NxAudio.IO.Encoding](NxAudio.IO.Encoding.md): Represents the supported audio encodings

- [NxAudio.Transforms](NxAudio.Transforms.md): Defines a behaviour for audio transformations

- [NxAudio.IO.Encoding.Type.ALAW](NxAudio.IO.Encoding.Type.ALAW.md)
- [NxAudio.IO.Encoding.Type.AMR_NB](NxAudio.IO.Encoding.Type.AMR_NB.md)
- [NxAudio.IO.Encoding.Type.AMR_WB](NxAudio.IO.Encoding.Type.AMR_WB.md)
- [NxAudio.IO.Encoding.Type.FLAC](NxAudio.IO.Encoding.Type.FLAC.md)
- [NxAudio.IO.Encoding.Type.HTK](NxAudio.IO.Encoding.Type.HTK.md)
- [NxAudio.IO.Encoding.Type.MP3](NxAudio.IO.Encoding.Type.MP3.md)
- [NxAudio.IO.Encoding.Type.OPUS](NxAudio.IO.Encoding.Type.OPUS.md)
- [NxAudio.IO.Encoding.Type.PCM_F32](NxAudio.IO.Encoding.Type.PCM_F32.md)
- [NxAudio.IO.Encoding.Type.PCM_F64](NxAudio.IO.Encoding.Type.PCM_F64.md)
- [NxAudio.IO.Encoding.Type.PCM_S16](NxAudio.IO.Encoding.Type.PCM_S16.md)
- [NxAudio.IO.Encoding.Type.PCM_S24](NxAudio.IO.Encoding.Type.PCM_S24.md)
- [NxAudio.IO.Encoding.Type.PCM_S32](NxAudio.IO.Encoding.Type.PCM_S32.md)
- [NxAudio.IO.Encoding.Type.PCM_S8](NxAudio.IO.Encoding.Type.PCM_S8.md)
- [NxAudio.IO.Encoding.Type.PCM_U8](NxAudio.IO.Encoding.Type.PCM_U8.md)
- [NxAudio.IO.Encoding.Type.ULAW](NxAudio.IO.Encoding.Type.ULAW.md)
- [NxAudio.IO.Encoding.Type.UNKNOWN](NxAudio.IO.Encoding.Type.UNKNOWN.md)
- [NxAudio.IO.Encoding.Type.VORBIS](NxAudio.IO.Encoding.Type.VORBIS.md)

- Error Types
  - [NxAudio.Commons.Errors.Framework](NxAudio.Commons.Errors.Framework.md): Errors related to the NxAudio framework itself.

  - [NxAudio.Commons.Errors.IO](NxAudio.Commons.Errors.IO.md): Errors related to input/output operations.

  - [NxAudio.Commons.Errors.Invalid](NxAudio.Commons.Errors.Invalid.md): Errors related to invalid data or inputs.

  - [NxAudio.Commons.Errors.Unknown](NxAudio.Commons.Errors.Unknown.md): Errors that are unknown or unclassified

- Common Utilities
  - [NxAudio.Commons.Windows](NxAudio.Commons.Windows.md): NX Implementation of common window functions.

- IO
  - [NxAudio.IO](NxAudio.IO.md): Defines a behaviour for audio backend operations

  - [NxAudio.IO.AudioMetadata](NxAudio.IO.AudioMetadata.md): Represents the metadata of an audio file

  - [NxAudio.IO.BackendReadConfig](NxAudio.IO.BackendReadConfig.md): Defines how the backend should read the audio file.

  - [NxAudio.IO.BackendSaveConfig](NxAudio.IO.BackendSaveConfig.md): Defines how the backend should save the audio tensor.

  - [NxAudio.IO.Backends.FFmpeg](NxAudio.IO.Backends.FFmpeg.md): Implements a FFMPEG backend to deal with audio files.
This module requires FFMPEG to be installed on the system.

  - [NxAudio.IO.Backends.FFmpegReader](NxAudio.IO.Backends.FFmpegReader.md): Reading operations using the FFmpeg backend

  - [NxAudio.IO.Backends.FFmpegWriter](NxAudio.IO.Backends.FFmpegWriter.md): Writing operations using the FFmpeg backend

  - [NxAudio.IO.Errors.FailedToBufferFile](NxAudio.IO.Errors.FailedToBufferFile.md): Error when writing the tensor to a temporary file

  - [NxAudio.IO.Errors.FailedToExecuteBackend](NxAudio.IO.Errors.FailedToExecuteBackend.md): Error raised when an audio file cannot be parsed using a backend tooling.

  - [NxAudio.IO.Errors.InvalidBackendConfigurations](NxAudio.IO.Errors.InvalidBackendConfigurations.md): Error when a invalid configuration is provided to a backend tool.

  - [NxAudio.IO.Errors.InvalidMetadata](NxAudio.IO.Errors.InvalidMetadata.md): Error when an invalid metadata is returned by a backend tool.

- Transformations
  - [NxAudio.Transforms.AmplitudeToDb](NxAudio.Transforms.AmplitudeToDb.md): Represents the amplitude to decibel transformation for audio signals.

  - [NxAudio.Transforms.MelSpectrogram](NxAudio.Transforms.MelSpectrogram.md): Implements Mel-scaled spectrograms - a perceptually-motivated time-frequency representation of audio.
  - [NxAudio.Transforms.MelSpectrogramConfig](NxAudio.Transforms.MelSpectrogramConfig.md): Configuration options for mel spectrogram transformation.

  - [NxAudio.Transforms.MuLawDecoding](NxAudio.Transforms.MuLawDecoding.md): Implementation of μ-law decoding, which reverses μ-law encoding compression.
  - [NxAudio.Transforms.MuLawEncoding](NxAudio.Transforms.MuLawEncoding.md): Implementation of μ-law encoding, a form of audio signal compression.
  - [NxAudio.Transforms.Resample](NxAudio.Transforms.Resample.md): Provides high-quality audio resampling using sinc interpolation.
  - [NxAudio.Transforms.ResampleConfig](NxAudio.Transforms.ResampleConfig.md): Configuration options for audio resampling transformation.

  - [NxAudio.Transforms.Spectrogram](NxAudio.Transforms.Spectrogram.md): Spectrogram transformation for audio tensors.

  - [NxAudio.Transforms.SpectrogramConfig](NxAudio.Transforms.SpectrogramConfig.md): Configuration options for spectrogram transformation.

- Visualizations
  - [NxAudio.Transforms.Errors.InvalidTransformationConfiguration](NxAudio.Transforms.Errors.InvalidTransformationConfiguration.md): Error when a invalid configuration is provided to a transformation.

  - [NxAudio.Visualizations.Spectrogram](NxAudio.Visualizations.Spectrogram.md): Provides a binned heatmap visualization for Nx-based Spectrograms.
  - [NxAudio.Visualizations.SpectrogramConfig](NxAudio.Visualizations.SpectrogramConfig.md): Defines the configuration schema for the Spectrogram visualization.

  - [NxAudio.Visualizations.Wave](NxAudio.Visualizations.Wave.md): Provides a waveform visualization for Nx-based audio tensors.

  - [NxAudio.Visualizations.WaveConfig](NxAudio.Visualizations.WaveConfig.md): Defines the configuration schema for the Waveform visualization.

- Codecs
  - [NxAudio.IO.Encoding.Type](NxAudio.IO.Encoding.Type.md): Codec Names

- Exceptions
  - [NxAudio.Commons.Errors.Unknown.UnknownError](NxAudio.Commons.Errors.Unknown.UnknownError.md): Default unexpected error

  - [NxAudio.Visualizations.Errors.InvalidVisualizationConfig](NxAudio.Visualizations.Errors.InvalidVisualizationConfig.md): Error when a invalid configuration is provided to a visualization.

