https://github.com/audiojs/audio-buffer

AudioBuffer class for node/browser
https://github.com/audiojs/audio-buffer

Last synced: 8 months ago
JSON representation

AudioBuffer class for node/browser

• Host: GitHub
• URL: https://github.com/audiojs/audio-buffer
• Owner: audiojs
• License: mit
• Created: 2015-12-18T01:52:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2025-01-19T17:05:07.000Z (over 1 year ago)
• Last Synced: 2025-09-20T14:23:12.969Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 109 KB
• Stars: 80
• Watchers: 15
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# audio-buffer [![test](https://github.com/audiojs/audio-buffer/actions/workflows/node.js.yml/badge.svg)](https://github.com/audiojs/audio-buffer/actions/workflows/node.js.yml) [![stable](https://img.shields.io/badge/stability-stable-brightgreen.svg)](http://github.com/badges/stability-badges)

_AudioBuffer_ - basic audio data container class with planar float32 data layout.

Useful instead of _Buffer_ in audio streams, audio components, workers, nodejs, environments without web-audio-api. Enables various audio-buffer utils outside of audio contexts or browsers.

Implementation is compatible with [Web Audio API AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer), can be used as ponyfill.

## Usage

[![npm install audio-buffer](https://nodei.co/npm/audio-buffer.png?mini=true)](https://npmjs.org/package/audio-buffer/)

### new AudioBuffer(options)

Create audio buffer from `options`.

* `options.length` — number of samples, minimum is 1.

* `options.sampleRate` — sample rate from 3000..768000 range.

* `options.numberOfChannels` (optional) — default number of channels is 1.

### buffer.duration

Duration of the underlying audio data, in seconds.

### buffer.length

Number of samples per channel.

### buffer.sampleRate

Default sample rate is 44100.

### buffer.numberOfChannels

Default number of channels is 1.

### buffer.getChannelData(channel)

Get array containing the data for the channel (not copied).

### buffer.copyFromChannel(destination, channelNumber, startInChannel=0)

Place data from channel to destination Float32Array.

### buffer.copyToChannel(source, channelNumber, startInChannel=0)

Place data from source Float32Array to the channel.

## Similar

* [ndsamples](https://github.com/livejs/ndsamples) — audio-wrapper for ndarrays. A somewhat alternative approach to wrap audio data, based on ndarrays, used by some modules in [livejs](https://github.com/livejs).

* [1](https://www.npmjs.com/package/audiobuffer), [2](https://www.npmjs.com/package/audio-buffer), [3](https://github.com/sebpiq/node-web-audio-api/blob/master/lib/AudioBuffer.js), [4](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer) — other AudioBuffer implementations.

* [audiodata](https://www.npmjs.com/package/audiodata) alternative data holder from @mohayonao.

🕉