aframe-audio-analyser
v1.0.0
Published
An aframe component for adding audio visualizations.
Downloads
44
Readme
aframe-audio-analyser
An aframe component for adding audio visualizations, using Web Audio. This is an updated version of aframe-audioanalyser-component, with various improvements.
Check out the live demo.
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.
Properties
| Property | Description | Default Value | | --------------------- | -------------------------------------------------------------------- | ------------- | | src | Selector to an audio element or path to audio file. | '' | | | | | | beatStartCutoff | Parameter for beat detection | 0.8 | | beatEndCutoff | Parameter for beat detection | 0.75 | | 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 | | unique | Whether to share the audio instance with other visualizing entities. | false |
Members
| 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;Events
| Event Name | Description | | ----------------------- | ------------------------- | | audioanalyser-beat-low | Low beat detected. | | audioanalyser-beat-mid | Midrange beat detected. | | audioanalyser-beat-high | High beat detected. | | audioanalyserready | AnalyserNode initialized. |
Usage
<head>
<script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/aframe-audio-analyser.umd.js"></script>
</head>
<body>
<a-scene>
<a-assets>
<audio id="song" src="mysong.mp3" autoplay loop></audio>
</a-assets>
<a-entity audioanalyser="src: #song;" component-that-does-stuff-with-audioanalyser-data></a-entity>
</a-scene>
</body>