aoxel-decoder
v1.0.1
Published
A Node.js package to decode Aoxel (AOX) files into WAV files.
Downloads
3
Maintainers
Readme
# aoxel-decoder
A Node.js package for decoding AOX files into WAV files.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Installation
You can install the package via npm:
```bash
npm install aoxel-decoder
Usage
To use the aoxel-decoder
package, you need to require it in your Node.js code:
const aoxDecoder = require('aoxel-decoder');
Decoding AOX Files
Use the decodeAOX
function to decode AOX files into WAV files. Provide the path to the AOX file and the output directory as arguments.
const aoxFilename = './input.aox'; // Replace with the path to your AOX file
const outputDir = './'; // Output directory for decoded WAV files
decodeAOX(aoxFilename, outputDir);
API Documentation
decodeAOX(aoxFile, outputDir)
aoxFile
(String): The path to the AOX file to be decoded.outputDir
(String): The directory where decoded WAV files will be saved.
Decodes the AOX file into WAV files in the specified output directory.
Contributing
Contributions are welcome! To contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure they are properly tested.
- Submit a pull request to the
main
branch of this repository.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contact
If you have any questions or need further assistance, feel free to contact the project author:
- Name: SREERAJ V RAJESH
- GitHub: GitHub Profile
- Email: [email protected]
Thank you for using aoxel-decoder
! We hope it's helpful in your project.