aframe-audioanalyser-component

aframe-audioanalyser-component

Audio visualizations for A-Frame using Web Audio (AnalyserNode).

!analyser

These components mostly provide processed Web Audio data (beat detection,
levels, volume, waveform). How that is visualized is up to you (by writing
components that use this data to have a visual effect). Components will generally
implement the tick handler and read the analyser data. See the examples for
some example visualization components.

Not tested on mobile.

$3

| Property | Description | Default Value |
| -------- | ----------- | ------------- |
| beatDetectionDecay | How fast to decay the beat threshold. | 0.99 |
| beatDetectionMinVolume | Minimum volume for beat. | 15 |
| beatDetectionThrottle | Minimum time to to wait between beats. | 250 |
| cache | Whether or not to cache audio buffers. | false |
| enableBeatDetection | Whether or not to detect beats. Disable if not using. | true |
| enableLevels | Whether or not to store frequency data. Disable if not using. | true |
| enableVolume | Whether or not to calculate average volume. Disable if not using. | true |
| enableWaveform | Whether or not to store waveform data. Disable if not using. | true |
| fftSize | Frequency domain. | 2048 |
| smoothingTimeConstant | How smooth the frequency data is returned. | 0.8 |
| src | Selector to an audio element or path to audio file. | '' |
| unique | Whether to share the audio instance with other visualizing entities. | false |

$3

| Member | Description | Type |
| -------- | ----------- | ------------- |
| analyser | Web Audio AnalyserNode | AnalyserNode |
| volume | Whether or not to store frequency data. Disable if not using. | number |
| waveform | Whether or not to calculate average volume. Disable if not using. | Uint8Array |
| levels | Whether or not to store waveform data. Disable if not using. | Uint8Array |

To access the analyser node:

``
el.components.audioanalyser.analyser;
`

$3

| Event Name | Description |
| -------- | ----------- |
| audioanalyserbeat | Beat detected with beat detection. |
| audioanalyserready | AnalyserNode initialized. |

$3

#### Browser Installation

Install and use by directly including the browser files:

`html











audioanalyser="src: #song"
component-that-does-stuff-with-audio-analyser-data
>


`

#### NPM Installation

Install via NPM:

`bash
npm install aframe-audioanalyser-component
`

Then register and use.

`js
require('aframe');
require('aframe-audioanalyser-component');
``