https://github.com/leaguetavern/node-windows-audio-visualisation
A library for visualizing audio data from Windows speaker devices in Node.js.
https://github.com/leaguetavern/node-windows-audio-visualisation
audio audio-visualisation speaker spectrum spectrum-analyzer windows
Last synced: 12 months ago
JSON representation
A library for visualizing audio data from Windows speaker devices in Node.js.
- Host: GitHub
- URL: https://github.com/leaguetavern/node-windows-audio-visualisation
- Owner: LeagueTavern
- License: mit
- Created: 2025-03-31T21:36:09.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-07T10:35:57.000Z (about 1 year ago)
- Last Synced: 2025-07-08T15:16:29.649Z (12 months ago)
- Topics: audio, audio-visualisation, speaker, spectrum, spectrum-analyzer, windows
- Language: Rust
- Homepage:
- Size: 1.68 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node-Windows-Audio-Visualisation
> This library allows developers to access audio visualisation data from the Windows using [Node.js](https://nodejs.org/), providing a simple API to access this data. It is written in [Rust](https://www.rust-lang.org/) and utilizes [napi-rs](https://napi.rs/) to implement bindings with Node.js.
English | [简体中文](./README_CN.md)
## ⚠️ Warning
`node-windows-audio-visualisation` only supports Windows.
## 🚀 Features
- Access to the Windows audio visualisation data.
- Support for both JavaScript and TypeScript.
- Easy to use and integrate into existing Node.js applications.
## Installation
```shell
npm i @coooookies/windows-audio-visualisation
```
## 🍊 Example
[CommonJS Example](example/index.js)
[ESModule Example](example/index.mjs)
[TypeScript Example](example/index.ts)
## Usage
#### Importing the library
```Typescript
// Typescript & ESModule
import { AudioMonitor, getDefaultOutputDevice, getAllOutputDevices } from '@coooookies/windows-audio-visualisation';
// CommonJS
const { AudioMonitor, getDefaultOutputDevice, getAllOutputDevices } = require('@coooookies/windows-audio-visualisation');
```
#### Gets all output devices
Gets all output devices on the system.
```Typescript
const devices = getAllOutputDevices(); // AudioDevice[]
// [
// {
// id: "{0.0.0.00000000}.{00000000-0000-0000-0000-000000000000}",
// name: "Speakers (Realtek High Definition Audio)",
// isDefault: true
// },
// {
// ...
// }
// ]
```
#### Gets the default output device
Gets the default output device on the system.
```Typescript
const device = getDefaultOutputDevice(); // AudioDevice | null
// {
// id: "{0.0.0.00000000}.{00000000-0000-0000-0000-000000000000}",
// name: "Speakers (Realtek High Definition Audio)",
// isDefault: true
// },
```
#### Gets the spectrum data
Get the spectrum data, the spectrum data is composed of an array, the length of the array is the number of spectra, and each element in the array represents the loudness of the spectrum unit, with a value range of 0 to 1.
```Typescript
const audio = new AudioMonitor()
audio.setDevice("{0.0.0.00000000}.{00000000-0000-0000-0000-000000000000}") // Set the device id
audio.start(2048) // start monitoring with 2048 chunk size
// audio.stop() // stop monitoring
const bands = 8 // Number of bands
const spectrum = audio.getSpectrum(bands)
// [0.521, 0.821, 0.123, 0.456, 0.789, 0.234, 0.567, 0.890, ...]
setInterval(() => {
console.log(audio.getSpectrum(bands))
}, 1e3 / 20)
// [0.521, 0.821, 0.123, 0.456, 0.789, 0.234, 0.567, 0.890, ...]
// [0.123, 0.456, 0.789, 0.234, 0.567, 0.890, 0.123, 0.456, ...]
// [0.789, 0.234, 0.567, 0.890, 0.123, 0.456, 0.789, 0.234, ...]
// ...
```
## License
This project is licensed under the [MIT](LICENSE) License.
- [@RustAudio/cpal (Apache-2.0 license)](https://github.com/RustAudio/cpal)
- [@Ricky12Awesome/safav (Apache-2.0 license)](https://github.com/Ricky12Awesome/safav)
- [@HEnquist/wasapi-rs (MIT license)](https://github.com/HEnquist/wasapi-rs)