Package Exports
- webaudio-node
- webaudio-node/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (webaudio-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
API
Implements the Web Audio API specification with Node including playback.
Installation
npm install webaudio-nodeRequirements
- Node.js >= 20
- FFmpeg (https://ffmpeg.org/)
- SDL2 (https://www.libsdl.org/)
Example Usage
import { AudioContext } from 'webaudio-node';
import fs from 'fs/promises';
// Create audio context
const audioContext = new AudioContext();
async function run() {
const fileData = await fs.readFile('/path/to/audio/file.mp3');
// Decode the audio file
const audioBuffer = await audioContext.decodeAudioData(fileData);
// Create buffer source node
const source = audioContext.createBufferSource();
source.buffer = audioBuffer;
// Optional: Add event handler for when playback ends
source.onended = () => {
console.log('Playback finished');
process.exit(0);
};
source.connect(audioContext.destination);
source.start(0);
console.log('Duration:', source.buffer.duration, 'seconds');
}
run();
Currently Implemented Features
AudioContextAudioNodeAudioBufferAudioBufferSourceNodeGainNodeOscillatorNode
Planned Features
The following nodes are planned but not yet implemented:
AnalyserNodeBiquadFilterNodeDelayNodeDynamicsCompressorNodePannerNodeStereoPannerNode
Implementation Details
This module uses:
- SDL2 for audio output and device management
- FFmpeg for audio file decoding and encoding
Contributing
Contributions are welcome!
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
ISC
Issues and Support
Please report any issues or feature requests in the GitHub issue tracker.
Acknowledgments
- Web Audio API specification
- SDL2 development team
- FFmpeg development team